博主
258
258
258
258
标签
elasticsearch kibana LayUI rabbitmq Vue3 springboot linux jdk centos
专辑

第五节 SpringBoot项目中集成Freemarker模板

亮子 2022-12-31 03:09:51 17389 0 0 0

1、FreeMarker模版介绍

1）、简介

FreeMarker 是 免费的， 基于Apache许可证2.0版本发布。

## 官方网站
https://freemarker.apache.org/

## 中文网站
http://freemarker.foofun.cn/

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

模板编写为FreeMarker Template Language (FTL)。它是简单的，专用的语言， 不是 像PHP那样成熟的编程语言。 那就意味着要准备数据在真实编程语言中来显示，比如数据库查询和业务运算， 之后模板显示已经准备好的数据。在模板中，你可以专注于如何展现数据， 而在模板之外可以专注于要展示什么数据。

图片alt

2）、特点

目前企业中:主要用Freemarker做静态页面或是页面展示

FreeMarker的模板文件并不比HTML页面复杂多少，FreeMarker模板文件主要由如下4个部分组成:
（1）文本:直接输出的部分
（2）注释:<#-- … -->格式部分,不会输出
（3）插值:即${…}或#{…}格式的部分,将使用数据模型中的部分替代输出
（4）FTL指令:FreeMarker指定,和HTML标记类似,名字前加#予以区分,不会输出

2、SpringBoot项目中集成

1）、添加依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-freemarker</artifactId>
</dependency>

2）、修改配置文件

## freemarker 设置
# 是否允许HttpServletRequest属性覆盖(隐藏)控制器生成的同名模型属性。
spring.freemarker.allow-request-override=false
# 是否允许HttpSession属性覆盖(隐藏)控制器生成的同名模型属性。
spring.freemarker.allow-session-override=false
# 是否启用模板缓存。
spring.freemarker.cache=false
# 模板编码。
spring.freemarker.charset=UTF-8
# 是否检查模板位置是否存在。
spring.freemarker.check-template-location=true
# Content-Type value.
spring.freemarker.content-type=text/html
# 是否启用freemarker
spring.freemarker.enabled=true
# 设定所有request的属性在merge到模板的时候，是否要都添加到model中.
spring.freemarker.expose-request-attributes=false
# 是否在merge模板的时候，将HttpSession属性都添加到model中
spring.freemarker.expose-session-attributes=false
# 设定是否以springMacroRequestContext的形式暴露RequestContext给Spring’s macro library使用
spring.freemarker.expose-spring-macro-helpers=true
# 是否优先从文件系统加载template，以支持热加载，默认为true
spring.freemarker.prefer-file-system-access=true
# 设定模板的后缀.
spring.freemarker.suffix=.ftl
# 设定模板的加载路径，多个以逗号分隔，默认:
spring.freemarker.template-loader-path=classpath:/templates/
# 设定FreeMarker keys.
spring.freemarker.settings.template_update_delay=0
spring.freemarker.settings.default_encoding=UTF-8
spring.freemarker.settings.classic_compatible=true

3）、编写controller

package com.shenmazong.demonew.controller;


import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;

import java.util.LinkedHashMap;
import java.util.Map;

@Controller
@Slf4j
public class FreemarkerController {
    @GetMapping("/free")
    public String index(Model model) {

        Map map = new LinkedHashMap<>();
        for (int i = 0; i < 5; i++) {
            map.put("key" + i, "value" + i);
        }

        model.addAttribute("map", map);

        return "index";
    }
}

4）、编写模板文件

在templates目录下编写index.ftl模板文件，内容如下：

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<h1>Hello boy,</h1><br>
<p>当前时间：${.now?string("yyyy-MM-dd HH:mm:ss.sss")}</p>

<br/>
<#list map?keys as key>
    <div>${map[key]}, 索引：${key_index }，hasNext：${key_has_next}</div>
</#list>

</body>
</html>

通过以上4个步骤，运行后访问，出现如下图，则在SpringBoot中集成Freemarker就已经大功告成了。

图片alt