FreeMarker的简单使用

一、FreeMarker概述

FreeMarker 是一款 模板引擎： 即一种基于模板和要改变的数据， 并用来生成输出文本(HTML网页，电子邮件，配置文件，源代码等)的通用工具。 它不是面向最终用户的，而是一个Java类库，是一款程序员可以嵌入他们所开发产品的组件。

FreeMarker 被设计⽤来⽣成 HTML Web ⻚⾯，特别是基于 MVC 模式的应⽤程序，将视图从业务逻辑中抽离处理，业务中不再包括视图的展示，⽽是将视图交给 FreeMarker 来输出。由FreeMarker生成页面，通过模板显示准备的数据。

FreeMarker不是Web应用框架，而是一个Web应用框架的组件。与容器无关，它并不知道HTTP或者Servlet。FreeMarker同样可以应用在非Web应用程序环境中

官网

中文文档

---

二、FreeMarker的特性

1、通用目标

FreeMarker可以生成各种文件,，例如HTML、XML、RTF、JAVA源代码等等。

FreeMarker易于嵌入到产品中：轻量级、不需要Servlet环境。

FreeMarker可以从任何源载入模板。

FreeMarker可以按需生成文本。可以保存到本地、作为Email发送，从Web程序返回给Web浏览器。

2、强大的模板语言

FreeMarker自带一些常用的指令：include、if-else、if-else-if、循环结构。也可以在模板中创建变量。几乎在任何地方都可以使用复杂的表达式来指定值。

3、通用数据模型

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

4、为Web准备

FreeMarker内建处理典型Web相关任务的结构。

可以集成到Mode2 Web框架中作为代替JSP的存在。

支持JSP标记库

分离可视化设计和程序逻辑；分离页面设计员与程序员

5、智能的国际化和本地化

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

数字格式本地化敏感

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

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

多种不同语言的相同模板

6、强大的XML处理能力

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

---

三、FreeMarker环境搭建

1、常规新建Maven Web项目

2、配置FreeMarker依赖，添加服务器插件

<?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>cn.yanghuisen</groupId>
  <artifactId>FreeMarkerTest</artifactId>
  <version>1.0-SNAPSHOT</version>
  <packaging>war</packaging>

  <name>FreeMarkerTest 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>
    <!-- https://mvnrepository.com/artifact/org.freemarker/freemarker -->
    <!-- 配置 freemarker依赖-->
    <dependency>
      <groupId>org.freemarker</groupId>
      <artifactId>freemarker</artifactId>
      <version>2.3.23</version>
    </dependency>
    <!-- https://mvnrepository.com/artifact/javax.servlet/javax.servlet-api -->
    <!-- 配置servlet依赖 -->
    <dependency>
      <groupId>javax.servlet</groupId>
      <artifactId>javax.servlet-api</artifactId>
      <version>3.1.0</version>
      <scope>provided</scope>
    </dependency>

  </dependencies>

  <build>
    <finalName>FreeMarkerTest</finalName>
    <plugins>
      <!-- 添加tomcat服务器插件 -->
      <plugin>
        <groupId>org.apache.tomcat.maven</groupId>
        <artifactId>tomcat7-maven-plugin</artifactId>
        <version>2.2</version>
        <configuration>
          <!--端口-->
          <port>8899</port>
          <!-- 站点名 -->
          <path>/web</path>
          <!-- 设置编码 -->
          <uriEncoding>UTF-8</uriEncoding>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

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>

  <!-- 相关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>

4、新建模板文件

在webapp目录下创建templaate文件夹，然后创建fm.ftl文件

${msg}

5、编写Servlet类

package cn.yanghuisen.servlet;

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("/ser")
public class Servlet extends HttpServlet {
    @Override
    protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        // 添加数据
        req.setAttribute("msg","Hello FreeMarker!");
        // 请求转发跳转到模板文件中
        req.getRequestDispatcher("template/fm.ftl").forward(req,resp);
    }
}

6、启动项目

---

四、FreeMarker的数据类型

FreeMarker中常用的数据类型由以下几种

类型	描述	备注
boolean	等价于Java中的boolean	不能直接输出，需要先转换为字符串
日期类型	等价于Java中的Date	不能直接输出，需要先转换为字符串
数值类型	等价于Java中的数值类型
字符类型	等价于Java中的字符串
空值	空字符串或者null
sequence	等价于Java中的数组，list，set等集合
hash类型	等价于Java中的Map

1、布尔类型

布尔类型不能直接输出，需要转换为字符串

req.setAttribute("flag",true);

获取数据s

<#--将boolean转换为字符串-->
${flag?c}
<#--将boolean值转化为为字符串，已被弃用，使用?c代替-->
${flag?string}
<#--将boolean值转化为为指定字符串，已被弃用,使用?then代替-->
${flag?string("Yes","No")}
<#--将boolean值转化为为指定字符串-->
${flag?then("Yes","No")}

2、日期类型

不能直接输出，需要转换为字符串

req.setAttribute("date",new Date());

获取数据

<#--转换为日期格式，只有年月日-->
${date?date}
<#--转换为时间模式，只有时分秒-->
${date?time}
<#--同属有年月日时分秒-->
${date?datetime}
<#--自定义格式-->
${date?string("yyyy-MM-dd HH:mm:ss")}

3、数值类型

req.setAttribute("age",10);
req.setAttribute("number",10000);
req.setAttribute("avg",3.1415926);

获取数据

<p>${age}</p>
<p>${number}</p>
<p>${avg}</p>

<p>${age?c}</p>
<#-- 转字符串 -->
<p>${number?c}</p>
<#--￥-->
<p>${number?string.currency}</p>
<#-- 百分比 -->
<p>${number?string.percent}</p>
<#--保留两位小数并且四舍五入-->
<p>${avg?string["0.2"]}</p>

4、字符类型

req.setAttribute("msg","Hello");
req.setAttribute("msg1","freemarker");
req.setAttribute("msg2"," ahh ");

获取数据

${msg}<br>
<#--1. 截取字符串（左闭右开） ?substring(start,end)-->
${msg?substring(0,2)}<br>
<#--2. 首字母小写输出  ?uncap_first-->
${msg?uncap_first}<br>
<#--3. 首字母大写输出  ?cap_first-->
${msg?cap_first}<br>
<#--4. 字母转小写输出  ?lower_case-->
${msg?lower_case}<br>
<#--5. 字母转大写输出  ?upper_case-->
${msg1?upper_case}<br>
<#--6. 获取字符串长度  ?length-->
${msg?length}<br>
<#--7. 是否以指定字符开头（boolean类型） ?starts_with("xx")?string-->
${msg?starts_with("h")?c}<br>
<#--8. 是否以指定字符结尾（boolean类型） ?ends_with("xx")?string-->
${msg?ends_with("o")?c}<br>
<#--9. 获取指定字符的索引  ?index_of("xx")-->
${msg?index_of("l")?c}<br>
<#--10. 去除字符串前后空格 ?trim-->
${msg?trim}<br>
<#--11. 替换指定字符串  ?replace("xx","xx")-->
${msg?replace("l","A")}<br>

5、空值

req.setAttribute("str1","");
req.setAttribute("str2",null);

获取数据

<#--不存在则什么都不显示-->
${abc!}<br>
<#-- 空字符串 -->
${str1!}<br>
<#--如果为空，则显示没有字符-->
${str1!"没有字符"}<br>
<#--null-->
${str2!}<br>
<#--如果为空，则显示null-->
${str2!"null"}<br>

<#--是否存在，返回的是一个boolean类型，需要转换为字符串-->
${(abc??)?c}<br>
${(str1??)?c}<br>
${(str2??)?c}<br>

6、sequenct

String[] strs = {"张三","李四","王二","麻子"};
req.setAttribute("strs",strs);

List<String> list = Arrays.asList("河南","河北","山东","山西");
req.setAttribute("list",list);

List<User> userList = new ArrayList<>();
userList.add(new User(1,"张三",20));
userList.add(new User(2,"李四",18));
userList.add(new User(3,"王二",22));
userList.add(new User(4,"麻子",21));
req.setAttribute("userList",userList);

获取数据

获取序列的长度${strs?size}<br>
获取第一个元素${strs?first}<br>
获取最后一个元素${strs?last}<br>
<#--数组-->
<#list strs as str >
    ${str?index}:${str}<br>
</#list>
<#--List-->
<#list list as str >
    ${str?index}:${str}<br>
</#list>
<#--倒叙-->
<#list list?reverse as str >
    ${str}
</#list>
<br>
<#--正序-->
<#list list?sort as str >
    ${str}
</#list>
<br>
<#--倒序后正序-->
<#list list?reverse?sort as str >
    ${str}
</#list>
<br>
<#--JavaBean-->
<#list userList as user >
    ${user}-${user.userId}-${user.userName}-${user.userAge}<br>
</#list>
<br>
<#--按照指定属性排序-->
<#list userList?sort_by("userAge") as user >
    {user.userId}-${user.userName}-${user.userAge}<br>
</#list>

7、hash类型

hash类型就是java中的Map集合

Map<String,String> map = new HashMap<>();
map.put("hn","河南");
map.put("hb","河北");
map.put("sd","山东");
map.put("sx","山西");
req.setAttribute("map",map);

获取数据

<#--获取所有的key，通过key获取所有的value-->
<#list map?keys as m>
    ${m}-${map[m]}<br>
</#list>
<#--获取所有的value-->
<#list map?values as v>
    ${v}<br>
</#list>

---

五、常用的指令

1、assign自定义变量指令

<#--定义单个变量-->
<#assign name="张三">
${name}<br>
<#--定义多个变量-->
<#assign age=20 names=["张三","李四","王二","麻子"]>
${age}<br>
${names?join("-")}<br>

• join：把数组按照指定字符分割

2、逻辑判断指定

<#assign age = 95>


<#if age < 60>
    成绩不合格
    <#elseif age<=80>
        还可以
    <#elseif age<=90>
        不错
    <#else >
        你很牛逼
</#if>
<br>

<#if age?? >
    存在
    <#else >
        不存在
</#if>

3、list遍历指令

<#assign list=[1,2,3]>

<#list list as item>
    ${item}
</#list>


<#list list as item>
    ${item}
<#else >
    没有数据
</#list>

<#--判断数据是否存在，存在则则遍历-->
<#if aaa??>
    <#list aaa as item>
        ${item}
    </#list>
</#if>

4、自定义指令

自定义指定的指令名不能重复

<#--指令名不能重复-->
<#macro test1>
    自定义指令
</#macro>
<@test1></@test1>
<br>
<#macro test2 str>
    自定义指令,并传递参数:${str}
</#macro>
<@test2 str="张三"></@test2>
<br>
<#macro test3 name age>
    自定义指令,并传递多个参数:${name}-${age}
</#macro>
<@test3 name="啊哈哈" age=20></@test3>
<br>
<#--自定义指令中包含内置指令-->
<#macro cfb>
    <#list 1..9 as i>
        <#list 1..i as j>
            ${j} * ${i} = ${i*j} &nbsp;
        </#list>
        <br>
    </#list>
</#macro>
<@cfb></@cfb>

5、占位指令

           `nested` 指令执行自定义指令开始和结束标签中间的模板片段。嵌套的片段可以包含模板中任意合法的内容。

<#--
    nested 占位指令
        nested 相当于占位符,一般结合macro指令一起使用。
        可以将自定义指令中的内容通过nested指令占位，当使用自定义指令时，会将占位内容显示。
-->
<#macro test>
    这是一段文本！
    <#nested>
    <#nested>
</#macro>
<@test><h4>这是文本后面的内容！</h4></@test>

<#macro a1>
    占位指令
</#macro>
<@a1>xxxx</@a1>
<br>
<#macro a1>
    占位指令
    <#nested >
    <#nested >
    <#nested >
</#macro>
<@a1>xxxx</@a1>

6、导入指令

可以引入另外一个模板

commons.ftl

<#macro cfb1 num>
    <#list 1..num as i>
        <#list 1..i as j>
            ${j} * ${i} = ${i*j} &nbsp;
        </#list>
        <br>
    </#list>
</#macro>

<#--导入指令-->
<#--可以使用其他文件中定义的自定义指令-->
<#import "commons.ftl" as cm>
<@cm.cfb1 num = 9></@cm.cfb1>

7、包含指令

可以将任意文本内容包含到FerrMarker中。

要保证被包含的文件存在

<#--引入其他文件的内容-->
<#include "test.html">
<#include "test.ftl">
<#include "test.txt">

六、运算符

1、算术运算符

<!--
    算术运算
        +、-、*、/、%
-->
<#assign a1 = 8 a2 = 2 >
${a1} + ${a2} = ${a1 + a2} <br/>
${a1} - ${a2} = ${a1 - a2} <br/>
${a1} * ${a2} = ${a1 * a2} <br/>
${a1} / ${a2} = ${a1 / a2} <br/>
${a1} % ${a2} = ${a1 % a2} <br/>
<!--字符串运算-->
${"hello" + "," + "freemarker"}

2、逻辑运算符

<#--
    逻辑运算符
     &&、||、!
-->

3、比较运算符

<#--
    比较运算符
        > (gt): 大于号，推荐使用 gt
        < (lt)： 小于号，推荐使用 lt
        >= (gte): 大于等于， 推荐是用 gte
        <= (lte): 小于等于，推荐使用 lte
        == ： 等于
        != : 不等于
-->

4、空值运算符

<#--
    空值运算符
     1. ??:判断是否为空，返回布尔类型
        如果不为空返回 false， 如果为空返回 true，不能直接输出
        ${(name??)?string}
     2. !: 设置默认值，如果为空，则设置默认值
         1. 设置默认为空字符串：
         ${name!}
         2. 设置指定默认值
         ${name!'zhangsan'}
-->

七、页面静态化

Freemarker 是一种基于模板的、用来生成输出文本的通用工具,所以可以定制符合自己业务的模板，然后生成自己的 html 页面。Freemarker 是通过freemarker.template.Configuration 这个对象对模板进行加载的（它也处理创建和缓存预解析模板的工作），然后通过 getTemplate 方法获得想要的模板，有一点要记住freemarker.template.Configuration 在整个应用必须保证唯一实例。

<!doctype html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport"
          content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
    <meta http-equiv="X-UA-Compatible" content="ie=edge">
    <title>Document</title>
</head>
<body>
    <h2 align="center">${title}</h2>
    <p align="center">
        新闻来源:${source}
        发布时间:${pubTime}
    </p>
    <p style="text-indent: 2em">
        ${content}
    </p>
</body>
</html>

package cn.yanghuisen.servlet;

import freemarker.template.Configuration;
import freemarker.template.Template;
import freemarker.template.TemplateException;

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.File;
import java.io.FileWriter;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;

@WebServlet("/news")
public class NewsServlet extends HttpServlet {
    @Override
    protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        // 实例化模板对象
        Configuration configuration = new Configuration();
        // 加载模板的上下文 设置模板的加载路径
        configuration.setServletContextForTemplateLoading(getServletContext(),"/template");
        // 设置模板编码格式
        configuration.setDefaultEncoding("UTF-8");
        // 加载模板文件，获取模板对象
        Template template = configuration.getTemplate("news.ftl");

        // 设置模板数据
        Map<String,Object> map = new HashMap<>();
        map.put("title","新闻标题");
        map.put("source","新闻来源");
        map.put("pubTime","2020年03月27日 21:25");
        map.put("content","新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。新闻内容。");
        // 获取项目根目录
        String path = getServletContext().getRealPath("/");
        // 设置html文件的存放目录
        File htmlFile = new File(path+"/html");
        // 文件夹是否存在，不存在则创建
        if (!htmlFile.exists()){
            htmlFile.mkdir();
        }
        // 生成随机文件名
        String fileName = System.currentTimeMillis()+".html";
        // 创建html文件
        File file = new File(htmlFile,fileName);
        FileWriter writer = new FileWriter(file);
        try {
            template.process(map,writer);
            System.out.println("成功");
        } catch (TemplateException e) {
            e.printStackTrace();
        }finally {
            writer.flush();
            writer.close();
        }
        System.out.println(fileName);
    }
}