笔记

最新推荐文章于 2023-10-03 15:28:00 发布

大鱼三上

最新推荐文章于 2023-10-03 15:28:00 发布

阅读量379

点赞数

本文链接：https://blog.csdn.net/Yearsuree/article/details/106104569

版权

FreeMarker

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

4.0.0
com.xxxx
freemarker
1.0-SNAPSHOT
war
freemarker Maven Webapp

http://www.example.com

<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<maven.compiler.source>1.8</maven.compiler.source>
<maven.compiler.target>1.8</maven.compiler.target>
2.3.3. 修改配置⽂件 web.xml
在项⽬的webapp/WEB-INF⽬录下的web.xml⽂件中，添加freemarker 相关 servlet 配置

org.freemarker freemarker 2.3.23 javax.servlet javax.servlet-api 3.0.1 freemarker org.eclipse.jetty jetty-maven-plugin 9.2.1.v20140609 <?xml version="1.0" encoding="UTF-8"?> freemarker freemarker.ext.servlet.FreemarkerServlet TemplatePath / default_encoding UTF-8 freemarker *.ftl 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 { // 添加数据 request.setAttribute("msg","Hello FreeMarker!"); // 请求转发跳转到ftl⽂件中

request.getRequestDispatcher(“template/f01.ftl”).forward(request,response);
}
}
2.3.5. 新建模板⽂件 ftl
在webapp⽬录下新建template⽂件夹，创建f01.ftl⽂件
2.3.6. 启动项⽬
2.3.7. 访问项⽬
浏览器地址栏输⼊：http://localhost:8989/f01
3. FreeMarker 数据类型
3. FreeMarker 数据类型
Freemarker 模板中的数据类型由如下⼏种：
布尔型：等价于 Java 的 Boolean 类型，不同的是不能直接输出，可转换为字符串输出
⽇期型：等价于 java 的 Date 类型，不同的是不能直接输出，需要转换成字符串再输出
数值型：等价于 java 中的 int,float,double 等数值类型
有三种显示形式：数值型(默认)、货币型、百分⽐型
字符型：等价于 java 中的字符串，有很多内置函数
sequence 类型：等价于 java 中的数组，list，set 等集合类型
hash 类型：等价于 java 中的 Map 类型
3.1. 布尔类型

在Servlet中设置布尔类型的数据
获取数据
3.2. ⽇期类型
在Servlet中设置⽇期类型的数据
获取数据
// 布尔类型
request.setAttribute(“flag”, true);
<#–
数据类型：布尔类型
在freemarker中布尔类型不能直接输出；如果输出要先转成字符串
⽅式⼀：?c
⽅式⼆：?string 或 ?string(“true时的⽂本”,“false时的⽂本”)
–>
${flag?c}

${flag?string}

${flag?string(“yes”,“no”)}

// ⽇期类型
request.setAttribute(“createDate”,new Date());
<#–
数据类型：⽇期类型
3.3. 数值类型
在Servlet设置数值型的数据
获取数据
在freemarker中⽇期类型不能直接输出；如果输出要先转成⽇期型或字符串
年⽉⽇ ?date
时分秒 ?time
年⽉⽇时分秒 ?datetime
指定格式 ?string(“⾃定义格式”)
y：年 M：⽉ d：⽇
H：时 m：分 s：秒
–>
<#-- 输出⽇期格式 -->
${createDate?date}

<#-- 输出时间格式 -->
${createDate?time}
<#-- 输出⽇期时间格式 -->
${createDate?datetime}

<#-- 输出格式化⽇期格式 -->
${createDate?string(“yyyy年MM⽉dd⽇ HH:mm:ss”)}

// 数值类型
request.setAttribute(“age”,18); // 数值型
request.setAttribute(“salary”,10000); // 数值型
request.setAttribute(“avg”,0.545); // 浮点型
<#–
数据类型：数值类型
在freemarker中数值类型可以直接输出；
转字符串
普通字符串 ?c
货币型字符串 ?string.currency
百分⽐型字符串 ?string.percent
保留浮点型数值指定⼩数位（#表示⼀个⼩数位）
?string[“0.##”]
–>
<#-- 直接输出数值型 -->
${age}

${salary}
<#-- 将数值转换成字符串输出 -->
${salary?c}
<#-- 将数值转换成货币类型的字符串输出 -->
${salary?string.currency}
<#-- 将数值转换成百分⽐类型的字符串输出 -->
3.4. 字符串类型
在Servlet中设置字符串类型的数据
获取数据
${avg?string.percent}
<#-- 将浮点型数值保留指定⼩数位输出（##表示保留两位⼩数） -->
${avg?string[“0.##”]}

// 字符串类型
request.setAttribute(“msg”,"Hello ");
request.setAttribute(“msg2”,“freemarker”);
<#–
数据类型：字符串类型
在freemarker中字符串类型可以直接输出；
截取字符串（左闭右开） ?substring(start,end)
⾸字⺟⼩写输出 ?uncap_first
⾸字⺟⼤写输出 ?cap_first
字⺟转⼩写输出 ?lower_case
字⺟转⼤写输出 ?upper_case
获取字符串⻓度 ?length
是否以指定字符开头（boolean类型） ?starts_with(“xx”)?string
是否以指定字符结尾（boolean类型） ?ends_with(“xx”)?string
获取指定字符的索引 ?index_of(“xx”)
去除字符串前后空格 ?trim
替换指定字符串 ?replace(“xx”,“xx”)
–>
<#-- 直接输出 -->
${msg} - ${msg2}

${msg?string} - ${msg2?string}
<#-- 1. 截取字符串（左闭右开） ?substring(start,end) -->
${msg2?substring(1,4)}
<#-- 2. ⾸字⺟⼩写输出 ?uncap_first -->
${msg?uncap_first}
<#-- 3. ⾸字⺟⼤写输出 ?cap_first -->
${msg2?cap_first}
<#-- 4. 字⺟转⼩写输出 ?lower_case -->
${msg?lower_case}
<#-- 5. 字⺟转⼤写输出 ?upper_case -->
${msg?upper_case}
<#-- 6. 获取字符串⻓度 ?length -->
${msg?length}
<#-- 7. 是否以指定字符开头（boolean类型） ?starts_with(“xx”)?string -->
${msg?starts_with(“H”)?string}

字符串空值情况处理
FreeMarker 的变量必须赋值，否则就会抛出异常。⽽对于 FreeMarker 来说，null 值和不存在的变
量是完全⼀样的，因为 FreeMarker ⽆法理解 null 值。
FreeMarker 提供两个运算符来避免空值：
① ! ：指定缺失变量的默认值
${value!}：如果value值为空，则默认值是空字符串
${value!“默认值”}：如果value值为空，则默认值是字符串"默认值"
② ?? ：判断变量是否存在
如果变量存在，返回 true，否则返回 false
${(value??)?string}
3.5. sequence 类型
在Servlet中设置序列类型的数据
<#-- 8. 是否以指定字符结尾（boolean类型） ?ends_with(“xx”)?string -->
${msg?ends_with(“h”)?string}
<#-- 9. 获取指定字符的索引 ?index_of(“xxx”) -->
${msg?index_of(“e”)}
<#-- 10. 去除字符串前后空格 ?trim -->
${msg?trim?length}
<#-- 11. 替换指定字符串 ?replace(“xx”,“xxx”) -->
$KaTeX parse error: Expected 'EOF', got '#' at position 29: \dots"o","a")}<br> <#̲-- 如果值不存在，直接输出会\dots$ {str}–>
<#-- 使⽤!，当值不存在时，默认显示空字符串 -->
${str!}
<#-- 使⽤!“xx”，当值不存在时，默认显示指定字符串 -->
${str!“这是⼀个默认值”}
<#-- 使⽤??，判断字符串是否为空；返回布尔类型。如果想要输出，需要将布尔类型转换成字符串 -->
${(str??)?string}

// 序列类型（数组、List、Set）
// 数组操作
String[] stars = new String[]{“周杰伦”,“林俊杰”,“陈奕迅”,“五⽉天”};
request.setAttribute(“stars”,stars);
// List操作
List citys = Arrays.asList(“上海”,“北京”,“杭州”,“深圳”);
request.setAttribute(“cityList”,citys);
// JavaBean集合
List userList = new ArrayList<>();
userList.add(new User(1,“zhangsan”,22));
userList.add(new User(2,“lisi”,18));
userList.add(new User(3,“wangwu”,20));
request.setAttribute(“userList”,userList);
获取数据
<#–
数据类型：序列类型（数组、List、Set）
通过list指令输出序列
<#list 序列名 as 元素名>
${名称}
</#list>
获取序列的⻓度 ${序列名?size}
获取序列元素的下标 ${元素名?index}
获取第⼀个元素 ${序列名?first}
获取最后⼀个元素 $KaTeX parse error: Expected 'EOF', got '#' at position 129: \dots需要提供get⽅法 --> <#̲-- 数组操作 --> <#l\dots$ {star?index} – 名字： $KaTeX parse error: Expected 'EOF', got '#' at position 15: {star} <br> </#̲list> 数组的⻓度：$ {stars?size}
<#-- 获取第⼀个元素 -->
第⼀个元素： $KaTeX parse error: Expected 'EOF', got '#' at position 21: \dotss?first} <br> <#̲-- 获取最后⼀个元素 -->\dots$ {stars?last}

<#-- List操作 -->
<#list cityList as city >
$KaTeX parse error: Expected 'EOF', got '#' at position 15: {city} <br> </#̲list> List的size\dots$ {cityList?size}
<#-- 倒序输出 -->
<#list cityList?reverse as city >
${city} - </#list>
<#-- 升序输出 -->
3.6. hash 类型
在Servlet中设置hash类型的数据
获取数据
<#list cityList?sort as city >
${city} - </#list>
<#-- 降序输出 -->
<#list cityList?sort?reverse as city >
$KaTeX parse error: Expected 'EOF', got '#' at position 12: {city} - </#̲list> <hr> <#--\dots$ {user.userId}
姓名： $KaTeX parse error: Expected 'EOF', got '&' at position 13: {user.uname}&̲nbsp;  年龄：$ {user.uage}

</#list> <#-- 按照指定字段名排序 -->
<#list userList?sort_by(“uage”) as user>
${user.uname} | </#list>
// Map操作
Map<String,String> cityMap = new HashMap<>();
cityMap.put(“sh”,“上海”);
cityMap.put(“bj”,“北京”);
cityMap.put(“sz”,“深圳”);
request.setAttribute(“cityMap”,cityMap);
<#–
数据类型：hash类型
key遍历输出
<#list hash?keys as key>
${key} – ${hash[key]}
</#list>
value遍历输出
<#list hash?values as value>
${value}
</#list>
FreeMarker 常⻅指令
4.1. assign ⾃定义变量指令
使⽤ assign 指令你可以创建⼀个新的变量，或者替换⼀个已经存在的变量。
4.2. if elseif else 逻辑判断指令
可以使⽤ if ， elseif 和 else 指令来条件判断是否满⾜某些条件。
–>
<#-- key遍历输出 -->
<#list cityMap?keys as key>
${key} – ${cityMap[key]}
</#list> <#-- value遍历输出 -->
<#list cityMap?values as value>
${value} | </#list> <#–
assign ⾃定义变量指令
语法：
<#assign 变量名=值>
<#assign 变量名=值变量名=值> （定义多个变量）
–>
<#assign str=“hello”>
${str}
<#assign num=1 names=[“zhangsan”,“lisi”,“wangwu”] >
${num} – ${names?join(",")}
<#–
if, else, elseif 逻辑判断指令
格式：
<#if condition>
…
<#elseif condition2>
…
<#elseif condition3>
…
<#else>
…
</#if>
4.3. list 遍历指令
可以使⽤ list 指令来对序列进⾏遍历。
注：
condition, condition2等：将被计算成布尔值的表达式。
elseif 和 else 指令是可选的。
–>
<#assign score = 80> <#if score < 60>
你个⼩渣渣！
<#elseif score == 60>
分不在⾼，及格就⾏！
<#elseif score gt 60 && score lt 80>
哎哟不错哦！
<#else>
你很棒棒哦！
</#if>
<#-- 判断数据是否存在 -->
<#assign list=""> <#if list??>
数据存在
<#else>
数据不存在
</#if> <#–
list指令
格式1：
<#list sequence as item>
</#list>
格式2：
<#list sequence as item>
<#else>
当没有选项时，执⾏else指令
</#list>
注：
else 部分是可选的
sequence：想要迭代的项，可以是序列或集合的表达式
item：循环变量的名称
当没有迭代项时，才使⽤ else 指令，可以输出⼀些特殊的内容⽽不只是空在那⾥
–>
<#assign users = [“张三”,“李四”,“王五”]>
4.4. macro ⾃定义指令
可以使⽤ macro 指令来⾃定义⼀些⾃定义指令。
<#-- 遍历序列 -->
<#list users as user>
${user} </#list>
<#–判断数据不为空，再执⾏遍历（如果序列不存在，直接遍历会报错）–>
<#if users2??>
<#list users2 as user>
${user}
</#list> </#if>
<#assign users3 = []> <#-- 当序列没有数据项时，使⽤默认信息 -->
<#list users3 as user>
${user}
<#else>
当前没有数据！
</#list> <#–
macro ⾃定义指令（宏）
基本使⽤
格式：
<#macro 指令名>
指令内容
</#macro>
使⽤：
<@指令名></@指令名>
有参数的⾃定义指令
格式：
<#macro 指令名参数名1 参数名2>
指令内容
</#macro>
使⽤：
<@指令名参数名1=参数值1 参数名2=参数值2></@指令名>
注：
指令可以被多次使⽤。
⾃定义指令中可以包含字符串，也可包含内置指令
–>
<#-- 定义基本的⾃定义指令 -->
<#macro address>
© 1999–2015 The FreeMarker Project. All rights reserved. </#macro> <#-- 使⽤指令 -->
<@address>/@address
<@address>/@address
<#-- 定义有参数的⾃定义指令 -->
<#macro queryUserByName uname>
通过⽤户名查询⽤户信息 - ${uname} </#macro> <#-- 使⽤指令，并传递参数 -->
<@queryUserByName uname=“admin”>/@queryUserByName
<#-- 定义有多个参数的⾃定义指令 -->
<#macro queryUserByParams uname uage>
通过多个餐宿查询⽤户信息 - ${uname} - ${uage} </#macro> <#-- 使⽤指令，并传递多个参数 -->
<@queryUserByParams uname=“admin” uage=18>/@queryUserByParams

<#-- ⾃定义指令中包含内置指令 -->
<#macro cfb>
<#list 1…9 as i>
<#list 1…i as j>
${j}*$ {i}=${ji}
</#list>

</#list> </#macro> <@cfb>/@cfb <@cfb>/@cfb <#-- 动态数据 -->
<#macro cfb2 num>
<#list 1…num as i>
<#list 1…i as j>
${j}*$ {i}=${ji}
</#list>

</#list> </#macro> <@cfb2 num=5>/@cfb2
4.5. nested 占位指令
nested 指令执⾏⾃定义指令开始和结束标签中间的模板⽚段。嵌套的⽚段可以包含模板中任意合法
的内容。
4.6. import 导⼊指令
import 指令可以引⼊⼀个库。也就是说，它创建⼀个新的命名空间，然后在那个命名空间中执⾏给
定路径的模板。可以使⽤引⼊的空间中的指令。
commons.ftl
在其他ftl⻚⾯中通过import导⼊commons.ftl的命名空间，使⽤该命名空间中的指令
test.ftl
4.7. include 包含指令
<#–
nested 占位指令
nested 相当于占位符,⼀般结合macro指令⼀起使⽤。
可以将⾃定义指令中的内容通过nested指令占位，当使⽤⾃定义指令时，会将占位内容显示。
–>
<#macro test>
这是⼀段⽂本！
<#nested>
<#nested> </#macro> <@test>
这是⽂本后⾯的内容！
/@test <#macro cfb>
<#list 1…9 as i>
<#list 1…i as j>
${j}*$ {i}=${j*i}
</#list>

</#list> </#macro> <#-- 导⼊命名空间 -->
<#import “commons.ftl” as common> <#-- 使⽤命名空间中的指令 -->
<@common.cfb>/@common.cfb
可以使⽤ include 指令在你的模板中插⼊另外⼀个 FreeMarker 模板⽂件。被包含模板的输出格式
是在 include 标签出现的位置插⼊的。被包含的⽂件和包含它的模板共享变量，就像是被复制粘贴进
去的⼀样。
FreeMarker ⻚⾯静态化
通过上述介绍可知 Freemarker 是⼀种基于模板的、⽤来⽣成输出⽂本的通⽤⼯具,所以
我们必须要定制符合⾃⼰业务的模板，然后⽣成⾃⼰的 html ⻚⾯。Freemarker 是通过
freemarker.template.Configuration 这个对象对模板进⾏加载的（它也处理创建和缓存预
解析模板的⼯作），然后我们通过 getTemplate ⽅法获得你想要的模板，有⼀点要记住
freemarker.template.Configuration 在你整个应⽤必须保证唯⼀实例。
5.1. 定义模板
news.ftl
5.2. 加载模板
<#–包含指令(引⼊其他⻚⾯⽂件) include–>
<#–html⽂件–>
<#include “test.html”> <#–freemarker⽂件–>
<#include “test.ftl”> <#–text⽂件–>
<#include “test.txt”> <#-- 新闻标题 -->

${title}

新闻来源：${source} 发布时间：${pubTime?sring("yyyy-MM-dd HH:mm")}

<#-- 新闻内容 -->

${content}

@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(),"/templ
ate");
// 设置模板的编码格式
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();
}
}
}
5.3. ⽣成对应的html⽂件
浏览器地址栏输⼊：
http://localhost:8989/news
⽣成的⽂件存放在当前项⽬的webapp⽬录下的html⽬录中。
6. FreeMarker 运算符
6.1. 算术运算符
6.2. 逻辑运算符
6.3. ⽐较运算符
6.4. 空值运算符

<#assign a1 = 8 a2 = 2 >
${a1} + ${a2} = ${a1 + a2}

${a1} - ${a2} = ${a1 - a2}

${a1} * ${a2} = ${a1 * a2}

${a1} / ${a2} = ${a1 / a2}

${a1} % ${a2} = ${a1 % a2}

${“hello” + “,” + “freemarker”} <#–
逻辑运算符
&&、||、!
–>
<#–
⽐较运算符