Apache FreeMarker™ 技术文档
1. 安装指南
使用 Maven 安装
如果你使用 Maven 进行项目管理，只需在 pom.xml 文件中添加以下依赖：
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker-gae</artifactId>
<version>{version}</version>
</dependency>
注意：确保没有其他依赖项引入旧版本的 freemarker（groupId 为 freemarker 而不是 org.freemarker），否则可能会导致运行时行为不可预测。
手动安装
如果不使用 Maven，可以直接将 freemarker.jar 文件复制到你的 Java 应用程序的 ClassLoader 可以找到的位置。例如，如果你在 Web 应用程序中使用 FreeMarker，可以将 freemarker.jar 放入 WEB-INF/lib 目录。
FreeMarker 没有强制依赖项，但有一些可选依赖项。通常情况下，你不需要处理这些依赖项，除非你使用了某些需要特定库的特性。
升级到 OpenJDK 9 或更高版本
如果你升级到 OpenJDK 9 或更高版本，并且你在模板中使用 XPath 查询，你需要添加 Apache Xalan 作为依赖项，因为 freemarker.ext.dom 无法再使用 OpenJDK 内置的 XPath 支持。
2. 项目的使用说明
什么是 Apache FreeMarker™？
Apache FreeMarker™ 是一个“模板引擎”，它是一个通用的工具，用于基于模板生成文本输出（从 HTML 到自动生成的源代码）。它是一个 Java 包，供 Java 程序员使用的类库。它本身并不是一个面向最终用户的应用程序，而是程序员可以嵌入到其产品中的工具。FreeMarker 的设计目的是为基于 MVC（模型视图控制器）模式的 servlet 应用程序生成 HTML Web 页面。
使用场景
FreeMarker 通常用于以下场景：
- 生成动态 HTML 页面。
- 生成电子邮件模板。
- 生成源代码、配置文件等。
3. 项目 API 使用文档
基本用法
FreeMarker 的核心 API 主要包括 Configuration 和 Template 类。以下是一个简单的示例，展示如何使用 FreeMarker 生成 HTML 输出：
import freemarker.template.Configuration;
import freemarker.template.Template;
import freemarker.template.TemplateExceptionHandler;
import java.io.File;
import java.io.OutputStreamWriter;
import java.io.Writer;
import java.util.HashMap;
import java.util.Map;
public class FreeMarkerExample {
public static void main(String[] args) throws Exception {
// 创建配置实例
Configuration cfg = new Configuration(Configuration.VERSION_2_3_31);
// 指定模板文件的位置
cfg.setDirectoryForTemplateLoading(new File("templates/"));
// 设置异常处理方式
cfg.setTemplateExceptionHandler(TemplateExceptionHandler.RETHROW_HANDLER);
// 获取模板
Template temp = cfg.getTemplate("example.ftl");
// 创建数据模型
Map<String, Object> root = new HashMap<>();
root.put("message", "Hello, FreeMarker!");
// 合并模板和数据模型
Writer out = new OutputStreamWriter(System.out);
temp.process(root, out);
}
}
模板示例
以下是一个简单的 FreeMarker 模板文件 example.ftl：
<!DOCTYPE html>
<html>
<head>
<title>FreeMarker Example</title>
</head>
<body>
<h1>${message}</h1>
</body>
</html>
常用 API
Configuration：用于配置 FreeMarker 的全局设置。Template：表示一个模板文件。TemplateExceptionHandler：用于处理模板解析和执行过程中的异常。
4. 项目安装方式
通过 Maven 安装
如前所述，通过在 pom.xml 中添加依赖项来安装 FreeMarker。
手动安装
将 freemarker.jar 文件复制到你的项目中，并确保它位于 ClassLoader 可以找到的路径中。
构建 FreeMarker
如果你需要从源码构建 FreeMarker，可以按照以下步骤进行：
- 下载源码发布包或从源码仓库中检出 FreeMarker。
- 确保你安装了 JDK 8、JDK 16 和 JDK 17（仅用于某些测试）。
- 在项目根目录下运行
./gradlew jar（Windows 上运行gradlew.bat jar）来构建freemarker.jar。
IDE 设置
IntelliJ IDEA
- 打开项目：选择
settings.gradle.kts文件。 - 配置 Gradle：确保 Gradle JVM 设置为 JDK 17 或更高版本。
- 导入代码风格和检查配置。
Eclipse
- 将项目作为 Gradle 项目导入。
- 配置 Java 编译器和代码格式化器。
通过以上步骤，你可以顺利安装、使用和构建 Apache FreeMarker™ 项目。
相关内容推荐
GLM-5智谱 AI 正式发布 GLM-5，旨在应对复杂系统工程和长时域智能体任务。Jinja00
GLM-5-w4a8GLM-5-w4a8基于混合专家架构，专为复杂系统工程与长周期智能体任务设计。支持单/多节点部署，适配Atlas 800T A3，采用w4a8量化技术，结合vLLM推理优化，高效平衡性能与精度，助力智能应用开发Jinja00
请把这个活动推给顶尖程序员😎本次活动专为懂行的顶尖程序员量身打造，聚焦AtomGit首发开源模型的实际应用与深度测评，拒绝大众化浅层体验，邀请具备扎实技术功底、开源经验或模型测评能力的顶尖开发者，深度参与模型体验、性能测评，通过发布技术帖子、提交测评报告、上传实践项目成果等形式，挖掘模型核心价值，共建AtomGit开源模型生态，彰显顶尖程序员的技术洞察力与实践能力。00
Kimi-K2.5Kimi K2.5 是一款开源的原生多模态智能体模型，它在 Kimi-K2-Base 的基础上，通过对约 15 万亿混合视觉和文本 tokens 进行持续预训练构建而成。该模型将视觉与语言理解、高级智能体能力、即时模式与思考模式，以及对话式与智能体范式无缝融合。Python00
MiniMax-M2.5MiniMax-M2.5开源模型，经数十万复杂环境强化训练，在代码生成、工具调用、办公自动化等经济价值任务中表现卓越。SWE-Bench Verified得分80.2%，Multi-SWE-Bench达51.3%，BrowseComp获76.3%。推理速度比M2.1快37%，与Claude Opus 4.6相当，每小时仅需0.3-1美元，成本仅为同类模型1/10-1/20，为智能应用开发提供高效经济选择。【此简介由AI生成】Python00
Qwen3.5Qwen3.5 昇腾 vLLM 部署教程。Qwen3.5 是 Qwen 系列最新的旗舰多模态模型，采用 MoE（混合专家）架构，在保持强大模型能力的同时显著降低了推理成本。00- RRing-2.5-1TRing-2.5-1T：全球首个基于混合线性注意力架构的开源万亿参数思考模型。Python00
热门内容推荐
最新内容推荐
项目优选
kernel
docs
pytorch
ops-math
flutter_flutter
kernelMindSpeed-LLM
nop-entropy
leetcode
RuoYi-Vue3