持续创作,加速成长!这是我参与「掘金日新计划 · 6 月更文挑战」的第15天,点击查看活动详情
1、概述
FreeMarker 是一款模板引擎:一种基于模板的、用来生成输出文本(任何来自于 HTML格式的文本用来自动生成源代码)的通用工具。
它是为 Java 程序员提供的一个开发包或者说是类库。
它不是面向最终用户,而是为程序员提供的可以嵌入他们开发产品的一款应用程序。
详细介绍大家可以自行看官网的介绍 : freemarker.apache.org/
FreeMarker模板文件主要有5个部分组成:
名称 | 介绍 |
---|---|
数据模型 | 模板能用的所有数据 |
文本 | 直接输出的部分 |
注释 | 即<#--...-->格式不会输出 |
插值(Interpolation) | 即${..}或者#{..}格式的部分,将使用数据模型中的部分替代输出 |
FTL指令 | FreeMarker指令,和HTML标记类似,名字前加#予以区分,不会输出。 |
1.1 数据模型
FreeMarker(还有模板开发者)并不关心数据是如何计算的,FreeMarker 只是知道真实的数据是什么。
模板能用的所有数据被包装成 data-model 数据模型。
详细介绍 : freemarker.apache.org/docs/dgui_q…
![](/qrcode.jpg)
1.2 模板的常用标签
在FreeMarker模板中可以包括下面几个特定部分:
标签 | 介绍 |
---|---|
${…} | 称为interpolations,FreeMarker会在输出时用实际值进行替代。 |
${name} | 可以取得root中key为name的value。 |
${person.name} | 可以取得成员变量为person的name属性 |
<#…> | FTL标记(FreeMarker模板语言标记):类似于HTML标记,为了与HTML标记区分 |
<@> | 宏,自定义标签 |
注释 | 包含在<#--和-->(而不是)之间 |
1.3 模板常用命令
1、if指令 : 分支控制语句。
<#-- if 指令 -->
<#if sex=1>
性别是男
<#elseif sex = 0>
性别是女
<#else>
性别是未知
</#if>
复制代码
2、list、break指令 : list指令时一个典型的迭代输出指令,用于迭代输出数据模型中的集合。
<#list weeks as w>
<#if w_has_next> <#--是否存在下一个对象-->
,
</#if>
<#if w = "星期四">
<#break> <#--跳出迭代-->
</#if>
${w_index} <#--当前变量的索引值--> = ${w}
</#list>
复制代码
3、 include 指令 : include指令的作用类似于JSP的包含指令,用于包含指定页。
<#include "template01.ftl">
复制代码
直接写模板的地址,因为template01.ftl和当前模板在同一目录下,所以可以直接写文件名。
4、 assign指令 : 它用于为该模板页面创建或替换一个顶层变量
<#assign name = "一切总会归于平淡" />
${name}
复制代码
1.4 内置函数
FreeMarker还提供了一些内建函数来转换输出,可以在任何变量后紧跟?,?后紧跟内建函数,就可通过内建函数来转换输出变量。下面是常用的内建的字符串函数:
函数 | 说明 |
---|---|
html | html字符转义 |
cap_first | 字符串的第一个字母变为大写形式 |
lower_case | 字符串的小写形式 |
upper_case | 字符串的大写形式 |
trim | 去掉字符串首尾的空格 |
substring | 截字符串 |
lenth | 取长度 |
size | 序列中元素的个数 |
int | 数字的整数部分(比如- 1.9?int 就是- 1) |
示例
${name?length}
复制代码
2、 Freemarker的基本使用
2.1 构造环境
首先是构造环境,我们直接建一个springBoot项目。
将上面的 Apache Freemarker 勾上 ,Springboot 都帮我们整合好相关依赖了。
然后就是建一个文件夹 和 src 同级,专门用来放模板文件。
2.2 编写代码
再往里建立fremarker 文件。
注意,后缀是.ftl。
我的文件内容就是上面介绍的那些。
然后写一个测试类来测试。
@Test
void test01() throws Exception {
//1.创建freeMarker配置实例
Configuration cfg = new Configuration(Configuration.VERSION_2_3_29);
//2.设置模板加载器:开始加载模板
cfg.setDirectoryForTemplateLoading(new File("templates"));
//3.创建数据模型
Map<String, Object> dataModel = new HashMap<>();
dataModel.put("username", "张三");
dataModel.put("sex", 0);
List<String> weeks = new ArrayList<>();
weeks.add("星期一");
weeks.add("星期二");
weeks.add("星期三");
weeks.add("星期四");
weeks.add("星期五");
dataModel.put("weeks",weeks);
//4.获取模板
Template template = cfg.getTemplate("template.ftl");
template.process(dataModel, new PrintWriter(System.out));//在控制台输出内容
template.process(dataModel, new PrintWriter(new File("C:\Users\Administrator\Desktop\b.txt")));//在文件输出内容
}
复制代码
2.3 测试结果
2.4 字符串模板
有一种情况就是我们没有写ftl 文件的时候,这时候就可以自己使用java代码自定义模板。
@SpringBootTest
class FreeMarkerApplicationTests {
private Configuration conf;
@BeforeEach
public void init() {
conf = new Configuration(Configuration.VERSION_2_3_29);
}
@Test
void test02() throws Exception {
// 2、指定加载器 StringTemplateLoader() 字符串加载器
conf.setTemplateLoader(new StringTemplateLoader());
// 3、创建字符串模板
String templateString = "欢迎你,${username}"; // 字符串模板
Template template = new Template("",new StringReader(templateString),conf); // 通过字符串创建模板
//4、构造数据
Map<String,Object> dateModel = new HashMap<>();
dateModel.put("username","李四");
//5、处理模板
template.process(dateModel, new PrintWriter(new File("C:\Users\Administrator\Desktop\b.txt")));//在文件内输出
}
}
复制代码
看看效果。