SpringBoot学习记录（四）——Thymeleaf

什么是Thymeleaf：

Thymeleaf是一个适用于Web和独立环境的现代服务器端Java模板引擎，能够处理HTML， ， ，CSS甚至纯文本。

Thymeleaf的主要目标是提供一种优雅且高度可维护的模板创建方式。为实现这一目标，它以自然模板的概念为基础，将其逻辑注入模板文件，其方式不会影响模板被用作设计原型。这改善了设计沟通，缩小了设计和开发团队之间的差距。

Thymeleaf也从一开始就设计了Web标准 - 特别是HTML5 - 允许您创建完全验证的模板，如果这是您的需要。

实际开发或学习中，有多种模板引擎可供选择： 
- Thymeleaf 
- FreeMarker 
- Velocity 
- Groovy 
- Mustache

总体上，thymeleaf 相较与其他的模板引擎，它有如下三个特点： 
1. Thymeleaf 在有网络和无网络的环境下皆可运行，即它可以让美工在浏览器查看页面的静态效果，也可以让程序员在服务器查看带数据的动态页面效果。（当有数据返回到页面时，Thymeleaf 标签会动态地替换掉静态内容，使页面动态显示。） 
2. Thymeleaf 开箱即用的特性。（它提供标准和spring标准两种方言，可以直接套用模板实现JSTL、 OGNL表达式效果。） 
3. Thymeleaf 提供spring标准方言和一个与 SpringMVC 完美集成的可选模块，可以快速的实现表单绑定、属性编辑器、国际化等功能。

标准表达式语法

它们分为四类：

　　${...}  变量表达式

　　*{...}  选择变量表达式

　　#{...}  消息表达式

　　@{...}  链接url表达式

1、变量表达式

在Spring支持MVC的应用程序中，OGNL将被SpringEL取代，但其语法与OGNL的语法非常相似（实际上，对于大多数常见情况来说，完全相同）。

它们将以HTML标签的一个属性来表示：

<span th:text=\"${user.name}\">  

2、选择(星号)表达式

变量表达式不仅可以写成${...}，也可以作为*{...}。但是有一个重要的区别：星号语法评估所选对象上的表达式而不是整个上下文。也就是说，只要没有选定的对象，$和*语法就会完全相同。

被指定的 由th: 属性定义：

<div th: =\"${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>
  <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: =\"${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>

当对象选择到位时，所选对象也可用作$表达式作为# 表达式变量： 

<div th: =\"${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>

如上所述，如果没有执行任何对象选择，则$和*语法是等效的。 

<div>
  <p>Name: <span th:text=\"*{session.user.name}\">Sebastian</span>.</p>
  <p>Surname: <span th:text=\"*{session.user.surname}\">Pepper</span>.</p>
  <p>Nationality: <span th:text=\"*{session.user.nationality}\">Saturn</span>.</p>
</div>

3、消息表达式

消息表达式允许我们从一个外部文件获取区域文字信息(.properties)，用Key索引Value，还可以提供一组参数(可选).

    #{main. }  
    #{message.entrycreated(${entryId})}  

可以在模板文件中找到这样的表达式代码：

    <table>  
      ...  
      <th th:text=\"#{header.address.city}\">...</th>  
      <th th:text=\"#{header.address.country}\">...</th>  
      ...  
    </table>  

4、URL表达式

URL表达式它们的重要性，我们经常会用到，如下：

@{/user/login}
URL还可以设置参数：

@{/user/list(id=${o.id})}

让我们看这些表达式：类似的标签有:th:href和th:src

<a th:href=\"@{http://blog.csdn.net}\">绝对路径</a>
<a th:href=\"@{/}\">相对路径</a>
<a th:href=\"@{css/bootstrap.min.css}\">Content路径,默认访问static下的css文件夹</a>

表达式支持的语法

字面（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\'))

常用th标签都有那些？

还有非常多的标签，这里只列出最常用的几个,由于一个标签内可以包含多个th:x属性，其生效的优先级顺序为:include,each,if/unless/switch/case,with,attr/attrprepend/attrappend,value/href,src ,etc,text/utext,fragment,remove。 

几种常用的使用方法

1、赋值、字符串拼接

 <p  th:text=\"${collect.de ion}\">de ion</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属性进行条件判断，下面的例子中，<a>标签只有在th:if中条件成立时才显示：

<a th:if=\"${myself==\'yes\'}\" > </i> </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. }\">Otto</td>
     <td th:text=\"${collect.de ion}\">@mdo</td>
     <td th:text=\"${terStat.index}\">index</td>
 </tr>

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

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

4、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-  resource-card-image\"  th:style=\"\'background:url(\' + @{(${collect.webLogo}==\'\' ? \'img/favicon.png\' : ${collect.webLogo})} + \')\'\" ></div>

几点说明：

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

5、内联js

内联文本：[[…]]内联文本的表示方式，使用时，必须先用th:inline=”text/ /none”激活，th:inline可以在父级标签内使用，甚至作为body的标签。内联文本尽管比th:text的代码少，不利于原型显示。

<  th:inline=\" \">
/*<![CDATA[*/
...
var username = /*[[${sesion.user.name}]]*/ \'Sebastian\';
var size = /*[[${size}]]*/ 0;
...
/*]]>*/
</ >

js附加代码：

/*[+
var msg = \'This is a working application\';
+]*/

js移除代码：

/*[- */
var msg = \'This is a non-working template\';
/* -]*/

6、内嵌变量

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

• dates ： java.util.Date的功能方法类。
• calendars : 类似#dates，面向java.util.Calendar
• numbers : 格式化数字的功能方法类
• strings : 字符串对象的功能类，contains,startWiths,prepending/appending等等。
• s: 对 s的功能类操作。
• 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)   for the current date and time
 */
${#dates.createNow()}

/*
 * Create a date (java.util.Date)   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\"> 
&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> &copy; 2016 </div> 
  <footer>&copy; 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  ns:th=\"http://www.thymeleaf.org\" layout:decorator=\"layout\">
   <body>
      <section layout:fragment=\"content\">
    ...

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

<head th:include=\"layout :: htmlhead\" th:with=\" =\'Hello\'\"></head>

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