天天看点
返回

2021-08-15 FreemarkerFreeMarker(模板引擎)

FreeMarker(模板引擎) 

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

1、配置坐标依赖和部署插件

在pom.xml引入servlet-api的坐标依赖和freemarker的坐标依赖

<dependencies>
        <!-- servlet-api的坐标依赖 -->
        <!-- https://mvnrepository.com/artifact/javax.servlet/javax.servlet-api -->
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>javax.servlet-api</artifactId>
            <version>3.0.1</version>
            <scope>provided</scope>
        </dependency>
        <!-- freemarker的坐标依赖 -->
        <!-- https://mvnrepository.com/artifact/org.freemarker/freemarker -->
        <dependency>
            <groupId>org.freemarker</groupId>
            <artifactId>freemarker</artifactId>
            <version>2.3.28</version>
        </dependency>
    </dependencies>

2、修改配置文件 web.xml

<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>

3、在webapp目录下新建template文件夹，创建ftl文件，启动项目使用

FreeMarker 数据类型

语法：

1、布尔类型

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

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

2、日期类型

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

java // 日期类型 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>

3、数值类型

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

java // 数值类型 request.setAttribute("age",18); // 数值型 request.setAttribute("salary",10000); // 数值型 request.setAttribute("avg",0.545); // 浮点型

2. 获取数据

<#--
数据类型：数值类型
在freemarker中数值类型可以直接输出；
1. 转字符串
普通字符串 ?c
货币型字符串 ?string.currency
百分比型字符串 ?string.percent
2. 保留浮点型数值指定小数位（#表示一个小数位）
?string["0.##"]
-->
<#-- 直接输出数值型 -->
${age} <br>
${salary} <br>
<#-- 将数值转换成字符串输出 -->
${salary?c} <br>
<#-- 将数值转换成货币类型的字符串输出 -->
${salary?string.currency} <br>
<#-- 将数值转换成百分比类型的字符串输出 -->
${avg?string.percent} <br>
<#-- 将浮点型数值保留指定小数位输出 （##表示保留两位小数） -->
${avg?string["0.##"]} <br>

4、字符串类型

1. 在Servlet中设置字符串类型的数据

java // 字符串类型 request.setAttribute("msg","Hello "); request.setAttribute("msg2","freemarker");

2. 获取数据

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

字符串空值情况处理

FreeMarker 的变量必须赋值，否则就会抛出异常。而对于 FreeMarker 来说，null 值和不存在的变量是完全一样的，因为 FreeMarker 无法理解 null 值。

FreeMarker 提供两个运算符来避免空值：

① ! ：指定缺失变量的默认值

${value!}：如果value值为空，则默认值是空字符串

${value!“默认值”}：如果value值为空，则默认值是字符串"默认值"

② ?? ：判断变量是否存在

如果变量存在，返回 true，否则返回 false

${(value??)?string}

<#-- 如果值不存在，直接输出会报错 -->
<#--${str}-->
<#-- 使用!，当值不存在时，默认显示空字符串 -->
${str!}<br>
<#-- 使用!"xx"，当值不存在时，默认显示指定字符串 -->
${str!"这是一个默认值"}<br>
<#-- 使用??，判断字符串是否为空；返回布尔类型。如果想要输出，需要将布尔类型转换成字符串 -->
${(str??)?string}<br>

5、sequence类型

<#--
数据类型：序列类型 （数组、List、Set）
通过list指令输出序列
<#list 序列名 as 元素名>
${名称}
</#list>
获取序列的长度 ${序列名?size}
获取序列元素的下标 ${元素名?index}
获取第一个元素 ${序列名?first}
获取最后一个元素 ${序列名?last}
倒序输出 序列名?reverse
升序输出 序列名?sort
降序输出 序列名?sort?reverse
指定字段名排序 序列名?sort_by("字段名")
注：一般是JavaBean集合，对应的字段名需要提供get方法
-->

6、hash类型

<#--
数据类型：hash类型
key遍历输出
<#list hash?keys as key>
${key} -- ${hash[key]}
</#list>
value遍历输出
<#list hash?values as value>
${value}
</#list>
-->
           
<h2>date</h2><hr/>
${date?date}<br/>
${date?time}<br/>
${date?datetime}<br/>
${date?string("yyyy<=>MM<=>dd  hh-mm-ss")}<br/>
<h2>boolean</h2><hr/>
${flag?string("yes","no")}<br/>
${flag?c}<br/>
${flag?string}<br/>
<h2>空，null</h2><hr/>
${(age??)?c}<br/>
${age!}<br/>
${age!"没得"}<br/>
<h2>numbers</h2><hr/>
${age}<br/>
${age?c}<br/>
${age?string}<br/>
${salary?string.currency}<br/>
${avg?string.percent}<br/>
${avg?string["0.##"]}<br/>
<h2>string</h2><hr/>
<#-- 直接输出 -->
${str1} - ${str2} <br>
${str1?string} - ${str2?string} <br>
<#-- 1. 截取字符串（左闭右开） ?substring(start,end) -->
${str2?substring(1,4)} <br>
<#-- 2. 首字母小写输出 ?uncap_first -->
${str1?uncap_first} <br>
<#-- 3. 首字母大写输出 ?cap_first -->
${str2?cap_first} <br>
<#-- 4. 字母转小写输出 ?lower_case -->
${str1?lower_case} <br>
<#-- 5. 字母转大写输出 ?upper_case -->
${str2?upper_case} <br>
<#-- 6. 获取字符串长度 ?length -->
${str2?length} <br>
<#-- 7. 是否以指定字符开头（boolean类型） ?starts_with("xx")?string -->
${str1?starts_with("H")?string} <br>
<#-- 8. 是否以指定字符结尾（boolean类型） ?ends_with("xx")?string -->
${str2?ends_with("h")?string} <br>
<#-- 9. 获取指定字符的索引 ?index_of("xxx") -->
${str2?index_of("e")} <br>
<#-- 10. 去除字符串前后空格 ?trim -->
${str1?trim?length} <br>
<#-- 11. 替换指定字符串 ?replace("xx","xxx") -->
${str2?replace("r","R")}<br>
<h2>sequence 类型</h2><hr/>
<#--  数组 -->
${strings?join("**")}
<br/>
<#--集合-->
<#list arrayslist as li>
    ${li?string}-->
</#list>
<br/>
<#-- JavaBean集合 -->
<#list userlist?sort_by("uage") as user>
    编号：${user.userID}&nbsp;&nbsp;<br/>
    姓名：${user.uname}&nbsp;&nbsp;<br/>
    年龄：${user.uage}&nbsp;&nbsp;<br/>
</#list>
<hr/>
<#-- key遍历输出 -->
<#list cityMap?keys as key>
    ${key} -- ${cityMap[key]} <br>
</#list>
<#-- value遍历输出 -->
<#list cityMap?values as value>
    ${value} |
</#list>

运行结果：

2021-08-15 FreemarkerFreeMarker(模板引擎)
2021-08-15 FreemarkerFreeMarker(模板引擎)
2021-08-15 FreemarkerFreeMarker(模板引擎)

FreeMarker 常见指令

1. assign 自定义变量指令

<#--
assign 自定义变量指令
语法：
<#assign 变量名=值>
<#assign 变量名=值 变量名=值> （定义多个变量）
-->
<#assign str="hello">
${str} <br>
<#assign num=1 names=["zhangsan","lisi","wangwu"] >
${num} -- ${names?join(",")}

2. if elseif else 逻辑判断指令

可以使用 if ， elseif 和 else 指令来条件判断是否满足某些条件。

<#--
if, else, elseif 逻辑判断指令
格式：
<#if condition>
...
<#elseif condition2>
...
<#elseif condition3>
...
<#else>
...
</#if>
注：
1. condition, condition2等：将被计算成布尔值的表达式。
2. elseif 和 else 指令 是可选的。
-->

3. list 遍历指令

可以使用 list 指令来对序列进行遍历。

<#--
list指令
格式1：
<#list sequence as item>
</#list>
格式2：
<#list sequence as item>
<#else>
当没有选项时，执行else指令
</#list>
注：
1. else 部分是可选的
2. sequence： 想要迭代的项，可以是序列或集合的表达式
3. item： 循环变量 的名称
4. 当没有迭代项时，才使用 else 指令， 可以输出一些特殊的内容而不只是空在那里
-->

4. macro 自定义指令 宏

<#--
macro 自定义指令 （宏）
1. 基本使用
格式：
<#macro 指令名>
指令内容
</#macro>
使用：
<@指令名></@指令名>
2. 有参数的自定义指令
格式：
<#macro 指令名 参数名1 参数名2>
指令内容
</#macro>
使用：
<@指令名 参数名1=参数值1 参数名2=参数值2></@指令名>
注：
1. 指令可以被多次使用。
2. 自定义指令中可以包含字符串，也可包含内置指令
-->

5. nested 占位指令

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

<#--
nested 占位指令
nested 相当于占位符,一般结合macro指令一起使用。
可以将自定义指令中的内容通过nested指令占位，当使用自定义指令时，会将占位内容显示。
-->

6. import 导入指令

import 指令可以引入一个库。也就是说，它创建一个新的命名空间， 然后在那个命名空间中执行给定路径的模板。可以使用引入的空间中的指令。

commons.ftl

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

在其他ftl页面中通过import导入commons.ftl的命名空间，使用该命名空间中的指令

test.ftl

<#-- 导入命名空间 -->
<#import "commons.ftl" as common>
<#-- 使用命名空间中的指令 -->
<@common.cfb></@common.cfb>

7. include 包含指令

可以使用 include 指令在你的模板中插入另外一个 FreeMarker 模板文件 。 被包含模板的输出格式是在 include 标签出现的位置插入的。 被包含的文件和包含它的模板共享变量，就像是被复制粘贴进去的一样。

<#--包含指令(引入其他页面文件) include-->
<#--html文件-->
<#include "test.html">
<#--freemarker文件-->
<#include "test.ftl">
<#--text文件-->
<#include "test.txt">

FreeMarker 页面静态化 

Freemarker 是通过freemarker.template.Configuration 这个对象对模板进行加载的（它也处理创建和缓存预解析模板的工作），然后我们通过 getTemplate 方法获得你想要的模板，有一点要记住freemarker.template.Configuration 在你整个应用必须保证唯一实例。

1. 定义模板

news.ftl

<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<#-- 新闻标题 -->
<h1>${title}</h1>
<p>
	新闻来源：${source} &nbsp; 发布时间：${pubTime?string("yyyy-MM-dd HH:mm")}
</p>
<#-- 新闻内容 -->
<p>
	${content}
</p>

2. 加载模板

@WebServlet("/news")
public class NewsServlet extends HttpServlet {
    @Override
    protected void service(HttpServletRequest request, HttpServletResponse response) 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", new Date());
        map.put("content", "中共中央政治局常务委员会近日召开会议强调，" +
                "要有针对性地开展援企、稳岗、扩就业工作，" +
                "做好高校毕业生、农民工等重点群体就业工作，" +
                "积极帮助个体工商户纾困。疫情期间，稳就业情况如何？还有哪些问题待解？" +
                "记者采访了不同群体，记录这个特别的就业季。");
        // 获取项目所在的根目录
        String basePath = request.getServletContext().getRealPath("/");
        // 设置页面存放的目录
        File htmlFile = new File(basePath + "/html");
        // 判断目录是否存在
        if (!htmlFile.exists()) {
        // 如果目录不存在，则新建目录
            htmlFile.mkdir();
        }
        // 获取文件名（随机生成不重复的文件名）
        String fileName = System.currentTimeMillis() + ".html";
        // 创建html文件
        File file = new File(htmlFile, fileName);
        // 获取文件输出流
        FileWriter writer = new FileWriter(file);
        try {
            // 输出html 将模型数据填充到模板中
            template.process(map, writer);
            // 输出成功
            System.out.println("新闻创建成功！");
        } catch (TemplateException e) {
            e.printStackTrace();
        } finally {
            writer.flush();
            writer.close();
        }
    }
}

3. 生成对应的html文件

生成的文件存放在服务器项目的webapp目录下的html目录中。

FreeMarker 运算符

  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"}
  1. 逻辑运算符 
<#--
	逻辑运算符
	&&、||、!
-->
  1. 比较运行符 
<#--
	比较运算符
	> (gt): 大于号，推荐使用 gt
	< (lt)： 小于号，推荐使用 lt
	>= (gte): 大于等于， 推荐是用 gte
	<= (lte): 小于等于，推荐使用 lte
	== ： 等于
	!= : 不等于
-->
  1. 空值运算符 
<#--
	空值运算符
	1. ??:判断是否为空，返回布尔类型
		如果不为空返回 false， 如果为空返回 true，不能直接输出
		${(name??)?string}
	2. !: 设置默认值，如果为空，则设置默认值
		1. 设置默认为空字符串：
			${name!}
		2. 设置指定默认值
			${name!'zhangsan'}
-->
java freemarker
上一篇: 设计模式在前端项目中的应用
下一篇: 2021-08-15，内容：

继续阅读