Spring Boot 整合 FreeMarker 实例分享

目录

• 一、前言
• 二、FreeMarker 简介
• 三、准备工作
• 环境准备
• 添加 FreeMarker 依赖
• 添加 FreeMarker 相关配置
• 四、编写实体类和 Controller
• 编写实体类
• 编写 Controller
• 数据渲染
• 五、总结

一、前言

在之前的文章Spring Boot 整合 Thymeleaf 实例分享中，我们学习了如何将模板 Thymeleaf 整合到 Spring Boot 中，那今天我们就来看看，另一个老牌的开源免费模板引擎 - FreeMarker！

二、FreeMarker 简介

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

以上就是出自 FreeMarker 的官方定义，我们通过使用 FreeMarker，可以将我们所需的模板何数据渲染成 HTML，从而实现我们想要的效果。通过将模板与数据分开，让分工更加明确，模板方面则专注于如何将数据进行展现，而在数据方面，我们就可以专注于展示何种数据，下图就是我们以上所描述的 FreeMarker 的功能。

那接下来，我们就来看看，如何将 FreeMarker 像 Thymeleaf 一样整合到我们的 Spring Boot 中，让我们的开发更加简单。

三、准备工作

环境准备

正式开始之前，依然给出本文所基于的环境，避免环境问题可能给大家带来的影响。

• JDK 17（理论上推荐不低于 1.8 版本）
• IDEA
• SpringBoot 2.x

添加 FreeMarker 依赖

开始之前，我们需要添加 FreeMarker 的相关依赖，同样这里我们可以选择两种方式。一种是在创建项目时就添加上，另一种则是创建项目后在项目 pom.xml 文件中手动添加，接下来我们分别来看看两种不同的方式应该如何添加。如果还不清楚如何创建 Spring Boot 项目，可以参照我之前的一篇文章：Spring Boot 教程之创建项目的三种方式

• 第一种

在使用 IDEA 创建 Spring Boot 新项目时，添加依赖时将模板引擎中的 Apache FreeMarker 勾选上。

2.第二种

如果在创建时未添加 FreeMarker 模板引擎依赖，或者在项目开始创建之初并未有此需求，但后续过程中又增加了该需求，则此时可以直接在项目 pom.xml 中手动添加 FreeMarker 依赖即可。

    org.springframework.boot
    spring-boot-starter-freemarker

添加 FreeMarker 相关配置

添加依赖后，我们需要在项目配置文件 application.yml 中添加 FreeMarker 的相关配置。

spring:
  freemarker:
    # 模板后缀名
    suffix: .ftl
    # 文档类型
    content-type: text/html
    # 页面编码
    charset: UTF-8
    # 页面缓存
    cache: false
    # 模板路径
    template-loader-path: classpath:/templates/

四、编写实体类和 Controller

编写实体类

创建一个 User 类，并将其各种 setter、getter、构造方法等完成，这里我依然使用了 Lombok 插件，以便简化我们的代码。关于该插件的更多用法，可以参照我之前的文章：Lombok 安装和使用小技巧

package com.cunyu.springbootfreemarkerdemo.entity;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.springframework.stereotype.Component;
@Component
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    private int age;
    private String name;
    private String email;
}

编写 Controller

这里我们创建一个 User 对象，然后设置其年龄、Email、姓名等相关信息，然后将其加到属性中，方便传输到前端进行展示。

package com.cunyu.springbootfreemarkerdemo.controller;
import com.cunyu.springbootfreemarkerdemo.entity.User;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;

@Controller
public class UserController {
    @GetMapping("/index")
    public String index(Model model) {
        User user = new User();
        user.setAge(26);
        user.setEmail("[email protected]");
        user.setName("村雨遥");
        model.addAttribute("user", user);
        return "index";
    }
}

数据渲染

当完成实体类和 Controller 编写后，我们就可以利用模板来进行展示了。我们在项目的 resources/templates 路进行新建一个 index.ftl 文件，注意这里文件名要保持和 Controller 中 index 方法所返回的字符串一致。

    
    


    

        

            
姓名
            
年龄
            
Email
        
        

            
${user.name}
            
${user.age}
            
${user.email}
        
    

五、总结

我们可以结合之前的文章：Spring Boot 整合 Thymeleaf 实例分享共同阅读，对比 Thymeleaf 和 FreeMarker 在整合过程中的一些共同点和不同点，相信你会有更多的收获。

到此这篇关于Spring Boot 整合 FreeMarker 实例分享的文章就介绍到这了,更多相关Spring Boot 整合 FreeMarker 内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！