2021-10-19 FreeMarker

FreeMarker

主要内容

FreeMarker概述

FreeMarker概念

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

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

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

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

FreeMarker更适合作为Model2框架(Struts)的视图组件,你也可以在模板中使用JSP标记库.

FreeMarker特性

通用目标

能够生成各种文本:HTML.XML.RTF,Java源代码等等

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

插件式模板载入器:可以从任何资源载入模板.如本地文件,数据库等等.

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

强大的模板语言

所有常用的指令:include,if/elseif/else.循环结构

在模板中创建和改变变量

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

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

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

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

通用数据模型

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

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

为Web准备

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

能够集成Model2Web应用框架中作为JSP的替代

支持JSP标记库

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

智能的国际化和本地化

字符集智能化(内部使用UNICODE)

数字格式本地化敏感

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

非US字符集可以作用标识符(如变量名)

多种不同语言的相同模板

强大的XML处理能力

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

FreeMarker环境搭建

新建Maven Web项目

配置坐标依赖和部署插件

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/maven4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.xxxx</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>
    <!--
        插件地址：
          Tomcat
            http://tomcat.apache.org/maven-plugin-2.2/
          Jetty
            https://www.eclipse.org/jetty/documentation/current/jetty-maven-plugin.html
    -->
    <plugins>
      <!-- 配置jetty插件 -->
      <plugin>
        <groupId>org.eclipse.jetty</groupId>
        <artifactId>jetty-maven-plugin</artifactId>
        <version>9.2.1.v20140609</version>
      </plugin>
    </plugins>
  </build>
</project>

修改配置文件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>

编写Servlet类

package com.xxxx.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 {
   
        // 添加数据![在这里插入图片描述](https://img-blog.csdnimg.cn/e47991ae995e422d922b7130d8e26056.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBA5b2t5LqO5pmP54ix57yW56iL,size_20,color_FFFFFF,t_70,g_se,x_16#pic_center)

        request.setAttribute("msg","Hello FreeMarker!");
        // 请求转发跳转到ftl文件中
        request.getRequestDispatcher("template/f01.ftl").forward(request,response);
   }
}

新建模板文件ftl

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

启动项目

访问项目

浏览器地址栏输入：http://localhost:8989/f01

FreeMarker数据类型

FreeMarker模板中的数据类型由如下几种:

布尔类型:等价于Java的Boolean类型,不同的是不能直接输出,可转换为字符串输出

日期型:等价于java的Date类型,不同的是不能直接输出,需要转成字符串再输出

数值型:等价于java中的int , float , double 等数值类型

有三种显示形式:数值型(默认),货币型,百分比型

字符型:等价于java中的字符串,有很多内置函数

sequence类型: 等价于java的数组,list,set等集合类型

hash类型: 等价于java中的Map类型

布尔类型

1.在Servlet中设置布尔类型的数据

// 布尔类型
request.setAttribute("flag", true);

2.获取数据

<#--
    数据类型：布尔类型
        在freemarker中布尔类型不能直接输出；如果输出要先转成字符串
        方式一：?c
        方式二：?string 或 ?string("true时的文本","false时的文本")
-->
${
   flag?c} <br>
${
   flag?string} <br>
${
   flag?string("yes","no")} <br>

日期类型

1.在Servlet中设置日期类型的数据

// 日期类型
request.setAttribute("createDate",new Date());

2.获取数据

<#--
    数据类型：日期类型
        在freemarker中日期类型不能直接输出；如果输出要先转成日期型或字符串
        1. 年月日          ?date
        2. 时分秒          ?time
        3. 年月日时分秒     ?datetime
        4. 指定格式        ?string("自定义格式")
                           y：年  M：月  d：日
                           H：时  m：分  s：秒
-->
<#-- 输出日期格式 -->
${
   createDate?date} <br>  
<#-- 输出时间格式 -->
${
   createDate?time} <br>
<#-- 输出日期时间格式 -->
${
   createDate?datetime} <br>   
<#-- 输出格式化日期格式 -->
${
   createDate?string("yyyy年MM月dd日 HH:mm:ss")} <br>  

数值类型

1.在Servlet设置数值型的数据

// 数值类型
request.setAttribute("age",18); // 数值型
request.setAttribute("salary",10000);