FreeMarker

FreeMarker

1 主要内容

---

2 FreeMarker概述

2.1 FreeMarker概念

​ FreeMarker 是一款模板引擎：即一种基于模板和要改变的数据，并用来生成输出文本的（HTML网页，电子邮件，配置文件，源代码等）的通用工具，是一个Java类库。

​ FreeMarker 被设计用来生成 HTML Web 页面，特别是基于MVC模式的应用程序，将视图从业务逻辑中抽离处理，业务中不再包含视图的展示，而是将视图交给 FreeMarker 来输出，虽然 FreeMarker 具有一些编程的能力，但通常由 Java 程序准备要展示的数据，由 FreeMarker 生成页面，通过模板显示准备的数据（如下图）：

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-5LsFNGJ3-1612345259904)(…/MarkDownImages/overview.png)]

​ FreeMarker 不是一个Web应用框架，而是作为Web应用框架的一个组件。

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

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

2.2 FreeMarker特性

2.2.1 通用目标

1. 能够生成各种文本：HTML、XML、RTF、Java源代码等等。
2. 易于切入到你的产品中：轻量级；不需要Servlet环境。
3. 插件式模板载入器：可以从任何源载入模板，如：本地文件、数据库等等。
4. 你可以按你所需生成文件：保存到本地文件；作为 Email 发送；从 Web 应用程序发送它返回给 Web 浏览器。

2.2.2 强大的模板语言

1. 所有常用的指令：include、if/elseif/else、循环结构；
2. 在模板中创建和改变变量；
3. 几乎在任何地方都可以使用复杂表达式来指定值；
4. 命名的宏，可以具有位置参数和嵌套内容；
5. 名字空间有助于建立和维护可重用的宏库，或将大工程分成模块，而不必担心名字冲突；
6. 输出转换块：在嵌套模板片段生成输出时，转换HTML转义、压缩、语法高亮等等；你可以定义自己的转换。

2.2.3 通用数据模型

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

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

2.2.4 为Web准备

1. 在模板语言中内建处理典型web相关任务（如：TML转义）的结构；
2. 能够集成到 Model2 Web 应用框架中作为JSP的替代；
3. 支持JSP标记库；
4. 为MVC模式设计：分离可视化设计和应用程序逻辑；分离页面设计员和程序员。

2.2.5 智能的国际化和本地化

1. 字符集智能化（内部使用UNICODE）;
2. 数字格式本地化敏感；
3. 日期和时间格式本地化敏感；
4. 非US字符集可以用作标识（如：变量名）；
5. 多种不同语言的相同模板。

2.2.6 强大的XML处理能力

​ <#recurse> 和 <#visit> 指令（2.3版本）用于递归遍历 XML 树。在模板中清楚和直接的访问XML对象模型。开远论坛 JForum 就是使用了 FreeMarker 作为页面模板。

2.3.FreeMarker环境搭建

2.3.1.新建Maven Web项目

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-dncHj7rv-1612345259906)(…/MarkDownImages/image-20210121111358405.png)]

2.3.2.配置坐标依赖和部署插件

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.feixun.freemarker</groupId>
    <artifactId>FreeMarker</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>war</packaging>

    <name>FreeMarker Maven Webapp</name>
    <!-- FIXME change it to the project's website -->
    <url>http://www.example.com</url>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.source>1.8</maven.compiler.source>
        <maven.compiler.target>1.8</maven.compiler.target>
    </properties>

    <dependencies>

        <!-- freemarker的坐标依赖 -->
        <dependency>
            <groupId>org.freemarker</groupId>
            <artifactId>freemarker</artifactId>
            <version>2.3.23</version>
        </dependency>

        <!-- servlet-api的坐标依赖 -->
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>javax.servlet-api</artifactId>
            <version>3.0.1</version>
        </dependency>

    </dependencies>

    <build>
        <finalName>FreeMarker</finalName>

        <plugins>
            <plugin>
                <groupId>org.eclipse.jetty</groupId>
                <artifactId>jetty-maven-plugin</artifactId>
                <version>9.2.1.v20140609</version>
            </plugin>
        </plugins>
    </build>
</project>

2.3.3 修改配置文件 web.xml

<!DOCTYPE web-app PUBLIC
        "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
        "http://java.sun.com/dtd/web-app_2_3.dtd" >

<web-app>
    <display-name>Archetype Created Web Application</display-name>

    <!-- FreeMarker 的 Servlet配置 -->
    <servlet>
        <servlet-name>freemarker</servlet-name>
        <servlet-class>freemarker.ext.servlet.FreemarkerServlet</servlet-class>
        <init-param>
            <!-- 模板路径 -->
            <param-name>TemplatePath</param-name>
            <!-- 默认在webapp目录下查找对应的模板文件 -->
            <param-value>/</param-value>
        </init-param>

        <init-param>
            <!-- 模板默认的编码：UTF-8 -->
            <param-name>default_encoding</param-name>
            <!-- 默认在webapp目录下查找对应的模板文件 -->
            <param-value>UTF-8</param-value>
        </init-param>
    </servlet>

    <!-- 处理所有以 .ftl 结尾的文件；ftl 是 freemarker 默认的文件后缀 -->
    <servlet-mapping>
        <servlet-name>freemarker</servlet-name>
        <url-pattern>*.ftl</url-pattern>
    </servlet-mapping>

</web-app>

2.3.4 编写 Servlet 类

package com.feixun.freemarker;

import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;