Springboot集成Freemarker
一、前言🔥
上一期，我是带着大家入门了SpringBoot集成Kafka，今天我再来一期Freemarker的零基础教学吧。不知道大家对kafka有多少了解，反正我就是从搭建开始，然后再加一个简单演示，这就算是带着大家了个门哈，剩下的我再后边慢慢出教程给大家说。
二、环境说明🔥
演示环境：idea2021 + springboot 2.3.1REALSE + Freemarker
三、Freemarker 介绍🔥
FreeMarker 是一款 模板引擎： 即一种基于模板和要改变的数据， 并用来生成输出文本(HTML网页，电子邮件，配置文件，源代码等)的通用工具。 它不是面向最终用户的，而是一个Java类库，是一款程序员可以嵌入他们所开发产品的组件。
模板编写为FreeMarker Template Language (FTL)。它是简单的，专用的语言， 不是 像PHP那样成熟的编程语言。 那就意味着要准备数据在真实编程语言中来显示，比如数据库查询和业务运算， 之后模板显示已经准备好的数据。在模板中，你可以专注于如何展现数据， 而在模板之外可以专注于要展示什么数据。 
常用的java模板引擎还有哪些？
Jsp、Freemarker、Thymeleaf 、Velocity 等。
Jsp 为 Servlet 专用，不能单独进行使用。
Thymeleaf 为新技术，功能较为强大，但是执行的效率比较低。
Velocity从2010年更新完 2.0 版本后，便没有在更新。Spring Boot 官方在 1.4 版本后对此也不在支持，虽然 Velocity 在 2017 年版本得到迭代，但为时已晚。
四、环境搭建&&快速入门🔥
freemarker作为springmvc一种视图格式，默认情况下SpringMVC支持freemarker视图格式。
需要创建Spring Boot+Freemarker工程用于测试模板。
4.1 创建测试工程
创建一个freemarker-demo 的测试工程专门用于freemarker的功能测试与模板的测试。
pom.xml如下:
<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 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <parent> <artifactId>suihao-testartifactId> <groupId>com.suihaogroupId> <version>1.0-SNAPSHOTversion> parent> <modelVersion>4.0.0modelVersion> <artifactId>freemarker-demoartifactId> <properties> <maven.compiler.source>8maven.compiler.source> <maven.compiler.target>8maven.compiler.target> properties> <dependencies> <dependency> <groupId>org.springframework.bootgroupId> <artifactId>spring-boot-starter-webartifactId> dependency> <dependency> <groupId>org.springframework.bootgroupId> <artifactId>spring-boot-starter-freemarkerartifactId> dependency> <dependency> <groupId>org.springframework.bootgroupId> <artifactId>spring-boot-starter-testartifactId> dependency> <dependency> <groupId>org.projectlombokgroupId> <artifactId>lombokartifactId> dependency> <dependency> <groupId>org.apache.commonsgroupId> <artifactId>commons-ioartifactId> <version>1.3.2version> dependency> dependencies>project>4.2 配置文件
配置application.yml
server: port: 8881 #服务端口spring: application: name: freemarker-demo #指定服务名 freemarker: cache: false #关闭模板缓存，方便测试 settings: template_update_delay: 0 #检查模板更新延迟时间，设置为0表示立即检查，如果时间大于0会有缓存不方便进行模板测试 suffix: .ftl #指定Freemarker模板文件的后缀名4.3 创建模型类
在freemarker的测试工程下创建模型类型用于测试
package com.suihao.freemarker.entity;import lombok.Data;import java.util.Date;@Datapublic class Student { private String name;//姓名 private int age;//年龄 private Date birthday;//生日 private Float money;//钱包}4.4 创建模板
resources下创建templates，此目录为freemarker的默认模板存放目录。
在templates下创建模板文件 01-basic.ftl ，模板中的插值表达式最终会被freemarker替换成具体的数据。
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>4.5 创建controller
创建Controller类，向Map中添加name，最后返回模板文件。
package com.xuecheng.test.freemarker.controller;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.stereotype.Controller;import org.springframework.web.bind.annotation.RequestMapping;import org.springframework.web.client.RestTemplate;import java.util.Map;@Controllerpublic 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"; }}4.6 创建启动类
package com.suihao.freemarker;import org.springframework.boot.SpringApplication;import org.springframework.boot.autoconfigure.SpringBootApplication;@SpringBootApplicationpublic class FreemarkerDemotApplication { public static void main(String[] args) { SpringApplication.run(FreemarkerDemotApplication.class,args); }}4.7 测试
请求：http://localhost:8881/basic
五、Freemarker 基础🔥
基础语法种类
注释，即<#-- -->，介于其之间的内容会被freemarker忽略
<#--我是一个freemarker注释-->插值（Interpolation): 即 ${…} 部分,freemarker会用真实的值代替 ${…}
Hello ${name}FTL指令：和HTML标记类似，名字前加#予以区分，Freemarker会解析标签中的表达式或逻辑。
<# >FTL指令 文本，仅文本信息，这些不是freemarker的注释、插值、FTL指令的内容会被freemarker忽略解析，直接输出内容。
<#--freemarker中的普通文本-->我是一个普通的文本集合指令（List和Map）
数据模型：
在HelloController中新增如下方法：
@GetMapping("/list")public String list(Model model){ //------------------------------------ Student stu1 = new Student(); stu1.setName("小强"); stu1.setAge(18); stu1.setMoney(1000.86f); stu1.setBirthday(new Date()); //小红对象模型数据 Student stu2 = new Student(); stu2.setName("小红"); stu2.setMoney(200.1f); stu2.setAge(19); //将两个对象模型数据存放到List集合中 List<Student> stus = new ArrayList<>(); stus.add(stu1); stus.add(stu2); //向model中存放List集合数据 model.addAttribute("stus",stus); //------------------------------------ //创建Map数据 HashMap<String,Student> stuMap = new HashMap<>(); stuMap.put("stu1",stu1); stuMap.put("stu2",stu2); // 3.1 向model中存放Map数据 model.addAttribute("stuMap", stuMap); return "02-list";}模板：
在templates中新增02-list.ftl文件
DOCTYPE html><html><head> <meta charset="utf-8"> <title>Hello World!title>head><body> <#-- list 数据的展示 --><b>展示list中的stu数据:b><br><br><table> <tr> <td>序号td> <td>姓名td> <td>年龄td> <td>钱包td> tr>table><hr> <#-- Map 数据的展示 --><b>map数据的展示：b><br/><br/><a href="###">方式一：通过map['keyname'].propertya><br/>输出stu1的学生信息：<br/>姓名：<br/>年龄：<br/><br/><a href="###">方式二：通过map.keyname.propertya><br/>输出stu2的学生信息：<br/>姓名：<br/>年龄：<br/><br/><a href="###">遍历map中两个学生信息：a><br/><table> <tr> <td>序号td> <td>姓名td> <td>年龄td> <td>钱包td> tr>table><hr> body>html>👆上面代码解释：
${k_index}：
index：得到循环的下标，使用方法是在stu后边加"_index"，它的值是从0开始if指令
if 指令即判断指令，是常用的FTL指令，freemarker在解析时遇到if会进行判断，条件为真则输出if中间的内容，否则跳过内容不再输出。- 指令格式
<#if >
数据模型：
使用list指令中测试数据模型，判断名称为小红的数据字体显示为红色。
模板：
<table> <tr> <td>姓名td> <td>年龄td> <td>钱包td> tr> <#list stus as stu> <tr> <td >${stu.name}td> <td>${stu.age}td> <td >${stu.mondy}td> tr> #list>table>输出：
姓名为“小强”则字体颜色显示为红色。
运算符
算数运算符
FreeMarker表达式中完全支持算术运算,FreeMarker支持的算术运算符包括:
- 加法： +
- 减法： -
- 乘法： *
- 除法： /
- 求模 (求余)： %
模板代码
<b>算数运算符b><br/><br/> 100+5 运算： ${100 + 5 }<br/> 100 - 5 * 5运算：${100 - 5 * 5}<br/> 5 / 2运算：${5 / 2}<br/> 12 % 10运算：${12 % 10}<br/><hr>除了 + 运算以外，其他的运算只能和 number 数字类型的计算。
2、比较运算符
- =或者==:判断两个值是否相等.
- !=:判断两个值是否不等.
- >或者gt:判断左边值是否大于右边值
- >=或者gte:判断左边值是否大于等于右边值
- <或者lt:判断左边值是否小于右边值
- <=或者lte:判断左边值是否小于等于右边值
= 和 == 模板代码
DOCTYPE html><html><head> <meta charset="utf-8"> <title>Hello World!title>head><body> <b>比较运算符b> <br/> <br/> <dl> <dt> =/== 和 != 比较：dt> <dd> <#if "xiaoming" == "xiaoming"> 字符串的比较 "xiaoming" == "xiaoming" #if> dd> <dd> <#if 10 != 100> 数值的比较 10 != 100 #if> dd> dl> <dl> <dt>其他比较dt> <dd> <#if 10 gt 5 > 形式一：使用特殊字符比较数值 10 gt 5 #if> dd> <dd> <#-- 日期的比较需要通过?date将属性转为data类型才能进行比较 --> <#if (date1?date >= date2?date)> 形式二：使用括号形式比较时间 date1?date >= date2?date #if> dd> dl> <br/><hr>body>html>Controller 的 数据模型代码
@GetMapping("operation")public String testOperation(Model model) { //构建 Date 数据 Date now = new Date(); model.addAttribute("date1", now); model.addAttribute("date2", now); return "03-operation";}比较运算符注意
- =和!=可以用于字符串、数值和日期来比较是否相等
- =和!=两边必须是相同类型的值,否则会产生错误
- 字符串 “x” 、"x " 、"X"比较是不等的.因为FreeMarker是精确比较
- 其它的运行符可以作用于数字和日期,但不能作用于字符串
- 使用gt等字母运算符代替>会有更好的效果,因为 FreeMarker会把>解释成FTL标签的结束字符
- 可以使用括号来避免这种情况,如:<#if (x>y)>
逻辑运算符
- 逻辑与:&&
- 逻辑或:||
- 逻辑非:!
逻辑运算符只能作用于布尔值,否则将产生错误 。
模板代码
<b>逻辑运算符b> <br/> <br/> <#if (10 lt 12 )&&( 10 gt 5 ) > (10 lt 12 )&&( 10 gt 5 ) 显示为 true #if> <br/> <br/> <#if !false> false 取反为true #if><hr>空值处理
判断某变量是否存在使用 “??”
用法为:variable??,如果该变量存在,返回true,否则返回false
例：为防止stus为空报错可以加上判断如下：
<#if stus??> <#list stus as stu> ...... #list> #if>缺失变量默认值使用 “!”
-
使用!要以指定一个默认值，当变量为空时显示默认值
例： ${name!‘’}表示如果name为空显示空字符串。 -
如果是嵌套对象则建议使用（）括起来
例： ${(stu.bestFriend.name)!‘’}表示，如果stu或bestFriend或name为空默认显示空字符串。
来源地址：https://blog.csdn.net/heima005/article/details/129435750
