springboot 系列教程四：springboot thymeleaf配置

thymeleaf介绍

thymeleaf 是新一代的模板引擎，在spring4.0中推荐使用thymeleaf来做前端模版引擎。简单说是一个跟 Velocity、FreeMarker 类似的模板引擎，它可以完全替代 JSP 。相较与其他的模板引擎，它有如下三个极吸引人的特点：

1. thymeleaf 在有网络和无网络的环境下皆可运行，即它可以让美工在浏览器查看页面的静态效果，也可以让程序员在服务器查看带数据的动态页面效果。这是由于它支持 html 原型，然后在 html 标签里增加额外的属性来达到模板+数据的展示方式。浏览器解释 html 时会忽略未定义的标签属性，所以 thymeleaf 的模板可以静态地运行；当有数据返回到页面时，Thymeleaf 标签会动态地替换掉静态内容，使页面动态显示。
2. thymeleaf 开箱即用的特性。它提供标准和spring标准两种方言，可以直接套用模板实现JSTL、 OGNL表达式效果，避免每天套模板、该jstl、改标签的困扰。同时开发人员也可以扩展和创建自定义的方言。
3. thymeleaf 提供spring标准方言和一个与 SpringMVC 完美集成的可选模块，可以快速的实现表单绑定、属性编辑器、国际化等功能。

添加Maven依赖

---

在pom.xml文件中添加spring-boot-starter-thymeleaf依赖。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>

配置application.properties

#端口号
server.port=80
#访问路径
server.context-path=/

#编码
spring.thymeleaf.encoding=UTF-8
#返回模板类型
spring.thymeleaf.servlet.content-type=text/html
#开发时关闭缓存,不然没法看到实时页面
spring.thymeleaf.cache=false
# 在构建URL时预先查看名称的前缀 （默认就是这个）
spring.thymeleaf.prefix=classpath:/templates/
# 构建URL时附加查看名称的后缀.（默认就是 html的结尾的）
spring.thymeleaf.suffix=.html

标准表达式语法

---

1. 变量表达式
2. 选择或星号表达式
3. 文字国际化表达式
4. URL表达式

1. 变量表达式

变量表达式即OGNL表达式或Spring EL表达式(在Spring术语中也叫model attributes) 它们将以HTML标签的一个属性来表示：

<span th:text="${book.author.name}">
<li th:each="book : ${books}">

2. 选择(星号)表达式

选择表达式很像变量表达式，不过它们用一个预先选择的对象来代替上下文变量容器(map)来执行，被指定的object由th:object属性定义：

<div th:object="${book}">
  ...
  <span th:text="*{title}">...</span>
  ...
</div>

3. 文字国际化表达式

文字国际化表达式允许我们从一个外部文件获取区域文字信息(.properties)，用Key-value的形式配置国际化信息(此文不做示例）

4. URL表达式

URL表达式指的是把一个有用的上下文或回话信息添加到URL，这个过程经常被叫做URL重写。 @{/order/list} URL还可以设置参数：@{/order/details(id=${orderId})} 相对路径：@{../documents/report} 让我们看这些表达式：

<form th:action="@{/createOrder}"></form>
<a th:href="@{/main}"></a>

变量表达式和星号表达有什么区别吗 ？

如果不考虑上下文的情况下，两者没有区别；星号语法评估在选定对象上表达，而不是整个上下文。 什么是选定对象？就是父标签的值，如下：

<div th:object="${session.user}">
  <p>Name: <span th:text="*{firstName}">Sebastian</span>.</p>
  <p>Surname: <span th:text="*{lastName}">Pepper</span>.</p>
  <p>Nationality: <span th:text="*{nationality}">Saturn</span>.</p>
</div>

这是完全等价于：

<div th:object="${session.user}">
    <p>Name: <span th:text="${session.user.firstName}">Sebastian</span>.</p>
    <p>Surname: <span th:text="${session.user.lastName}">Pepper</span>.</p>
    <p>Nationality: <span th:text="${session.user.nationality}">Saturn</span>.</p>
</div>

当然，美元符号和星号语法可以混合使用：

<div th:object="${session.user}">
    <p>Name: <span th:text="*{firstName}">Sebastian</span></p>
    <p>Surname: <span th:text="${session.user.lastName}">Pepper</span></p>
    <p>Nationality: <span th:text="*{nationality}">Saturn</span></p>
</div>

表达式支持的语法

字面（Literals）

文本文字（Text literals）: ‘one text’, ‘Another one!’,…
数字文本（Number literals）: 0, 34, 3.0, 12.3,…
布尔文本（Boolean literals）: true, false
空（Null literal）: null
文字标记（Literal tokens）: one, sometext, main,…

文本操作（Text operations）

字符串连接(String concatenation): +
文本替换（Literal substitutions）: |The name is ${name}|

算术运算（Arithmetic operations）

二元运算符（Binary operators）: +, -, *, /, %
减号（单目运算符）Minus sign (unary operator): -

布尔操作（Boolean operations）

二元运算符（Binary operators）:and, or
布尔否定（一元运算符）Boolean negation (unary operator):!, not

比较和等价(Comparisons and equality)

比较（Comparators）: >, =, <= (gt, lt, ge, le)
等值运算符（Equality operators）:==, != (eq, ne)

条件运算符（Conditional operators）

If-then: (if) ? (then)
If-then-else: (if) ? (then) : (else)
Default: (value) ?: (defaultvalue)

所有这些特征可以被组合并嵌套：

'User is of type ' + (${user.isAdmin()} ? 'Administrator' : (${user.type} ?: 'Unknown'))

几种常用的使用方法

---

1.赋值、字符串拼接

<p th:text="${collect.description}">description</p>
<span th:text="'Welcome to our application, ' + ${user.name} + '!'">

字符串拼接还有另外一种简洁的写法

<span th:text="|Welcome to our application, ${user.name}!|">

2.条件判断 If/Unless Thymeleaf中使用th:if和th:unless属性进行条件判断，下面的例子中，标签只有在th:if中条件成立时才显示：

<a th:if="${myself=='yes'}" >baidu</a>
<a th:unless=${session.user != null} th:href="@{/login}" >Login</a>

th:unless于th:if恰好相反，只有表达式中的条件不成立，才会显示其内容。 也可以使用(if) ? (then) : (else)这种语法来判断显示的内容

3.for 循环

<tr th:each="collect,iterStat : ${collects}"> 
    <th scope="row" th:text="${collect.id}">1</th>
    <td >
       <img th:src="${collect.webLogo}"/>
    </td>
    <td th:text="${collect.url}">Mark</td>
    <td th:text="${collect.title}">Otto</td>
    <td th:text="${collect.description}">@mdo</td>
    <td th:text="${terStat.index}">index</td>
</tr>

iterStat称作状态变量，属性有：

• index:当前迭代对象的index（从0开始计算）
• count: 当前迭代对象的index(从1开始计算)
• size:被迭代对象的大小
• current:当前迭代变量
• even/odd:布尔值，当前循环是否是偶数/奇数（从0开始计算）
• first:布尔值，当前循环是否是第一个
• last:布尔值，当前循环是否是最后一个

URL详解

---

URL在Web应用模板中占据着十分重要的地位，需要特别注意的是Thymeleaf对于URL的处理是通过语法@{…}来处理的。 如果需要Thymeleaf对URL进行渲染，那么务必使用th:href,th:src等属性，下面是一个例子:

<!-- Will produce 'http://localhost:8080/standard/unread' (plus rewriting) -->
<a th:href="@{/standard/{type}(type=${type})}">view</a>

<!-- Will produce '/gtvg/order/3/details' (plus rewriting) -->
<a href="details.html" th:href="@{/order/{orderId}/details(orderId=${o.id})}">view</a>

设置背景

<div th:style="'background:url(' + @{/<path-to-image>} + ');'"></div>

根据属性值改变背景

<div class="media-object resource-card-image" th:style="'background:url(' + @{(${collect.webLogo}=='' ? 'img/favicon.png' : ${collect.webLogo})} + ')'" ></div>

几点说明：

1. 上例中URL最后的(orderId=${o.id})表示将括号内的内容作为URL参数处理，该语法避免使用字符串拼接，大大提高了可读性
2. @{…}表达式中可以通过{orderId}访问Context中的orderId变量
3. @{/order}是Context相关的相对路径，在渲染时会自动添加上当前Web应用的Context名字，假设context名字为app，那么结果应该是/app/order

thymeleaf中的内联[[ ]]

---

1. 文本内联

[[…]]之间的表达式在Thymeleaf被认为是内联表达式,在其中您可以使用任何类型的表达式,也会有效th:text属性。

<p>Hello, [[${session.user.name}]]!</p>

等同于：

<p>Hello, <span th:text="${session.user.name}">Sebastian</span>!</p>

为了让内联工作,我们必须激活它使用th:inline属性,它有三个可能的值或模式(text, javascript 和 none)。让我们试着文本:

<p th:inline="text">Hello, [[${session.user.name}]]!</p>

如果不使用th:inline="text",则会被当做字符串显示。th:inline="javascript"表示能在js中使用[[ ]]取值。 标签的th:inline不需要包含内联的一个表达式，任何父标签都行，例如如下也是可以的：

<body th:inline="text">
   ...
   <p>Hello, [[${session.user.name}]]!</p>
   ...
</body>

2. 脚本内联

Thymeleaf提供一系列的 “脚本” 的内联模式功能,这样你就可以将你的数据在脚本中创建一些脚本语言。 我们可以做的第一件事,写脚本内联表达式的值到我们的脚本。

<script th:inline="javascript">
      var user = [[${user.username}]];
      alert(user);
</script>

<script th:inline="javascript">
      var msg  = 'Hello, ' + [[${user.username}]];
      alert(msg);
</script>

只要加入th:inline="javascript"在js代码中才能使用[[ ]]

内嵌变量

---

为了模板更加易用，Thymeleaf还提供了一系列Utility对象（内置于Context中），可以通过#直接访问：

• dates ： java.util.Date的功能方法类
• calendars : 类似#dates，面向java.util.Calendar
• numbers : 格式化数字的功能方法类
• strings : 字符串对象的功能类，contains,startWiths,prepending/appending等等
• objects: 对objects的功能类操作
• bools: 对布尔值求值的功能方法
• arrays：对数组的功能类方法
• lists: 对lists功能类方法
• sets
• maps
• …

下面用一段代码来举例一些常用的方法： dates

/*
 * Format date with the specified pattern
 * Also works with arrays, lists or sets
 */
${#dates.format(date, 'dd/MMM/yyyy HH:mm')}
${#dates.arrayFormat(datesArray, 'dd/MMM/yyyy HH:mm')}
${#dates.listFormat(datesList, 'dd/MMM/yyyy HH:mm')}
${#dates.setFormat(datesSet, 'dd/MMM/yyyy HH:mm')}
 
/*
 * Create a date (java.util.Date) object for the current date and time
 */
${#dates.createNow()}
 
/*
 * Create a date (java.util.Date) object for the current date (time set to 00:00)
 */
${#dates.createToday()}

strings

/*
 * Check whether a String is empty (or null). Performs a trim() operation before check
 * Also works with arrays, lists or sets
 */
${#strings.isEmpty(name)}
${#strings.arrayIsEmpty(nameArr)}
${#strings.listIsEmpty(nameList)}
${#strings.setIsEmpty(nameSet)}
 
/*
 * Check whether a String starts or ends with a fragment
 * Also works with arrays, lists or sets
 */
${#strings.startsWith(name,'Don')}                  // also array*, list* and set*
${#strings.endsWith(name,endingFragment)}           // also array*, list* and set*
 
/*
 * Compute length
 * Also works with arrays, lists or sets
 */
${#strings.length(str)}
 
/*
 * Null-safe comparison and concatenation
 */
${#strings.equals(str)}
${#strings.equalsIgnoreCase(str)}
${#strings.concat(str)}
${#strings.concatReplaceNulls(str)}
 
/*
 * Random
 */
${#strings.randomAlphanumeric(count)}

使用thymeleaf布局

---

使用thymeleaf布局非常的方便 定义代码片段

<footer th:fragment="copy"> 
    ©2016
</footer>

在页面任何地方引入：

<body>
  <div th:include="footer :: copy"></div>
  <div th:replace="footer :: copy"></div>
</body>

th:include和th:replace区别，include只是加载，replace是替换 返回的HTML如下：

<body>
   <div> ©2016 </div>
   <footer> ©2016 </footer>
</body>

下面是一个常用的后台页面布局，将整个页面分为头部，尾部、菜单栏、隐藏栏，点击菜单只改变content区域的页面

<body class="layout-fixed">
   <div th:fragment="navbar" class="wrapper" role="navigation">
      <div th:replace="fragments/header :: header">Header</div>
      <div th:replace="fragments/left :: left">left</div>
      <div th:replace="fragments/sidebar :: sidebar">sidebar</div>
      <div layout:fragment="content" id="content" ></div>
      <div th:replace="fragments/footer :: footer">footer</div>
   </div>
</body>

任何页面想使用这样的布局值只需要替换中见的 content模块即可

<html xmlns:th="http://www.thymeleaf.org" layout:decorator="layout">
  <body>
     <section layout:fragment="content">
   ...

也可以在引用模版的时候传参

<head th:include="layout :: header" th:with="title='Hello'"></head>

layout 是文件地址，如果有文件夹可以这样写dir/layout header是指定义的代码片段，如：th:fragment="copy"