SpringBoot-使用Freemarker

Freemarker 简介

这是一个老牌的开源的免费的模版引擎。
通过 Freemarker 模版，我们可以将数据渲染成 HTML 网页、电子邮件、配置文件以及源代码等。
Freemarker 不是面向最终用户的，而是一个 Java 类库，我们可以将之作为一个普通的组件嵌入到我们的产品中。
Freemarker 官方图片：

可以看到，Freemarker 可以将模版和数据渲染成 HTML 。
Freemarker 模版后缀为 .ftl (FreeMarker Template Language)。FTL 是一种简单的、专用的语言，它不是像 Java 那样成熟的编程语言。在模板中，你可以专注于如何展现数据，而在模板之外可以专注于要展示什么数据。

整合

SpringBoot整合Freemarker也非常简单，首先我们在项目中加入Freemarker和web的起步依赖

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

工程创建完成后，在 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(proxyBeanMethods = false)
@ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET)
@ConditionalOnClass({ Servlet.class, FreeMarkerConfigurer.class })
@AutoConfigureAfter(WebMvcAutoConfiguration.class)
class FreeMarkerServletWebConfiguration extends AbstractFreeMarkerConfiguration {
  protected FreeMarkerServletWebConfiguration(FreeMarkerProperties properties) {
        super(properties);
    }
  ...
}

看下这段源码:

@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 = ".ftlh";

    /**
     * Well-known FreeMarker keys which are passed to FreeMarker's Configuration.
     */
    private Map<String, String> settings = new HashMap<>();
    ...
}

FreeMarkerProperties 中可以看出配置了 Freemarker 的基本信息，例如模板位置在 classpath:/templates/ ，再例如模板后缀为 .ftl ，那么这些配置我们以后都可以在application.properties 中进行修改，如果我们在 SSM 的 XML 文件中自己配置 Freemarker ，也不过就是配置这些东西。现在，这些配置由 FreeMarkerServletWebConfiguration 帮我们完成了。

测试

首先我们来创建一个 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<User> users = new ArrayList<>();
        for (int i = 0; i < 10; i++) {
            User user = new User();
            user.setId(i);
            user.setUsername("用户名" + i);
            user.setAddress("地址" + i);
            users.add(user);
        }
        model.addAttribute("users", users);
        return "index";
    }
}

最后在freemarker中渲染数据，在templates文件夹下新增index.ftlh文件(注意，Springboot2.2.7版本中，默认后缀名为ftlh)：

<!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.username}</td>
            <td>${user.address}</td>
        </tr>
    </#list>
  </table>
</body>
</html>

启动项目打开浏览器，访问http://localhost:8082/index效果如下：

当然，我们也可以进行一些自定义配置，例如：

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中 8. 是否将HttpSession中的属性添加到Model中
模板文件后缀
模板文件位置