Springboot系列-整合Freemaker

本文主要是介绍Springboot系列-整合Freemaker，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

Springboot系列-整合Freemaker

前言：我们知道虽然现在互联网行业项目正在朝着一种前后端费分离的模式，但是不分离的开发仍然存在，并且在上篇博客中我们提到了Springboot整合Thymleaf,那么什么是Freemaker呢，他又和Thymleaf有什么区别呢？

Freemaker简介

FreeMarker是一款模板引擎：即一种基于模板和要改变的数据，并用来生成输出文本（HTML网页、电子邮件、配置文件、源代码等）的通用工具，它不是面向最终用户的，而是一个Java类库，是一款程序员可以嵌入他们所开发产品的组件

FreeMarker与Web容器无关，即在Web运行时，它并不知道Servlet或HTTP。它不仅可以用作表现层的实现技术，而且还可以用于生成XML，JSP或Java 等

在这里插入图片描述
如上是从Freemaker官网上当下来的一张流程图，详情请看Freemaker官网，但是从上我们可以看到，Freemarker 可以将模版和数据渲染成 HTML

Freemarker 模版后缀为 .ftl(FreeMarker Template Language)，FTL 是一种简单的、专用的语言，它不是像 Java 那样成熟的编程语言。无论是在模板中，还是在模板外，都可以专注于如何展现什么数据，至于他和Thymleaf有啥不同的操作，往下看

整合Freemaker

1.创建Freemaker项目

（通过Spring Initializr创建）
在这里插入图片描述

（选择Freemaker模板引擎）

在这里插入图片描述

2.pom文件依赖如下

<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>

3.和Thymleaf一样，工程创建完成后，在 org.springframework.boot.autoconfigure.freemarker.FreeMarkerAutoConfiguration 类中，可以看到关于 Freemarker 的自动化配置：

在这里插入图片描述

据上可以看出，当 classpath 下存在 freemarker.template.Configuration 以及FreeMarkerConfigurationFactory 时，配置才会生效，就是说当引入Freemarker 之后，配置就会生效。但是这里的自动化配置只做了模板位置检查，其他配置则是在导入的 FreeMarkerServletWebConfiguration 配置中完成的，接下来在看看 FreeMarkerServletWebConfiguration 类，部分源码如下：

在这里插入图片描述
那么这部分源码是什么意思呢？

@ConditionalOnWebApplication 表示当前配置在 web 环境下才会生效
ConditionalOnClass 表示当前配置在存在 Servlet 和 FreeMarkerConfigurer 时才会生效
@AutoConfigureAfter 表示当前自动化配置在 WebMvcAutoConfiguration 之后完成

对于构造方法里的FreeMarkerProperties，在这里点进去看下源码说明：
在这里插入图片描述

FreeMarkerProperties 中则配置了 Freemarker 的基本信息，例如模板位置在 classpath:/templates/ ，模板后缀为 .ftlh，其实这些配置和之前的Thymleaf一样，都可以在 application.properties 中进行修改。

4.创建User类

public class User {private String id;private String name;private String sex;public String getId() {return id;}public void setId(String id) {this.id = id;}public String getName() {return name;}public void setName(String name) {this.name = name;}public String getSex() {return sex;}public void setSex(String sex) {this.sex = sex;}
}

5.在controller层中创建StartController

@Controller
public class StartController {@GetMapping("/start")public String start(Model model){List<User> list = new ArrayList<>();User user = new User();user.setId("001");user.setName("王帅帅");user.setSex("男");User user1 = new User();user1.setId("002");user1.setName("王小帅");user1.setSex("男");User user2 = new User();user2.setId("003");user2.setName("王衰衰");user2.setSex("女");list.add(user);list.add(user1);list.add(user2);model.addAttribute("users",list);return "start";}
}

6.在 freemarker 中渲染数据 ,在resource下面新建templates目录，在templates目录下创建 start.flth文件，此处注意是后缀 .flth ,不是 .html

<!DOCTYPE html>
<html lang="en">
<head><meta charset="UTF-8"><title>Title</title>
</head>
<body>
<table border="1"><tr><td>编号</td><td>名字</td><td>性别</td></tr><#list users as user><tr><td>${user.id}</td><td>${user.name}</td><td>${user.sex}</td></tr></#list>
</table>
</body>
</html>

7.运行结果如下
在这里插入图片描述

其他配置

刚才上面说道，如果要修改模版文件位置等，可以在 application.properties 中进行配置：

spring.freemarker.allow-request-override=false
spring.freemarker.allow-session-override=false
spring.freemarker.cache=false
spring.freemarker.charset=UTF-8
spring.freemarker.check-template-location=true
spring.freemarker.content-type=text/html
spring.freemarker.expose-request-attributes=false
spring.freemarker.expose-session-attributes=false
spring.freemarker.suffix=.ftl
#spring.freemarker.suffix=.ftlh
spring.freemarker.template-loader-path=classpath:/templates/

配置文件按照顺序依次解释如下：