Apache FreeMarker Online Tester 使用教程
1. 项目的目录结构及介绍
Apache FreeMarker Online Tester 是一个用于快速测试 FreeMarker 模板片段的在线工具。以下是该项目的目录结构及其介绍:
freemarker-online-tester/
├── gradle/
│ └── wrapper/
├── src/
│ ├── main/
│ │ ├── java/
│ │ └── resources/
│ └── test/
│ ├── java/
│ └── resources/
├── .gitignore
├── .travis.yml
├── DISCLAIMER
├── LICENSE
├── NOTICE
├── README.md
├── build.gradle
├── dependencies.gradle
├── gradlew
├── gradlew.bat
├── intellij-gradle
├── rat-excludes
└── settings.gradle
目录结构说明:
gradle/wrapper/
: 包含 Gradle Wrapper 的相关文件,用于确保项目使用特定版本的 Gradle。src/
: 项目的源代码目录。main/
: 主代码目录。java/
: Java 源代码文件。resources/
: 资源文件,如配置文件等。
test/
: 测试代码目录。java/
: 测试 Java 源代码文件。resources/
: 测试资源文件。
.gitignore
: Git 忽略文件配置。.travis.yml
: Travis CI 配置文件。DISCLAIMER
: 免责声明。LICENSE
: 项目许可证文件。NOTICE
: 项目通知文件。README.md
: 项目说明文档。build.gradle
: Gradle 构建脚本。dependencies.gradle
: 依赖管理脚本。gradlew
: Gradle 包装器脚本(Unix)。gradlew.bat
: Gradle 包装器脚本(Windows)。intellij-gradle
: IntelliJ IDEA 配置文件。rat-excludes
: Apache RAT 排除文件配置。settings.gradle
: Gradle 项目设置脚本。
2. 项目的启动文件介绍
项目的启动文件主要用于启动 FreeMarker Online Tester 服务。以下是启动文件的介绍:
命令行启动
- 构建项目:
./gradlew build
- 生成可执行 JAR 文件:
./gradlew shadowJar
- 启动服务:
java -jar build/libs/freemarker-online-<VERSION>.jar server src/main/resources/freemarker-online.yml
IDE 启动
- 生成 IDEA 项目文件:
./gradlew cleanIdea idea
- 在 IDE 中运行
org.apache.freemarker.onlinetester.dropwizard.FreeMarkerOnlineTester
类,并传入启动参数:server src/main/resources/freemarker-online.yml
3. 项目的配置文件介绍
项目的配置文件主要用于配置 FreeMarker Online Tester 服务的运行参数。以下是配置文件的介绍:
freemarker-online.yml
该文件位于 src/main/resources/
目录下,包含服务的配置信息,如端口、日志级别等。
server:
applicationConnectors:
- type: http
port: 8080
adminConnectors:
- type: http
port: 8081
logging:
level: INFO
loggers:
org.apache.freemarker.onlinetester: DEBUG
配置文件说明:
server
: 配置服务器的连接器。applicationConnectors
: 应用连接器,配置 HTTP 端口。adminConnectors
: 管理连接器,配置管理端口。
logging
: 配置日志级别和日志记录器。level
: 全局日志级别。loggers
: 特定包的日志级别配置。
通过以上配置文件,可以灵活地调整服务的运行参数,以满足不同的部署需求。