FreeMarker学习
文章目录
Freemarker 简介
这是一个相当老牌的开源的免费的模版引擎。通过 Freemarker 模版,我们可以将数据渲染成 HTML 网页、电子邮件、配置文件以及源代码等。Freemarker 不是面向最终用户的,而是一个 Java 类库,我们可以将之作为一个普通的组件嵌入到我们的产品中。
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-I5N7K0y0-1600246452847)(C:\Users\Administrator\AppData\Roaming\Typora\typora-user-images\image-20200903153620077.png)]
Freemarker 可以将模版和数据渲染成 HTML 。
Freemarker 模版默认后缀为 .ftl
(FreeMarker Template Language)。也可以指定为其它的后缀。FTL 是一种简单的、专用的语言,它不是像 Java 那样成熟的编程语言。在模板中,你可以专注于如何展现数据, 而在模板之外可以专注于要展示什么数据。
Springboot整合
首先创建一个 Spring Boot 工程,引入 Freemarker 依赖,如下图:
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-qiIVT8s0-1600246452851)(C:\Users\Administrator\AppData\Roaming\Typora\typora-user-images\image-20200903154017402.png)]
pom文件
<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.3.3.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.example</groupId>
<artifactId>freemarker</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>freemarker</name>
<description>Demo project for Spring Boot</description>
<properties>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-freemarker</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
<exclusions>
<exclusion>
<groupId>org.junit.vintage</groupId>
<artifactId>junit-vintage-engine</artifactId>
</exclusion>
</exclusions>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<version>1.5.9.RELEASE</version>
</plugin>
</plugins>
</build>
</project>
application.yml
spring:
freemarker:
template-loader-path: classpath:/templates/ ///模板文件位置
cache: false //是否开启缓存
charset: utf-8 //模板文件编码
check-template-location: true //是否检查模板位置
content-type: text/html //Content-Type的值
expose-request-attributes: false //是否将HttpServletRequest中的属性添加到Model中
expose-session-attributes: false //是否将HttpSession中的属性添加到Model中
suffix: .ftl //模板文件后缀
allow-request-override: false //HttpServletRequest的属性是否可以覆盖controller中model的同名项
等同于代码
public void test() throws IOException, TemplateException {
// 第一步:创建一个Configuration对象,直接new一个对象。构造方法的参数就是freemarker对于的版本号。
Configuration configuration = new Configuration(Configuration.getVersion());
// 第二步:设置模板文件所在的路径。
configuration.setDirectoryForTemplateLoading(new File("\\WEB-INF\\ftl"));
// 第三步:设置模板文件使用的字符集。一般就是utf-8.
configuration.setDefaultEncoding("utf-8");
// 第四步:加载一个模板,创建一个模板对象。 Template template = configuration.getTemplate("hello.ftl");
// 第五步:创建一个模板使用的数据集,可以是pojo也可以是map。一般是Map。
Map dataModel = new HashMap();
// 向数据集中添加数据
dataModel.put("hello", "this is my first freemarker test.");
// 第六步:创建一个Writer对象,一般创建一FileWriter对象,指定生成的文件名。
Writer out = new FileWriter(new File("D:\\Java\\Eclipse\\workspace_Test\\FreeMarker\\out\\hello.html"));
// 第七步:调用模板对象的process方法输出文件。
template.process(dataModel, out);
// 第八步:关闭流。
out.close();
}
testController
package com.example.controller;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import java.util.Map;
@Controller
public class TestController {
@RequestMapping("/test")
public String test(Map<String,Object> map){
map.put("test","我成功了吗");
return "test";
}
}
输出页面
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-RFgSvLp3-1600246452853)(C:\Users\Administrator\AppData\Roaming\Typora\typora-user-images\image-20200903155212687.png)]
模板的基本语法
访问map中的key
${key}
访问pojo中的属性
${key.property}
##############
<body>
学号:${stu.id}<br>
姓名:${stu.name}<br>
年龄:${stu.age}<br>
</body>
取集合中的数据
<#list 要循环的数据 as 循环后的数据>
</list>
###############
<#list studentlist as student>
<tr>
<td>${student_index}</td> //${student_index}也可以获取循环中的下标
<td>${student.id}</td>
<td>${student.name}</td>
<td>${student.age}</td>
</tr>
</list>
判断
<#if student_index % 2 == 0>
<#else>
</#if>
##################
<body>
<table boder=1>
<#list studentlist as student>
<#if student_index %2 ==0> //判断
<tr bgcolor="red">
<#else>
<tr bgcolor="green">
</list>
</table>
</body>
日期类型格式化
直接取值:${date}(date是属性名)如果传来的是一个Date型数据会报错
${date?date} //2020-9-3
${date?time} //17:00:55
${date?datetime} //2020-9-3 17:00:55
如果感觉freemaker提供的功能太弱,可以在java中格式化好之后再通过普通字符串的形式传入进来。
Null值的处理
如果直接取一个不存在的值(值为null)时会报异常
如果允许变量可以为空,并且不希望报出异常,可以在变量后面加上一个!
。
${aaa!}
Include标签
如果希望在某个FTL文件中引入另外一个FTL文件,可以使用FTL关键字。格式如下:
<#include “模板名称”> //(相当于jstl中的包含)
功能太弱,可以在java中格式化好之后再通过普通字符串的形式传入进来。
---
#### Null值的处理
如果直接取一个不存在的值(值为null)时会报异常
如果允许变量可以为空,并且不希望报出异常,可以在变量后面加上一个`!`。
```ftl
${aaa!}
Include标签
如果希望在某个FTL文件中引入另外一个FTL文件,可以使用FTL关键字。格式如下:
<#include “模板名称”> //(相当于jstl中的包含)