FreeMarker 模板引擎入门
一、简述
FreeMarker 也是一款模板引擎技术，它是一种基于模板和要改变的数据，并用来生成输出文本(HTML网页，电子邮件，配置文件，源代码等)的通用工具。当然它也是一个Java类库，可以将之作为一个普通的组件嵌入到我们的产品中。
FreeMarker被设计用来生成HTML Web页面，特别是基于MVC模式的应用程序，将视图从业务逻辑中抽离出来，业务中不再包括视图的展示，而是将视图交给FreeMarker来输出。虽然FreeMarker具有一些编程的能力，但通常先让Java程序准备要显示的数据，然后再用FreeMarker生成具体页面。
使用的时候，我们只需提供模板(后缀名 .ftl）和 数据，freemarker便可以帮我们生成web页面。
常用的Java模板引擎：
- Jsp、Freemarker、Thymeleaf 、Velocity 等。
- Jsp 为 Servlet 专用，不能单独进行使用。（老牌的模板引擎）
- Thymeleaf 为新技术，功能较为强大，但是执行的效率比较低。（SpringBoot推荐使用的模板引擎）
- Velocity 从2010年更新完 2.0 版本后，便没有在更新。Spring Boot 官方在 1.4 版本后对此也不在支持，虽然 Velocity 在 2017 年版本得到迭代，但为时已晚。 （用的很少了）
二、环境搭建&快速入门
reemarker作为springmvc一种视图格式，默认情况下SpringMVC支持freemarker视图格式。
创建一个springboot工程
导入maven依赖（springmvc和freemarker）
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-freemarker</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
</dependencies>
修改application.yml配置：（关闭缓存、配置后缀名）
spring:
application:
name: freemarker-demo #服务名称
freemarker:
cache: false #关闭模板缓存，方便测试
settings:
template_update_delay: 0 #检查模板更新延迟时间，设置为0表示立即检查，如果时间大于0会有缓存不方便进行模板测试
suffix: .ftl #指定Freemarker模板文件的后缀名
template-loader-path: classpath:/templates/ #模板存放位置
server:
port: 8081 #服务端口
编写实体类和controller代码，为模板引擎提供数据
实体类
@Data
public class Student {
private String name;//姓名
private int age;//年龄
private Date birthday;//生日
}
controller代码
package com.yuzi.generator.Controller;
import com.yuzi.generator.model.entity.Student;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
import java.util.Date;
@Controller // 注意，这里是不能使用@RestController的，我们需要返回的是String类型的字符串，不能返回Json字符串
@Tag(name = "Freemarker")
public class HelloController {
@GetMapping("hello")
public String hello(Model model) {
// 1.纯文本形式的参数
model.addAttribute("name", "freemarker");//参数1属性名称(在页面中使用),参数2模板数据
// 2.实体类相关的参数
Student student = new Student() {
{
setName("小舞");
setAge(18);
}
};
model.addAttribute("stu", student);
return "helloworld"; //模板文件名称
}
}
在resources/templates/目录下创建helloworld.ftl文件
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Hello World!</title>
</head>
<body>
<b>普通文本 String 展示：</b><br><br>
Hello ${name} <br>
<hr>
<b>对象Student中的数据展示：</b><br/>
姓名：${stu.name}<br/>
年龄：${stu.age}
<hr>
</body>
</html>
6、启动项目，访问接口测试：http://localhost:8081/hello
数据对应关系：
三、FreeMarker指令语法
基础语法
1、freemarker的注释：即<#--xxx-->，不会解析成页面会被freemarker忽略掉。
<#--我是一个freemarker注释-->
2、插值（Interpolation）：即 ${xxx} 部分，freemarker会用真实的值代替**${xxx}**。
Hello ${name}
3、FTL指令：和HTML标记类似，指令名字前加#井号区分，Freemarker会解析标签中的表达式或逻辑。
<#xxx>FTL指令</#xxx>
4、文本，仅文本信息，可以直接输出内容。
<#--freemarker中的普通文本-->
我是一个普通的文本
集合指令（list和map）
遍历list
语法：
<#list stus as stu></#list>
示例：
@GetMapping("/list")
public String list(Model model) {
Student stu1 = new Student();
stu1.setName("小三");
stu1.setAge(18);
stu1.setMoney(3000d);
Student stu2 = new Student();
stu2.setName("小五");
stu2.setAge(19);
stu2.setMoney(6000d);
//将两个对象模型数据存放到List集合中
List<Student> stus = new ArrayList<>();
stus.add(stu1);
stus.add(stu2);
//向model中存放List集合数据
model.addAttribute("stus", stus);
return "list";//页面模板文件名称
}
list.ftl:
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Hello World!</title>
</head>
<body>
<#-- list 数据的展示 -->
<b>展示list中的stu数据:</b>
<br>
<br>
<table border="1px solid #ccc" cellspacing="0" cellpadding="0">
<tr>
<td>序号</td>
<td>姓名</td>
<td>年龄</td>
<td>钱包</td>
</tr>
<#list stus as stu>
<tr>
<td>${stu_index+1}</td>
<td>${stu.name}</td>
<td>${stu.age}</td>
<td>${stu.money}</td>
</tr>
</#list>
</table>
</body>
</html>
遍历map
1、获取map中的值
map['keyname'].property
map.keyname.property
2、遍历map
最后更新于 2026-02-18 18:15