畅游Spring Boot系列 — SpingBoot Thymeleaf模板引擎
一.模板引擎的基本概念
首先,Thymeleaf模板引擎是什么,简单来说,我们的Web工程肯定要生成动态的页面,之前我们使用JSP,要在页面上显示后台数据的时候使用<% %>或者JSTL调用后台数据,也就是后台直接生成HTML页面+数据的页面,直接传送到前台显示,JSP就是我们接触到的一个模板引擎.
总而言之一句话:模板引擎在服务器端将模板和数据合成，返回最终的html页面,常见的模板引擎有freemarker、velocity、thymeleaf等
对于SpringBoot来说官方建议的模板引擎是Thymeleaf,其实和我们喜闻乐见的JSP相比,就是把<%%>换成了Thymeleaf的标记而已.
二.SpringBoot中Thymeleaf的默认配置
我们先来看一下以前我们在Spring MVC的Controller中最常见的一段代码
@RequestMapping(value="/v", method=RequestMethod.GET)public String success() { return "success"; }
这段代码的意思,相信熟悉Spring MVC的你,都应该知道,无非就是页面输入/v,Spring MVC的视图解析器就会找到返回值success,这里的返回值其实就应该是我们已经在Spring MVC配置文件中配置好的哪个文件夹下的以success开头,并且以相关后缀结束的文件,比如: xxx/xxx/success.html
所以针对于SpringBoot,这些东西肯定是已经配置好了的,不过一定要记住,我们的SpringBoot是约定大于配置的.
首先,SpringBoot支持的后台模板引擎不再是JSP,而是Thymeleaf
其次,Thymeleaf的相关配置也已经是约定好了的org.springframework.boot.autoconfigure.thymeleaf.ThymeleafProperties
在这个类中有很关键的两句配置代码
public static final String DEFAULT_PREFIX = "classpath:/templates/";public static final String DEFAULT_SUFFIX = ".html";
默认所有的模板文件,都应该放在类资源下的templates文件夹
默认所有的模板文件,都应该以.html后缀结尾
三.Thymeleaf的使用
当然,我们现在如果只是在Controller中这么写是没有任何作用的,我们还需要按照约定做以下几步
- 配置pom.xml,加载
thymeleaf的starter
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-thymeleaf</artifactId></dependency>
- 在工程的
resources资源文件夹下创建templates文件夹,所有的模板文件都应该放在这个文件夹下面 - 创建.html模板文件,其实和一般的html没区别,但是最好在html文件开头添加上Thymeleaf的名称空间,不导入其实也没影响,不过在写页面的时候,就没有提示了
<html lang="en" xmlns:th=" http://www.thymeleaf.org">
现在工程的结构,基本上是这个样子:
现在的HTML页面也很简单,除了添加的一句代码,和一般的HTML页面任何区别
我们写一段简单代码来测试一下,首先修改HelloController.java文件
HelloController.java
@Controllerpublic class HelloController { @RequestMapping(value="/v", method=RequestMethod.GET) public String success(Model model) { model.addAttribute("username", "SpringBoot"); return "success"; } }
在HelloController的代码中,我添加了Model对象参数,往页面传值username,接下来,我们在success.html页面,使用Thymeleaf的语法来接收参数
success.html
<!DOCTYPE html><html lang="en" xmlns:th=" http://www.thymeleaf.org"><head><meta charset="UTF-8" /><title>Insert title here</title></head><body><h1>成功!</h1>你好:<span th:text="${username}"></span></body></html>
页面显示:
正确得到了Controller中传递的值,这里使用Thymeleaf的语法th:text="${xxx}"
四.Thymeleaf 3
按照我的例子走下去,如果稍微不留意,估计你的页面就会报错,错误页面大概是这个样子
意思是success页面第6行有错误,success页面不是我们的模板页面吗?而且第6行我们也没有写什么东西啊,为啥会报错?
注意,这其实是thymeleaf自身的问题,在thymeleaf 2.x版本,要求HTML中元素标签必须要闭合，但是在3.x版本中已经不存在该问题了
所以,我们只需要将thymeleaf的版本改为3.x就可以了.
怎么改,在官方文档中有详细的说明,在我们pom.xml文件的properties属性中,加入下面的代码就可以了
<properties> <thymeleaf.version>3.0.2.RELEASE</thymeleaf.version> <thymeleaf-layout-dialect.version>2.1.1</thymeleaf-layout-dialect.version></properties>
这里的thymeleaf.version就是thymeleaf的版本号,当然现在thymeleaf的版本可能已经不止3.0.2了,我们可以到GitHub上查看thymeleaf的最新版本thymeleaf-layout-dialect其实是thymeleaf的布局管理器,他和thymeleaf.version相对于,所以,我们同样可以再GitHub上找到thymeleaf-layout-dialect最新版本
最终,我们先阶段能够用到最新的thymeleaf 3的版本,可以写成下面这个样子:
<properties> <thymeleaf.version>thymeleaf-3.0.11.RELEASE</thymeleaf.version> <thymeleaf-layout-dialect.version>2.3.0</thymeleaf-layout-dialect.version></properties>
关于Thymeleaf的相关语法,这里就不再做一一介绍了,我们后面通过案例,大家照着做一下,慢慢就熟悉了,这些东西也不需要专门去学习,这里列举Thymeleaf语法常用的表达式
五.Thymeleaf基本语法
1.属性优先权 th:*
简单来说,这个其实就和JSTL中<c:when>、<c:choose>、<c:forEach>、<c:forTokens>、<c:if>、<c:set>…等等标签类似
具体相关内容如下表:
2.表达式语法
其实和EL表达式是一个意思,只不过划分的更加详细
