3.SpringBoot整合Thymeleaf模板

一、前言

SrpingBoot支持如JSP、Thymeleaf、FreeMarker、Mustache、Velocity等各种模板引擎，同时还为开发者提供了自定义模板扩展的支持。

使用嵌入式Servlet容器时，请避免使用JSP，因为使用JSP打包后会存在一些限制。

在SpringBoot使用上述模板，默认从src/main/resources/templates下加载。

二、thymeleaf介绍

Thymeleaf是现代化服务器端的Java模板引擎，不同与其它几种模板的是Thymeleaf的语法更加接近HTML，并且具有很高的扩展性。详细资料可以浏览官网。

特点

支持无网络环境下运行，由于它支持 html 原型，然后在 html 标签里增加额外的属性来达到模板+数据的展示方式。浏览器解释 html 时会忽略未定义的标签属性，所以 thymeleaf 的模板可以静态地运行；当有数据返回到页面时，Thymeleaf 标签会动态地替换掉静态内容，使页面动态显示。所以它可以让前端小姐姐在浏览器中查看页面的静态效果，又可以让程序员小哥哥在服务端查看带数据的动态页面效果。
开箱即用，为Spring提供方言，可直接套用模板实现JSTL、 OGNL表达式效果，避免每天因套用模板而修改JSTL、 OGNL标签的困扰。同时开发人员可以扩展自定义的方言。
SpringBoot官方推荐模板，提供了可选集成模块(spring-boot-starter-thymeleaf)，可以快速的实现表单绑定、属性编辑器、国际化等功能。

三、使用

3.1 首先要在`pom.xml`中添加对`thymeleaf`模板依赖

1 <dependency>
2     <groupId>org.springframework.boot</groupId>
3     <artifactId>spring-boot-starter-thymeleaf</artifactId>
4 </dependency>
5 <dependency>
6   <groupId>org.springframework.boot</groupId>
7   <artifactId>spring-boot-starter-web</artifactId>
8 </dependency>

3.2 添加完`thymeleaf`模板依赖的pom.xml文件内容如下

 1 <?xml version="1.0" encoding="UTF-8"?>
 2 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 3     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 4     <modelVersion>4.0.0</modelVersion>
 5 
 6     <groupId>cn.kgc</groupId>
 7     <artifactId>springboot1</artifactId>
 8     <version>0.0.1-SNAPSHOT</version>
 9     <packaging>jar</packaging>
10 
11     <name>springboot1</name>
12     <description>我用的第一个maven工程</description>
13 
14 
15     <!--版本采用的是最新的 2.0.1.RELEASE
16     TODO 开发中请记得版本一定要选择 RELEASE ，因为是稳定版本且BUG少-->
17     <parent>
18         <groupId>org.springframework.boot</groupId>
19         <artifactId>spring-boot-starter-parent</artifactId>
20         <version>2.0.5.RELEASE</version>
21         <relativePath/> <!-- lookup parent from repository -->
22     </parent>
23 
24     <properties>
25         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
26         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
27         <java.version>1.8</java.version>
28     </properties>
29 
30     <dependencies>
31 
32         <!--模块(spring-boot-starter-thymeleaf)，可以快速的实现表单绑定、属性编辑器、国际化等功能。-->
33         <dependency>
34             <groupId>org.springframework.boot</groupId>
35             <artifactId>spring-boot-starter-thymeleaf</artifactId>
36         </dependency>
37         <!-- 默认就内嵌了Tomcat 容器，如需要更换容器也极其简单-->
38         <dependency>
39             <groupId>org.springframework.boot</groupId>
40             <artifactId>spring-boot-starter-web</artifactId>
41         </dependency>
42         <!-- 测试包,当我们使用 mvn package 的时候该包并不会被打入,因为它的生命周期只在 test 之内-->
43         <dependency>
44             <groupId>org.springframework.boot</groupId>
45             <artifactId>spring-boot-starter-test</artifactId>
46             <scope>test</scope>
47         </dependency>
48         <!--该依赖可以不添加，但是在 IDEA 和 STS 中不会有属性提示，
49         没有提示的配置就跟你用记事本写代码一样苦逼，出个问题弄哭你去-->
50         <dependency>
51             <groupId>org.springframework.boot</groupId>
52             <artifactId>spring-boot-configuration-processor</artifactId>
53             <optional>true</optional>
54         </dependency>
55     </dependencies>
56 
57     <build>
58         <plugins>
59             <!-- 编译插件 -->
60             <plugin>
61                 <groupId>org.springframework.boot</groupId>
62                 <artifactId>spring-boot-maven-plugin</artifactId>
63             </plugin>
64         </plugins>
65     </build>
66 
67 
68 </project>

3.3 创建ThymeleafController.java

创建一个ThymeleafController用来映射HTTP请求与页面的跳转，下面写了两种方式，第一种比较直观和优雅，第二种相对普遍且代码较少，且迎合从struts2跳坑的朋友们…

Spring4.3以后为简化@RequestMapping(method = RequestMethod.XXX)的写法，故而将其做了一层包装，也就是现在的GetMapping、PostMapping、PutMapping、DeleteMapping、PatchMapping

 1 package cn.kgc.controller;
 2 import org.springframework.stereotype.Controller;
 3 import org.springframework.web.bind.annotation.GetMapping;
 4 import org.springframework.web.bind.annotation.RequestMapping;
 5 import org.springframework.web.servlet.ModelAndView;
 6 import javax.servlet.http.HttpServletRequest;
 7 /**
 8  * ThymeleafController用来映射HTTP请求与页面的跳转
 9  */
10 @Controller
11 @RequestMapping
12 public class ThymeleafController {
13     /**
14      * 方法1:返回ModelAndView对象，
15      * 将视图名称封装到该对象的viewName属性中
16      * 将页面所需要的数据封装到该对象的addObject对象中
17      * @return
18      */
19     @GetMapping("/index.do")
20     public ModelAndView index() {
21         ModelAndView view = new ModelAndView();
22         // 设置跳转的视图 默认映射到 src/main/resources/templates/{viewName}.html
23         view.setViewName("index");
24         // 设置属性
25         view.addObject("title", "我的第一个ThymeleafWEB页面");
26         view.addObject("desc", "欢迎进入课工场学习");
27         Teacher teacher=new Teacher(1,"Holly","964918306","北大青鸟-南京中博软件学院-课工场");
28         view.addObject("teacher", teacher);
29         return view;
30     }
31 
32     @GetMapping("/index1")
33     public String index1(HttpServletRequest request) {
34         // TODO 与上面的写法不同，但是结果一致。
35         // 设置属性
36         Teacher teacher=new Teacher(1,"Holly","964918306","北大青鸟-南京中博软件学院-课工场");
37         request.setAttribute("teacher", teacher);
38         request.setAttribute("title", "我的第一个ThymeleafWEB页面");
39         request.setAttribute("desc", "欢迎进入课工场学习");
40         // 返回的 index 默认映射到 src/main/resources/templates/xxxx.html
41         return "index";
42     }
43 
44     class Teacher {
45         private int tid;
46         private String tname;
47         private String qq;
48         private String address;
49 
50         public Teacher() {
51         }
52 
53         public Teacher(int tid, String tname, String qq, String address) {
54             this.tid = tid;
55             this.tname = tname;
56             this.qq = qq;
57             this.address = address;
58         }
59 
60         public int getTid() {
61             return tid;
62         }
63 
64         public void setTid(int tid) {
65             this.tid = tid;
66         }
67 
68         public String getTname() {
69             return tname;
70         }
71 
72         public void setTname(String tname) {
73             this.tname = tname;
74         }
75 
76         public String getQq() {
77             return qq;
78         }
79 
80         public void setQq(String qq) {
81             this.qq = qq;
82         }
83 
84         public String getAddress() {
85             return address;
86         }
87 
88         public void setAddress(String address) {
89             this.address = address;
90         }
91     }
92 }

3.4 创建`index.html`的模板文件

在src/main/resources/templates目录下创建一个名index.html的模板文件，可以看到thymeleaf是通过在标签中添加额外属性动态绑定数据的

 1 <!DOCTYPE html>
 2 <html xmlns="http://www.w3.org/1999/xhtml"
 3       xmlns:th="http://www.thymeleaf.org">
 4 <head>
 5     <meta charset="UTF-8">
 6     <!-- 可以看到 thymeleaf 是通过在标签里添加额外属性来绑定动态数据的 -->
 7     <!--/*@thymesVar id="title" type=""*/-->
 8     <title th:text="${title}">Title</title>
 9     <!-- 在/resources/static/js目录下创建一个hello.js 用如下语法依赖即可-->
10     <script type="text/javascript" th:src="@{/js/hello.js}"></script>
11 </head>
12 <body>
13 <h1 th:text="${desc}">Hello World</h1>
14 <h2>=====作者信息=====</h2>
15 <p th:text="${teacher.tid}"></p>
16 <p th:text="${teacher.tname}"></p>
17 <p th:text="${teacher.qq}"></p>
18 <p th:text="${teacher.address}"></p>
19 </body>
20 </html>