一、freemarker介绍
1.freemarker的介绍
Freemarker是模板引擎,一种基于模板和要改变的数据,并用来生成输出文本html网页的通用工具。不是面向最终用户,而是一个java类库,程序员可以嵌入开发产品的组件。
二、环境搭建和快速入门
1.环境搭建
①创建模块用于测试,pom文件的依赖
<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>
<!-- lombok -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
<!-- apache 对 java io 的封装工具库 -->
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-io</artifactId>
<version>1.3.2</version>
</dependency>
</dependencies>
②配置文件application.yml
server:
port: 8881 #服务端口
spring:
application:
name: freemarker-demo #指定服务名
freemarker:
cache: false #关闭模板缓存,方便测试
settings:
template_update_delay: 0 #检查模板更新延迟时间,设置为0表示立即检查,如果时间大于0会有缓存不方便进行模板测试
suffix: .ftl #指定Freemarker模板文件的后缀名
2.快速入门
①创建模型类Student
@Data
public class Student {
private String name;//姓名
private int age;//年龄
private Date birthday;//生日
private Float money;
}
②创建模块
在resources下创建templates,存放freemarker的默认模板存放目录。创建01-basic.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>
③创建controller,freemarker作为springmnv一种格式视图,进行填充数据。将数据添加到Model对象中,从而可以在视图中使用
@Controller
public class HelloController {
@GetMapping("/basic")
public String test(Model model) {
//1.纯文本形式的参数
model.addAttribute("name", "freemarker");
//2.实体类相关的参数
Student student = new Student();
student.setName("小明");
student.setAge(18);
model.addAttribute("stu", student);
return "01-basic";
}
}
④测试http://localhost:8881/basic
三、freemarker基础
1.基础语法的种类
①注释,即<#-- -->,介于其之间的内容会被freemarker忽略
<#--我是一个freemarker注释-->
②插值,即 ${..}部分,freemarker会用真实的值代替${..}
Hello ${name}
③FTL指令,和HTML标记类似,名字前加#予以区分,Freemarker会解析标签中的表达式或逻辑。
<# >FTL指令</#>
④文本,仅文本信息
<#--freemarker中的普通文本-->
我是一个普通的文本
2.获取list数据
①controller
@GetMapping("/list")
public String list(Model model){
Student stu1 = new Student();
stu1.setName("wang");
stu1.setAge(18);
stu1.setBirthday(new Date());
stu1.setMoney(15550.0F);
Student stu2 = new Student();
stu2.setName("lei");
stu2.setAge(28);
stu2.setBirthday(new Date());
stu2.setMoney(6550.0F);
List<Student> stus = new ArrayList<>();
stus.add(stu1);
stus.add(stu2);
model.addAttribute("stus",stus);
return "02-list";
}
②模板02-list
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Hello World!</title>
</head>
<body>
<#-- list 数据的展示 -->
<b>展示list中的stu数据:</b>
<table>
<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>
3.获取map数据
①controller
@GetMapping("/map")
public String map(Model model){
Student stu1 = new Student();
stu1.setName("wang");
stu1.setAge(18);
stu1.setBirthday(new Date());
stu1.setMoney(15550.0F);
Student stu2 = new Student();
stu2.setName("lei");
stu2.setAge(28);
stu2.setBirthday(new Date());
stu2.setMoney(6550.0F);
HashMap<String,Student> stuMap = new HashMap<>();
stuMap.put("stu1",stu1);
stuMap.put("stu2",stu2);
model.addAttribute("stuMap", stuMap);
return "03-map";
}
②模板03-map
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Hello World!</title>
</head>
<body>
<a href="###">遍历map中两个学生信息:</a><br/>
<table>
<tr>
<td>序号</td>
<td>姓名</td>
<td>年龄</td>
<td>钱包</td>
</tr>
<#list stuMap?keys as key >
<tr>
<td>${key_index}</td>
<td>${stuMap[key].name}</td>
<td>${stuMap[key].age}</td>
<td>${stuMap[key].money}</td>
</tr>
</#list>
</table>
</body>
</html>
4.if条件判断
<#if ></if>
①当name是小红条件成立
<table>
<tr>
<td>姓名</td>
<td>年龄</td>
<td>钱包</td>
</tr>
<#list stus as stu >
<#if stu.name='小红'>
<tr style="color: red">
<td>${stu_index}</td>
<td>${stu.name}</td>
<td>${stu.age}</td>
<td>${stu.money}</td>
</tr>
<#else >
<tr>
<td>${stu_index}</td>
<td>${stu.name}</td>
<td>${stu.age}</td>
<td>${stu.money}</td>
</tr>
</#if>
</#list>
</table>
5.空值处理
①判断某变量是否存在
变量名??
<#if stus??>
<#list stus as stu>
......
</#list>
</#if>
②缺失变量默认值使用 “!”
使用!要以指定一个默认值,当变量为空时显示默认值
${name!''}表示如果name为空显示空字符串。
6.内建函数 变量+?+函数名称
①集合的大小
${集合名?size}
②日期格式化
显示年月日: ${today?date}
显示时分秒:${today?time}
显示日期+时间: ${today?datetime}
自定义格式化: ${today?string("yyyy年MM月")}
③内建函数c字符串
model.addAttribute("point", 102920122);
point是数字型,使用${point}会显示这个数字的值,每三位使用逗号分隔。
如果不想显示为每三位分隔的数字,可以使用c函数将数字型转成字符串输出
${point?c}
7.JSON字符串转成对象
assign标签,assign的作用是定义一个变量
四、freemarker静态化测试
1.说明
上述案例是MVC作为视图解析器来集成到项目,工作中用原生Api来生成静态内容。
原生API生成html文件
@Autowired
private Configuration configuration;
@Test
public void test() throws IOException {
// 找到模板对象
Template template = configuration.getTemplate("02-list.ftl");
// 合成方法,返回的数据和输出流
template.process(返回的数据,new FileWriter("生成文件存放的路径"));
}