Spring Boot 整合 Thymeleaf

Thymeleaf 简介

 

概述

Thymeleaf 是一个跟 Velocity、FreeMarker 类似的模板引擎，它可以完全替代 JSP 。相较与其他的模板引擎，它有如下三个极吸引人的特点

• Thymeleaf 在有网络和无网络的环境下皆可运行，即它可以让美工在浏览器查看页面的静态效果，也可以让程序员在服务器查看带数据的动态页面效果。这是由于它支持 html 原型，然后在 html 标签里增加额外的属性来达到模板 + 数据的展示方式。浏览器解释 html 时会忽略未定义的标签属性，所以 thymeleaf 的模板可以静态地运行；当有数据返回到页面时，Thymeleaf 标签会动态地替换掉静态内容，使页面动态显示。

.jsp

    ${user.name}

.html

    ${username}">zhao

    th:text="${username}"

• Thymeleaf 开箱即用的特性。它提供标准和 Spring 标准两种方言，可以直接套用模板实现 JSTL、 OGNL 表达式效果，避免每天套模板、改 JSTL、改标签的困扰。同时开发人员也可以扩展和创建自定义的方言。
• Thymeleaf 提供 Spring 标准方言和一个与 SpringMVC 完美集成的可选模块，可以快速的实现表单绑定、属性编辑器、国际化等功能。

 

为什么使用 Thymeleaf

 

概述

如果希望以 Jar 形式发布模块则尽量不要使用 JSP 相关知识，这是因为 JSP 在内嵌的 Servlet 容器上运行有一些问题 (内嵌 Tomcat、 Jetty 不支持 Jar 形式运行 JSP，Undertow 不支持 JSP)。

Spring Boot 中推荐使用 Thymeleaf 作为模板引擎，因为 Thymeleaf 提供了完美的 Spring MVC 支持

Spring Boot 提供了大量模板引擎，包括：

• FreeMarker
• Groovy
• Mustache
• Thymeleaf
• Velocity
• Beetl

 

第一个 Thymeleaf 模板页

 

引入依赖

主要增加 spring-boot-starter-thymeleaf 和 nekohtml 这两个依赖

• spring-boot-starter-thymeleaf：Thymeleaf 自动配置
• nekohtml：允许使用非严格的 HTML 语法

完整的 pom.xml 如下：

    4.0.0

    com.funtl
    hello-spring-boot
    0.0.1-SNAPSHOT
    jar

    hello-spring-boot
    

    
        org.springframework.boot
        spring-boot-starter-parent
        2.0.2.RELEASE
         
    

    
        UTF-8
        UTF-8
        1.8
    

    
        
            org.springframework.boot
            spring-boot-starter-web
        
        
            org.springframework.boot
            spring-boot-starter-tomcat
        
        
            org.springframework.boot
            spring-boot-starter-thymeleaf
        
        
            org.springframework.boot
            spring-boot-starter-actuator
        
        
            org.springframework.boot
            spring-boot-starter-test
            test
        

//重要加入///
        
            net.sourceforge.nekohtml
            nekohtml
            1.9.22
        


    

    
        
            
                org.springframework.boot
                spring-boot-maven-plugin
                
                    com.funtl.hello.spring.boot.HelloSpringBootApplication
                
            
        
    

在 application.yml 中配置 Thymeleaf

spring:
  thymeleaf:
    cache: false # 开发时关闭缓存,不然没法看到实时页面
    mode: HTML # 用非严格的 HTML
    encoding: UTF-8
    servlet:
      content-type: text/html

创建测试用 JavaBean

创建一个测试效果的 JavaBean，简单封装一下即可,在entity包下的User类

package com.funtl.hello.spring.boot.thymeleaf.entity;

import java.io.Serializable;

public class User implements Serializable {
    private String username;

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }
}

创建测试用 Controller

创建一个 Controller，造一些测试数据并设置跳转，在controller包下的MainController类

package com.funtl.hello.spring.boot.thymeleaf.controller;

import com.funtl.hello.spring.boot.thymeleaf.entity.User;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

@Controller
public class MainController {

    @RequestMapping(value = {"","index"},method = RequestMethod.GET)
    public String index(Model model){
        User user=new User();
        user.setUsername("zhao");

        model.addAttribute("user",user);
        return "index";
    }
}

创建测试页面

在 templates 目录下创建 index.html 文件，代码如下：

    
    


    张三

修改 html 标签用于引入 thymeleaf 引擎，这样才可以在其他标签里使用 th:* 语法，声明如下：

测试访问

启动成功后，访问：http://localhost:8080 即可看到效果