【Freemarker】Freemarker基本使用

计和顺
2023-12-01

Freemarker基本使用

FreeMarker 是一个用 Java 语言编写的模板引擎,它基于模板来生成文本输出。FreeMarker与 Web 容器无关,即在 Web 运行时,它并不知道 Servlet 或 HTTP。它不仅可以用作表现层的实现技术,而且还可以用于生成 XML,JSP 或 Java 等。

使用步骤(html为例):

  1. 环境搭建
<dependency>
  <groupId>org.freemarker</groupId>
  <artifactId>freemarker</artifactId>
  <version>2.3.23</version>
</dependency>
  1. 创建模板文件
    模板文件中有四种元素:
    1. 文本,直接输出的部分
    2. 注释,格式 : <#–…-->, 不会输出
    3. 插值(Interpolation):即${..}部分,将使用数据模型中的部分替代输出
    4. FTL指令:FreeMarker指令,和HTML标记类似,名字前加#予以区分,不会输出
      Freemarker的模板文件后缀可以任意,一般建议为ftl。
      在D盘创建ftl目录,在ftl目录中创建名称为test.ftl的模板文件,内容如下:
<html>
<head>
    <meta charset="utf-8">
    <title>Freemarker入门</title>
</head>
<body>
    <#--我只是一个注释,我不会有任何输出  -->
    ${name}你好,${message}
</body>
</html>
  1. 生成HTML
    使用步骤:
    1. 创建一个 Configuration 对象,直接 new 一个对象。构造方法的参数就是 freemarker的版本号。
    2. 设置模板文件所在的路径。
    3. 设置模板文件使用的字符集。一般就是 utf-8。
    4. 加载一个模板,创建一个模板对象。
    5. 创建一个模板使用的数据集,可以是 pojo 也可以是 map。一般是 Map。
    6. 创建一个 Writer 对象,一般创建 FileWriter 对象,指定生成的文件名。
    7. 调用模板对象的 process 方法输出文件。
    8. 关闭流。
public static void main(String[] args) throws Exception{
    //1.创建配置类
    Configuration configuration=new Configuration(Configuration.getVersion());
    //2.设置模板所在的目录 
    configuration.setDirectoryForTemplateLoading(new File("D:\\ftl"));
    //3.设置字符集
    configuration.setDefaultEncoding("utf-8");
    //4.加载模板
    Template template = configuration.getTemplate("test.ftl");
    //5.创建数据模型
    Map<String,Object> map=new HashMap<>();
    map.put("name", "张三");
    map.put("message", "你好!!!");
    //6.创建Writer对象
    Writer out =new FileWriter(new File("d:\\test.html"));
    //7.输出
    template.process(map, out);
    //8.关闭Writer对象
    out.close();
}

上面的入门案例中Configuration配置对象是自己创建的,字符集和模板文件所在目录也是在Java代码中指定的
在项目中应用时可以将Configuration对象的创建交由Spring框架来完成,并通过依赖注入方式将字符集和模板所在目录注入进去。

  1. 常用指令
  • assign指令 --assign指令用于在页面上定义一个变量
1. 定义简单类型
<#assign linkman="周先生">
联系人:${linkman}

2. 定义对象类型
<#assign info={"mobile":"13812345678",'address':'北京市昌平区'} >
电话:${info.mobile}  地址:${info.address}
  • include指令 --include指令用于模板文件的嵌套
1.创建模板文件`head.ftl`
<h1>创建模板</h1>

2.在test.ftl模板文件中使用include指令引入上面的模板文件
<#include "head.ftl"/>
  • if指令 --if指令用于判断
1.在模板文件中使用if指令进行判断
<#if success=true>
  你已通过实名认证
<#else>  
  你未通过实名认证
</#if>
2.在java代码中为success变量赋值
map.put("success", true);
//在freemarker的判断中,可以使用`=` 也可以使用`==`
  • list指令 --list指令用于遍历
List goodsList=new ArrayList();

Map goods1=new HashMap();
goods1.put("name", "苹果");
goods1.put("price", 5.8);

Map goods2=new HashMap();
goods2.put("name", "香蕉");
goods2.put("price", 2.5);

Map goods3=new HashMap();
goods3.put("name", "橘子");
goods3.put("price", 3.2);

goodsList.add(goods1);
goodsList.add(goods2);
goodsList.add(goods3);

map.put("goodsList", goodsList);

在模板文件中使用list指令进行遍历商品数据

<#list goodsList as goods>
  商品名称: ${goods.name} 价格:${goods.price}<br>
</#list>
 类似资料: