Freemarker——学习笔记（页面静态化）

最新推荐文章于 2023-03-24 11:07:17 发布

微醺CC

最新推荐文章于 2023-03-24 11:07:17 发布

阅读量409

点赞数

分类专栏：后端文章标签： java

本文链接：https://blog.csdn.net/qq_43680543/article/details/121771779

版权

后端专栏收录该内容

15 篇文章 0 订阅

订阅专栏

Freemarker——学习笔记（页面静态化）

一、介绍
二、快速入门

一、介绍

FreeMarker 是一款模板引擎一种基于模板和要改变的数据，并用来生成输出文本(HTML网页，电子邮件，配置文件，源代码等)的通用工具。

二、快速入门

2.1 依赖

普通的maven项目添加依赖坐标：

<!-- freemarker 的 Maven 坐标 -->
<dependency>
  <groupId>org.freemarker</groupId>
  <artifactId>freemarker</artifactId>
  <version>2.3.23</version>
</dependency>

spring boot 项目添加的依赖：

<!-- spring boot 整合 freemarker的起步依赖 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-freemarker</artifactId>
</dependency>

application.yml全局配置文件（部分配置）

#Spring配置
spring:
  #freemark相关配置
  freemarker:
    cache: false #是否启用模板缓存（开发时关闭，上线时开启）
    charset: UTF-8 #模板编码。
    template-loader-path: classpath:/templates/ftl #模板路径
    suffix: .ftl #模板后缀
    content-type: text/html #内容类型值。
    check-template-location: true #是否检查模板位置是否存在

2.2 创建模板文件

模板文件中有四种元素：
1、文本，直接输出的部分；
2、注释，即<#--...-->格式不会输出；
3、插值（Interpolation）：即${..}部分,将使用数据模型中的部分替代输出；
4、FTL指令：FreeMarker指令，和HTML标记类似，名字前加#予以区分，不会输出；

Freemarker的模板文件后缀可以任意，一般建议为 .ftl。

例如：在项目资源目录下的 /templates/ftl 目录，在ftl目录中创建名称为 freemarker_test.ftl 的模板文件，内容如下：

<html>
<head>
    <meta charset="utf-8">
    <title>Freemarker入门</title>
</head>
<body>
    <#--我只是一个注释，我不会有任何输出  -->
    ${name}你好，${message}
</body>
</html>

2.3 生成静态文件

使用步骤：

第一步：创建一个 Configuration 对象，直接 new 一个对象。构造方法的参数就是 freemarker的版本号。
第二步：设置模板文件所在的路径。
第三步：设置模板文件使用的字符集。一般就是 utf-8。
第四步：加载一个模板，创建一个模板对象。
第五步：创建一个模板使用的数据集，可以是 pojo 也可以是 map。一般是 Map。
第六步：创建一个 Writer 对象，一般创建 FileWriter 对象，指定生成的文件名。
第七步：调用模板对象的 process 方法输出文件。
第八步：关闭流。

@Test
void generateStaticHtml() throws IOException, TemplateException {
    //1.创建配置类
    Configuration configuration = new Configuration(Configuration.getVersion());
    //2.设置模板所在的目录
    ClassPathResource resource = new ClassPathResource("/templates/ftl");
    String templPath = resource.getFile().getAbsolutePath();//模板存放文件夹的绝对路径
    configuration.setDirectoryForTemplateLoading(new File(templPath));
    //3.设置字符集
    configuration.setDefaultEncoding("utf-8");
    //4.加载模板
    Template template = configuration.getTemplate("freemarker_test.ftl");
    //5.创建数据模型
    Map<String,Object> objectMap = new HashMap<>();
    objectMap.put("name","张三");
    objectMap.put("message","欢迎来到湖北大学！");
    //6.创建Writer对象
    Writer out = new FileWriter("E:\\Desktop\\tempFile\\freemarker_test.html");
    //7.输出
    template.process(objectMap,out);
    //8.关闭Writer对象
    out.close();
}