freemarker--模板引擎

Posted 2020-10-10

概念

 

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

 

 

介绍

 

那么，FreeMarker是一款怎样的工具呢？FreeMarker实际上是被设计用来生成html Web页面，尤其是通过实现了基于MVC模式的Java Servlet应用程序。使用MVC模式的动态页面的设计构思使得你可以将前端设计师从程序员中分离出来。所有人各司其职，发挥其最擅长的一面。

 

网页设计师可以改写页面的显示效果而不受程序员编译代码的影响，因为应该程序的逻辑和页面设计已经被分开了。页面模板代码不会收到复杂程序代码的影响。这种分离的思想即便对一个程序员和页面设计师是同一个人的项目来说也都是非常有用的，因为分离使得代码保持简洁而且易于维护。

 

尽管FreeMarker也拥有一些编程能力，但通常由Java程序准备要显示的数据，由FreeMarker生成页面，通过模板显示准备的数据（如下图）。

 

FreeMarker不是一个Web应用框架，而适合作为Web应用框架的一个组件，但是FreeMarker引擎本身并不知道HTTP协议或Java Servlet的存在。它仅仅来生成文本内容。既然是这样，它也非常适用于非Web应用程序的开发环境。知识要注意的是，我们使用FreeMarker作为视图层的组件，是为了给诸如Struts这样的Model2应用框架提供现成的解决方案，你也可以在模板中使用JSP标记库。

 

 

特性

• 通用目标

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

 

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

 

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

 

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

 

• 强大的模板语言

在模板中创建和改变变量

 

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

 

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

 

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

 

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

 

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

 

• 通用数据模型

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

 

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

 

• 为Web准备

支持JSP标记库

 

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

 

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

 

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

 

• 智能的国际化和本地化

数字格式本地化敏感

 

多种不同语言的相同模板

 

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

 

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

 

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

 

• 强大的XML处理能力

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

 

<#recurse>和<#visit>指令用于递归遍历XML树

 

 

优势

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

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

 

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

 

• 可以提高开发效率

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

 

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

 

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

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

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

 

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

 

 

不足

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

使用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等，在开发的过程中确实方便，但如果将应用放到集群中，就会出现错误。 

 

 

一个小Demo

 

首先，需要下载FreeMarker的jar包，这里提供一个下载链接：freemarker.jar

 

然后，将这个freemarker.jar放到Web项目的 WebRoot\WEB-INF\lib 目录下

 

最后，我把自己写的测试类贴出来，分享一下。

FreemarkerTest类 代码

<span style="font-family:Microsoft YaHei;">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;
import junit.framework.TestCase;

public class FreemarkerTest extends TestCase {

    private String dir = "E:/.../OA/TestTotal/src/com/bjsxt/oa/freemarker";

    public void testFreemarker() {
        Configuration cfg = new Configuration();

        try {
            // 从哪里加载模板文件
            cfg.setDirectoryForTemplateLoading(new File(dir));
            
            // 定义模版的位置，从类路径中，相对于FreemarkerManager所在的路径加载模版
            // cfg.setTemplateLoader(new ClassTemplateLoader(FreemarkerManager.class, "templates"))

            // 设置对象包装器
            cfg.setObjectWrapper(new DefaultObjectWrapper());

            // 设置异常处理器
            cfg
                    .setTemplateExceptionHandler(TemplateExceptionHandler.IGNORE_HANDLER);

            // 定义数据模型
            Map root = new HashMap();
            root.put("abc", "世界，你好");

            // 通过freemarker解释模板，首先需要获得Template对象
            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();
        }
    }
}
</span>

下面是定义的模板 test.ftl

 

test.flt 代码

<span style="font-family:Microsoft YaHei;">第一个测试程序：${abc}</span>

最后运行的结果如下

 

输出了out.txt文件，out.txt文件中的内容如下：

<span style="font-family:Microsoft YaHei;">第一个测试程序：世界，你好</span>