Sitebricks 技术文档

2024-12-24 07:03:51作者：晏闻田Solitary

1. 安装指南

环境要求

Java 11 或更高版本
Maven 或 Gradle 构建工具

安装步骤

添加依赖：在项目的 pom.xml 或 build.gradle 文件中添加 Sitebricks 的依赖。

Maven：

<dependency>
    <groupId>com.google.sitebricks</groupId>
    <artifactId>sitebricks</artifactId>
    <version>1.0.0</version>
</dependency>

Gradle：

implementation 'com.google.sitebricks:sitebricks:1.0.0'

构建项目：使用 Maven 或 Gradle 构建项目，确保依赖项正确下载并集成到项目中。
配置 Guice：Sitebricks 依赖 Guice 进行依赖注入，确保在项目中正确配置 Guice。

2. 项目的使用说明

创建一个简单的 Web 应用

定义页面模板：在 src/main/resources/templates 目录下创建一个 HTML 模板文件，例如 index.html。
```
<html>
<body>
    <h1>Hello, ${name}!</h1>
</body>
</html>
```

编写控制器：创建一个 Java 类作为控制器，处理请求并返回模板。

import com.google.sitebricks.At;
import com.google.sitebricks.Show;

@At("/")
public class HelloWorld {
    private String name = "World";

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}

配置路由：在 WebModule 中配置路由，将请求映射到控制器。

import com.google.inject.servlet.ServletModule;
import com.google.sitebricks.SitebricksModule;

public class WebModule extends ServletModule {
    @Override
    protected void configureServlets() {
        install(new SitebricksModule() {
            @Override
            protected void configureSitebricks() {
                at("/").serve(HelloWorld.class);
            }
        });
    }
}

启动应用：使用嵌入式服务器（如 Jetty）启动应用，访问 http://localhost:8080/ 查看效果。

3. 项目 API 使用文档

模板语法

Sitebricks 使用简洁的模板语法，支持在 HTML 中嵌入 Java 表达式。

变量输出：
```
<h1>Hello, ${name}!</h1>
```

条件判断：

#if (user.isAdmin())
    <p>Welcome, Admin!</p>
#end

循环：

<ul>
#foreach (item in items)
    <li>${item.name}</li>
#end
</ul>

控制器 API

控制器类通过注解定义路由和行为。

@At：定义路由路径。

@At("/hello")
public class HelloWorld {
    // ...
}

@Show：指定返回的视图模板。

@Show("index.html")
public class HelloWorld {
    // ...
}

@Post：处理 POST 请求。

@Post
public void doPost(String name) {
    // ...
}

4. 项目安装方式

使用 Maven 或 Gradle 安装

如前所述，通过在 pom.xml 或 build.gradle 中添加依赖来安装 Sitebricks。

手动安装

下载源码：从 GitHub 仓库下载 Sitebricks 的源码。
编译和打包：使用 Maven 或 Gradle 编译源码并生成 JAR 文件。
集成到项目：将生成的 JAR 文件添加到项目的 lib 目录中，并在构建工具中配置依赖。

通过以上步骤，您可以顺利安装并使用 Sitebricks 进行 Web 应用开发。

登录后查看全文