FreeMarker详细介绍

FreeMarker

1. 主要内容

2.FreeMarker概述

2.1. FreeMarker概念

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

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

FreeMarker不是一个Web应用框架，而适合作为Web应用框架一个组件。
FreeMarker与容器无关，因为它并不知道HTTP或Servlet。FreeMarker同样可以应用于非Web应用程序环境。
FreeMarker更适合作为Model2框架（如Struts）的视图组件，你也可以在模板中使用JSP标记库。

2.2. FreeMarker特性

2.2.1. 通用目标

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

2.2.2. 强大的模板语言

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

2.2.3. 通用数据模型

FreeMarker不是直接反射到Java对象，Java对象通过插件式对象封装，以变量方式在模板中显示，你可以使用抽象（接口）方式表示对象（JavaBean、XML文档、SQL查询结果集等等），告诉模板开发者使用方法，使其不受技术细节的打扰。

2.2.4. 为Web准备

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

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

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

2.2.6. 强大的XML处理能力

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

2.3. FreeMarker环境搭建

2.3.1. 新建 Maven Web项目

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

pom.xml

<?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.suntao</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>

    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.11</version>
      <scope>test</scope>
    </dependency>
  </dependencies>

  <build>
    <finalName>freemarker</finalName>
    <!--
      插件地址：
        Tomcat
          http://tomcat.apache.org/maven-plugin-2.2/
        Jetty
          https://www.eclipse.org/jetty/documentation/current/jetty-mavenplugin.html
     -->
    <plugins>
      <!-- 配置jetty插件 -->
      <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

在项目的webapp/WEB-INF目录下的web.xml文件中，添加freemarker 相关 servlet 配置

<?xml version="1.0" encoding="UTF-8"?>
<web-app id="WebApp_ID" version="3.0"
         xmlns="http://java.sun.com/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd">
  <!-- 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>
      <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类

在main目录下新建Java目录，设置为Sources Root，新建包com.suntao.controllter,在包下创建FreeMarker01.java文件

package com.suntao.controllter;

import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

@WebServlet("/f01")
public class FreeMarker01 extends HttpServlet {
    @Override
    protected void service(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        //添加数据
        request.setAttribute("msg","Hello FreeMarker!");
        //请求跳转到ft1文件中
        request.getRequestDispatcher("template/f01.ftl").forward(request,response);
    }
}

2.3.5. 新建模板文件 ftl

在webapp目录下新建template文件夹，创建f01.ftl文件

<#--
    html 注释语法
        浏览器中查看源码可见

-->
<#--