今天來聊聊 Spring Boot 整合 Freemarker。

Freemarker 簡介

這是一個相當老牌的開源的免費的模版引擎。通過 Freemarker 模版，我們可以將數據渲染成 HTML 網頁、電子郵件、配置文件以及源代碼等。Freemarker 不是面向最終用戶的，而是一個 Java 類庫，我們可以將之作為一個普通的組件嵌入到我們的產品中。

來看一張來自 Freemarker 官網的圖片：

可以看到，Freemarker 可以將模版和數據渲染成 HTML 。

Freemarker 模版后綴為 .ftl(FreeMarker Template Language)。FTL 是一種簡單的、專用的語言，它不是像 Java 那樣成熟的編程語言。在模板中，你可以專注于如何展現數據， 而在模板之外可以專注于要展示什么數據。

好了，這是一個簡單的介紹，接下來我們來看看 Freemarker 和 Spring Boot 的一個整合操作。

實踐

在 SSM 中整合 Freemarker ，所有的配置文件加起來，前前后后大約在 50 行左右，Spring Boot 中要幾行配置呢？0 行！

1.創建工程

首先創建一個 Spring Boot 工程，引入 Freemarker 依賴，如下圖：

<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-freemarkerartifactId>
dependency>
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-webartifactId>
dependency>

工程創建完成后，在 org.springframework.boot.autoconfigure.freemarker.FreeMarkerAutoConfiguration 類中，可以看到關于 Freemarker 的自動化配置：

@Configuration
@ConditionalOnClass({ freemarker.template.Configuration.class, FreeMarkerConfigurationFactory.class })
@EnableConfigurationProperties(FreeMarkerProperties.class)
@Import({ FreeMarkerServletWebConfiguration.class, FreeMarkerReactiveWebConfiguration.class,
FreeMarkerNonWebConfiguration.class })
public class FreeMarkerAutoConfiguration {
}

從這里可以看出，當 classpath 下存在 freemarker.template.Configuration 以及 FreeMarkerConfigurationFactory 時，配置才會生效，也就是說當我們引入了 Freemarker 之后，配置就會生效。但是這里的自動化配置只做了模板位置檢查，其他配置則是在導入的 FreeMarkerServletWebConfiguration 配置中完成的。那么我們再來看看 FreeMarkerServletWebConfiguration 類，部分源碼如下：

@Configuration
@ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET)
@ConditionalOnClass({ Servlet.class, FreeMarkerConfigurer.class })
@AutoConfigureAfter(WebMvcAutoConfiguration.class)
class FreeMarkerServletWebConfiguration extends AbstractFreeMarkerConfiguration {
protected FreeMarkerServletWebConfiguration(FreeMarkerProperties properties) {
super(properties);
}
@Bean
@ConditionalOnMissingBean(FreeMarkerConfig.class)
public FreeMarkerConfigurer freeMarkerConfigurer() {
FreeMarkerConfigurer configurer = new FreeMarkerConfigurer();
applyProperties(configurer);
return configurer;
}
@Bean
@ConditionalOnMissingBean(name = "freeMarkerViewResolver")
@ConditionalOnProperty(name = "spring.freemarker.enabled", matchIfMissing = true)
public FreeMarkerViewResolver freeMarkerViewResolver() {
FreeMarkerViewResolver resolver = new FreeMarkerViewResolver();
getProperties().applyToMvcViewResolver(resolver);
return resolver;
}
}

我們來簡單看下這段源碼：

@ConditionalOnWebApplication 表示當前配置在 web 環境下才會生效。

ConditionalOnClass 表示當前配置在存在 Servlet 和 FreeMarkerConfigurer 時才會生效。

@AutoConfigureAfter 表示當前自動化配置在 WebMvcAutoConfiguration 之后完成。

代碼中，主要提供了 FreeMarkerConfigurer 和 FreeMarkerViewResolver。

FreeMarkerConfigurer 是 Freemarker 的一些基本配置，例如 templateLoaderPath、defaultEncoding 等

FreeMarkerViewResolver 則是視圖解析器的基本配置，包含了viewClass、suffix、allowRequestOverride、allowSessionOverride 等屬性。

另外還有一點，在這個類的構造方法中，注入了 FreeMarkerProperties：

@ConfigurationProperties(prefix = "spring.freemarker")
public class FreeMarkerProperties extends AbstractTemplateViewResolverProperties {
public static final String DEFAULT_TEMPLATE_LOADER_PATH = "classpath:/templates/";
public static final String DEFAULT_PREFIX = "";
public static final String DEFAULT_SUFFIX = ".ftl";
/**
* Well-known FreeMarker keys which are passed to FreeMarker's Configuration.
*/
private Map settings = new HashMap<>();
}

FreeMarkerProperties 中則配置了 Freemarker 的基本信息，例如模板位置在 classpath:/templates/ ，再例如模板后綴為 .ftl，那么這些配置我們以后都可以在 application.properties 中進行修改。

如果我們在 SSM 的 XML 文件中自己配置 Freemarker ，也不過就是配置這些東西。現在，這些配置由 ?FreeMarkerServletWebConfiguration ?幫我們完成了。

2.創建類

首先我們來創建一個 User 類，如下：

public class User {
private Long id;
private String username;
private String address;
//省略 getter/setter
}

再來創建 UserController：

@Controller
public class UserController {
@GetMapping("/index")
public String index(Model model) {
List users = new ArrayList<>();for (int i = 0; i < 10; i++) {
User user = new User();
user.setId((long) i);
user.setUsername("javaboy>>>>" + i);
user.setAddress("www.javaboy.org>>>>" + i);
users.add(user);
}
model.addAttribute("users", users);return "index";
}
}

最后在 freemarker 中渲染數據：

<html lang="en"><head><meta charset="UTF-8"><title>Titletitle>head><body><table border="1"><tr><td>用戶編號td><td>用戶名稱td><td>用戶地址td>tr><#list users as user><tr><td>${user.id}td><td>${user.username}td><td>${user.address}td>tr>#list>table>body>html>

運行效果如下：

其他配置

如果我們要修改模版文件位置等，可以在 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.template-loader-path=classpath:/templates/

配置文件按照順序依次解釋如下：

HttpServletRequest的屬性是否可以覆蓋controller中model的同名項

HttpSession的屬性是否可以覆蓋controller中model的同名項

是否開啟緩存

模板文件編碼

是否檢查模板位置

Content-Type的值

是否將HttpServletRequest中的屬性添加到Model中

是否將HttpSession中的屬性添加到Model中

模板文件后綴

模板文件位置

好了，整合完成之后，Freemarker 的更多用法，就和在 SSM 中使用 Freemarker 一樣了，這里我就不再贅述。

結語

本文和大家簡單聊一聊 Spring Boot 整合 Freemarker，算是對 Spring Boot2 教程的一個補充(后面還會有一些補充)，有問題歡迎留言討論。

本項目案例，我已經上傳到 GitHub 上，歡迎大家 star：https://github.com/lenve/javaboy-code-samples

1、Spring Boot2 系列教程(一)純 Java 搭建 SSM 項目

2、Spring Boot2 系列教程(二)創建 Spring Boot 項目的三種方式

3、Spring Boot2 系列教程(三)理解 spring-boot-starter-parent

4、Spring Boot2 系列教程(四)理解配置文件 application.properties ！

5、Spring Boot2 系列教程(五)Spring Boot中的 yaml 配置

6、Spring Boot2 系列教程(六)自定義 Spring Boot 中的 starter7、Spring Boot2 系列教程(七)理解自動化配置的原理8、Spring Boot2 系列教程(八)Spring Boot 中配置 Https9、Spring Boot2 系列教程(九)Spring Boot 整合 Thymeleaf

喜歡就點個"在看"唄^_^

總結

以上是生活随笔為你收集整理的freemarker ftl模板_Spring Boot2 系列教程(十)Spring Boot 整合 Freemarker的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。