模板引擎thymeleaf简介

模板引擎thymeleaf简介

Thymeleaf是一个XML/XHTML/HTML5模板引擎，可用于Web与非Web环境中的应用开发。它是一个开源的Java库，基于Apache License 2.0许可，由Daniel Fernández创建，该作者还是Java加密库Jasypt的作者。

Thymeleaf提供了一个用于整合Spring MVC的可选模块，在应用开发中，你可以使用Thymeleaf来完全代替JSP，或其他模板引擎，如Velocity、FreeMarker等。Thymeleaf的主要目标在于提供一种可被浏览器正确显示的、格式良好的模板创建方式，因此也可以用作静态建模。你可以使用它创建经过验证的XML与HTML模板。相对于编写逻辑或代码，开发者只需将标签属性添加到模板中即可。接下来，这些标签属性就会在DOM（文档对象模型）上执行预先制定好的逻辑

配置，结合springBoot

pom.xml增加配置

<properties>  
    <thymeleaf.version>3.0.2.RELEASE</thymeleaf.version>
    <thymeleaf-layout-dialect.version>2.1.1</thymeleaf-layout-dialect.version>
</properties>

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

application.properties增加配置

spring.thymeleaf.prefix=classpath:/templates/
spring.thymeleaf.suffix=.html
spring.thymeleaf.cache: false
spring.thymeleaf.mode: html
# 静态文件对接路径，默认为/**
spring.mvc.static-path-pattern=/static/**

springBoot默认会将templates目录下的文件视为模板文件

注意：如果模板目录配置的是classpath:/templates/，那么controller里面返回的路径不能带“/”否则使用 java -jar运行时会出现找不到模板

@RequestMapping(method = RequestMethod.GET)
public String login() {
    if (ShiroUtil.isLogin()) {
        return "redirect:/";
    }
    //这里前面不能加"/"
    return "login";
}

语法简介

基本表达式

• Variable Expressions: ${…}
• Selection Variable Expressions: *{…}
• Message Expressions: #{…}
• Link URL Expressions: @{…}
• Fragment Expressions: ~{…}

工具类表达式

• #execInfo: information about the template being processed.
• #messages: methods for obtaining externalized messages inside variables expressions, in the same way as they would be obtained using #{…} syntax.
• #uris: methods for escaping parts of URLs/URIs
• #conversions: methods for executing the configured conversion service (if any).
• #dates: methods for java.util.Date objects: formatting, component extraction, etc.
• #calendars: analogous to #dates, but for java.util.Calendar objects.
• #numbers: methods for formatting numeric objects.
• #strings: methods for String objects: contains, startsWith, prepending/appending, etc.
• #objects: methods for objects in general.
• #bools: methods for boolean evaluation.
• #arrays: methods for arrays.
• #lists: methods for lists.
• #sets: methods for sets.
• #maps: methods for maps.
• #aggregates: methods for creating aggregates on arrays or collections.
• #ids: methods for dealing with id attributes that might be repeated (for example, as a result of an iteration).

示例，格式化日期

<p>
  Today is: <span th:text="${#calendars.format(today,'dd MMMM yyyy')}">13 May 2011</span>
</p>

th:object 选中对象（*号表达式）

<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>

如果没有选中任何对象，*号和$号表达式是等价的

<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>

th:block标签

这是个虚拟的标签，用于更方便使用其他的标签及表达式

<table>
  <th:block th:each="user : ${users}">
    <tr>
        <td th:text="${user.login}">...</td>
        <td th:text="${user.name}">...</td>
    </tr>
    <tr>
        <td colspan="2" th:text="${user.address}">...</td>
    </tr>
  </th:block>
</table>

Expression inlining

• [[…]] 等于 th:text ：格式化html标签
• [(…)] 等于 th:utext：不格式化html标签

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

th:remove

• all: Remove both the containing tag and all its children.
• body: Do not remove the containing tag, but remove all its children.
• tag: Remove the containing tag, but do not remove its children.
• all-but-first: Remove all children of the containing tag except the first one.
• none : Do nothing. This value is useful for dynamic evaluation.

<table>
  <tr>
    <th>NAME</th>
    <th>PRICE</th>
    <th>IN STOCK</th>
    <th>COMMENTS</th>
  </tr>
  <tr th:each="prod : ${prods}" th:class="${prodStat.odd}? 'odd'">
    <td th:text="${prod.name}">Onions</td>
    <td th:text="${prod.price}">2.41</td>
    <td th:text="${prod.inStock}? #{true} : #{false}">yes</td>
    <td>
      <span th:text="${#lists.size(prod.comments)}">2</span> comment/s
      <a href="comments.html" 
         th:href="@{/product/comments(prodId=${prod.id})}" 
         th:unless="${#lists.isEmpty(prod.comments)}">view</a>
    </td>
  </tr>
  <tr class="odd" th:remove="all">
    <td>Blue Lettuce</td>
    <td>9.55</td>
    <td>no</td>
    <td>
      <span>0</span> comment/s
    </td>
  </tr>
  <tr th:remove="all">
    <td>Mild Cinnamon</td>
    <td>1.99</td>
    <td>yes</td>
    <td>
      <span>3</span> comment/s
      <a href="comments.html">view</a>
    </td>
  </tr>
</table>

EL表达式直接调用bean方法

//在模板页面中直接调用bean的方法
<b th:text="${@shiroUtil.getCurrentUserName()}"></b>

//注入bean
@DependsOn("springContextHolder")
@Bean("shiroUtil")
public ShiroUtil shiroUtil(){
	ShiroUtil shiroUtil =new ShiroUtil();
	return shiroUtil;
}

表达式

Order	Feature	Attributes
1	Fragment inclusion	th:insert th:replace
2	Fragment iteration	th:each
3	Conditional evaluation	th:if th:unless th:switch th:case
4	Local variable definition	th:object th:with
5	General attribute modification	th:att th:attrprepend th:attrappend
6	Specific attribute modification	th:value th:href th:src …
7	Text (tag body modification)	th:text th:utext
8	Fragment specification	th:fragment
9	Fragment removal	th:remove

参考资料

• http://www.thymeleaf.org/doc/tutorials/3.0/usingthymeleaf.html （官网）
• http://www.cnblogs.com/ityouknow/p/5833560.html