Java模板引擎 FreeMarker

@(编程)

1. 简介
2. FreeMarker特性
3. 优势与不足
- 3.1. 优势
- 3.2. 不足
4. 代码示例

1. 简介

FreeMarker是一个模板引擎，一个基于模板生成文本输出的通用工具，使用纯Java编写。它是为Java程序员提供的一个开发包。它不是面向最终用户的，而是为程序员提供的一款可以嵌入他们所开发产品的应用程序。

FreeMarker被设计用来生成HTML Web页面，特别是基于MVC模式的应用程序。

虽然FreeMarker具有一些编程的能力，但通常由Java程序准备要显示的数据，由FreeMarker生成页面，通过模板显示准备的数据。

FreeMarker不是一个Web应用框架，而适合作为Web应用框架一个组件

FreeMarker与容器无关，因为它并不知道HTTP或Servlet；FreeMarker同样可以应用于非Web应用程序环境。

FreeMarker更适合作为Model2框架（如Struts）的视图组件，你也可以在模板中使用JSP标记库

FreeMarker是免费的

而且你还可以通过Eclipse的插件来编辑FreeMarker，经过验证，FreeMarker 最好的 Eclipse 编辑插件是 JBoss Tools。

2. FreeMarker特性

2.1. 通用目标

能够生成各种文本：HTML、XML、RTF、Java源代码等等

易于嵌入到你的产品中：轻量级；不需要Servlet环境

插件式模板载入器：可以从任何源载入模板，如本地文件、数据库等等

你可以按你所需生成文本：保存到本地文件；作为Email发送；从Web应用程序发送它返回给Web浏览器

2.2. 强大的模板语言

所有常用的指令：include、if/elseif/else、循环结构

在模板中创建和改变变量

几乎在任何地方都可以使用复杂表达式来指定值

命名的宏，可以具有位置参数和嵌套内容

名字空间有助于建立和维护可重用的宏库，或者将一个大工程分成模块，而不必担心名字冲突

输出转换块：在嵌套模板片段生成输出时，转换HTML转义、压缩、语法高亮等等；你可以定义自己的转换

2.3. 通用数据模型

FreeMarker不是直接反射到Java对象，Java对象通过插件式对象封装，以变量方式在模板中显示

你可以使用抽象（接口）方式表示对象（JavaBean、XML文档、SQL查询结果集等等），告诉模板开发者使用方法，使其不受技术细节的打扰

2.4. 为Web准备

在模板语言中内建处理典型Web相关任务（如HTML转义）的结构

能够集成到Model2 Web应用框架中作为JSP的替代

支持JSP标记库

为MVC模式设计：分离可视化设计和应用程序逻辑；分离页面设计员和程序员

2.5. 智能的国际化和本地化

字符集智能化（内部使用UNICODE）

数字格式本地化敏感

日期和时间格式本地化敏感

非US字符集可以用作标识（如变量名）

多种不同语言的相同模板

2.6. 强大的XML处理能力

<#recurse> 和<#visit>指令（2.3版本）用于递归遍历XML树

在模板中清楚和直觉的访问XML对象模型

开源论坛 JForum 就是使用了 FreeMarker 做为页面模板。

3. 优势与不足

3.1. 优势

可以彻底的分离表现层和业务逻辑

使用JSP开发过程中，在页面中大量的存在业务逻辑代码，使得页面的内容非常混乱，在后期大量的修改维护过程中就变得非常的困难。

FreeMarker不支持Java脚本代码，FreeMarker的原理是，模板+数据模型=输出。模板只负责数据在页面中的表现，不涉及任何的逻辑代码，而所有的逻辑都是由数据模型来处理的。用户最终看到的输出是模板和数据模型合并后创建的。

可以提高开发效率

在以往的开发中，使用的都是JSP页面来展示数据的，即所谓的表现层。我们都知道，JSP在第一次执行的时候需要转换成Servlet类，开发阶段进行功能调试时，需要频繁的修改JSP，每次修改都要编译和转换，那么试想一下，一天中我们浪费在程序编译的时间有多少。

相对于JSP来说，FreeMarker模板技术不存在编译和转换的问题，所以就不会存在上述问题。而且开发过程中，我们再不必等待界面设计开发人员完成页面原型后，我们再来开发程序。

而且，一些特定的系统，比如OA工作流系统中，就需要动态生成表单技术，这就为其提供了很好的实现依据。使得在整个流程的进行中，生成不同的表单就简单了很多。

使得开发过程中的人员分工更加明确

以往用JSP显示数据时，一些程序员并不熟悉界面设计技术，反之界面开发人员，也并不熟悉程序语言。对两者而言，交替性的工作本身就有难度。有时候稍有不慎，可能会将整个页面元素删除或去掉了某个程序符号，使得页面走样或程序错误，这样就需要双方相互沟通协作，解决出现的问题。有时候因为项目中的时间、任务量等因素的存在，可能这个工作就由一个人来完成，这样就可能加大某一方开发人员的工作量。

使用FreeMarker后，作为界面开发人员，只专心创建HTML文件、图像以及Web页面的其他可视化方面，不用理会数据；而程序开发人员则专注于系统实现，负责为页面准备要显示的数据。

3.2. 不足

在修改模板后，可能会看到已经过期的数据

使用FreeMarker模板技术，生成静态的HTML页面后，如果一旦模板改变，而没有及时更新模板生成的HTML页面的话，用户看到的就是过期的数据。

FreeMarker的变量必须有值

FreeMarker模板技术在应用过程中，FreeMarker中的变量必须要赋值，如果不赋值，那么就会抛出异常。FreeMarker没有一个默认的null处理，甚至也不接受一个null值。想避免错误就要应用if/elseif/else 指令进行判段，如果对每一个变量都判断的话，那么则反而增加了编程的麻烦。

FreeMarker的Map限定Key必须是String，其他数据类型无法操作

Map问题，即FreeMarker中不能支持非String的Key值，这样在进行一些复杂迭代时就需要作一些其他的转换，如将一个Map拆分为两个或多个Map。

FreeMarker不支持集群应用

为了编成的方便性，把序列化的东西都放到了Session中，如Session，request等，在开发的过程中确实方便，但如果将应用放到集群中，就会出现错误。

4. 代码示例

4.1. java代码

package com.demo.index;

import java.io.BufferedWriter;

import java.io.File;

import java.io.FileWriter;

import java.io.IOException;

import java.io.PrintWriter;

import java.util.HashMap;

import java.util.Map;

import freemarker.template.Configuration;

import freemarker.template.DefaultObjectWrapper;

import freemarker.template.Template;

import freemarker.template.TemplateException;

import freemarker.template.TemplateExceptionHandler;

public class TestFreeMarker {

	public static void main(String[] args) {

		String dir = "D:/Downloads/jfinal-2.2_demo/jfinal_demo/res";

		Configuration cfg = new Configuration();

		try {

			cfg.setDirectoryForTemplateLoading(new File(dir));

			cfg.setObjectWrapper(new DefaultObjectWrapper());

			cfg.setTemplateExceptionHandler(TemplateExceptionHandler.IGNORE_HANDLER);

			Map root = new HashMap();

			root.put("name", "hello,keke");

			Template template = cfg.getTemplate("test.ftl");

			PrintWriter out = new PrintWriter(new BufferedWriter(new FileWriter(dir + "/out.txt")));

			try {

				template.process(root, out);

			} catch (TemplateException e) {

				e.printStackTrace();

			}

		} catch (IOException e) {

			e.printStackTrace();

		}

	}

}

4.2. 模板代码

<span style="font-family:Microsoft YaHei;">我的测试程序：${name}</span>

4.3. 输出

<span style="font-family:Microsoft YaHei;">我的测试程序：hello,keke</span>