Apache FreeMarker™ 技术文档
2024-12-23 19:43:22作者：苗圣禹Peter
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™ 项目。
登录后查看全文
相关内容推荐
热门项目推荐
- QQwen3-Next-80B-A3B-InstructQwen3-Next-80B-A3B-Instruct 是一款支持超长上下文（最高 256K tokens）、具备高效推理与卓越性能的指令微调大模型00
- QQwen3-Next-80B-A3B-ThinkingQwen3-Next-80B-A3B-Thinking 在复杂推理和强化学习任务中超越 30B–32B 同类模型，并在多项基准测试中优于 Gemini-2.5-Flash-Thinking00
GitCode-文心大模型-智源研究院AI应用开发大赛GitCode&文心大模型&智源研究院强强联合，发起的AI应用开发大赛；总奖池8W，单人最高可得价值3W奖励。快来参加吧～0230
PublicCMS266万多行代码修改 持续迭代9年 现代化java cms完整开源，轻松支撑千万数据、千万PV；支持静态化，服务器端包含，多级缓存，全文搜索复杂搜索，后台支持手机操作; 目前已经拥有全球0.0005%(w3techs提供的数据)的用户，语言支持中、繁、日、英；是一个已走向海外的成熟CMS产品Java00
AI内容魔方AI内容专区，汇集全球AI开源项目，集结模块、可组合的内容，致力于分享、交流。01- HHunyuan-MT-7B腾讯混元翻译模型主要支持33种语言间的互译，包括中国五种少数民族语言。00
GOT-OCR-2.0-hf阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型，支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容，输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入，具备多页批量处理、动态分块识别和交互式区域选择等创新功能，用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源，提供Hugging Face演示和完整代码，适用于学术研究到工业应用的广泛场景，为OCR领域带来突破性解决方案。00- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile06
- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
- Dd2l-zh《动手学深度学习》：面向中文读者、能运行、可讨论。中英文版被70多个国家的500多所大学用于教学。Python011
热门内容推荐
最新内容推荐
项目优选
收起
kerneldeepin linux kernel
C
22
6
docsOpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
132
1.89 K
nop-entropyNop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台，包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分，采用java语言实现，可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeReact Native鸿蒙化仓库
C++
193
273
金融AI编程实战为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制，新手友好，让学生以亲身实践开源开发的方式，学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线，涉及 Bash、Python、SQL、BI、AI 等全技术栈，培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
70
63
openHiTLS旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件，通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求，让密码技术应用更简单，同时探索后量子等先进算法创新实践，构建密码前沿技术底座！
C
379
389
Cangjie-Examples本仓将收集和展示高质量的仓颉示例代码，欢迎大家投稿，让全世界看到您的妙趣设计，也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.24 K
RuoYi-Vue3🎉 (RuoYi)官方仓库 基于SpringBoot，Spring Security，JWT，Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
915
548
openGauss-serveropenGauss kernel ~ openGauss is an open source relational database management system
C++
144
189
ShopXO开源商城🔥🔥🔥ShopXO企业级免费开源商城系统，可视化DIY拖拽装修、包含PC、H5、多端小程序(微信+支付宝+百度+头条&抖音+QQ+快手)、APP、多仓库、多商户、多门店、IM客服、进销存，遵循MIT开源协议发布、基于ThinkPHP8框架研发
JavaScript
96
15