Thymeleaf参考文档

概述

Thymeleaf是Spring boot推荐使用的模版引擎，除此之外常见的还有Freemarker和Jsp。Jsp应该是我们最早接触的模版引擎。而Freemarker工作中也很常见。

1. th属性

html有的属性，Thymeleaf基本都有，而常用的属性大概有七八个。其中th属性执行的优先级从1~8，数字越低优先级越高。

• th:text ：设置当前元素的文本内容，相同功能的还有th:utext，两者的区别在于前者不会转义html标签，后者会。优先级不高：order=7

• th:value：设置当前元素的value值，类似修改指定属性的还有th:src，th:href。优先级不高：order=6

• th:each：遍历循环元素，和th:text或th:value一起使用。注意该属性修饰的标签位置，详细往后看。优先级很高：order=2

• th:if：条件判断，类似的还有th:unless，th:switch，th:case。优先级较高：order=3

• th:insert：代码块引入，类似的还有th:replace，th:include，三者的区别较大，若使用不恰当会破坏html结构，常用于公共代码块提取的场景。优先级最高：order=1

• th:fragment：定义代码块，方便被th:insert引用。优先级最低：order=8

• th:object：声明变量，一般和*一起配合使用，达到偷懒的效果。优先级一般：order=4

• th:attr：修改任意属性，实际开发中用的较少，因为有丰富的其他th属性帮忙，类似的还有th:attrappend，th:attrprepend。优先级一般：order=5

th使用注意事项

使用Thymeleaf属性需要注意点以下五点：

• 若要使用Thymeleaf语法，首先要声明名称空间： xmlns:th=“http://www.thymeleaf.org”

• 设置文本内容 th:text，设置input的值 th:value，循环输出 th:each，条件判断 th:if，插入代码块 th:insert，定义代码块 th:fragment，声明变量 th:object

• th:each 的用法需要格外注意，打个比方：如果你要循环一个div中的p标签，则th:each属性必须放在p标签上。若你将th:each属性放在div上，则循环的是将整个div。

• 变量表达式中提供了很多的内置方法，该内置方法是用#开头，请不要与#消息表达式弄混。

• th:insert，th:replace，th:include 三种插入代码块的效果相似，但区别很大。

th使用demo

    
    


    
ITDragon Thymeleaf 语法
    
    

    


    
    

    
    
    
 
        

    
    
 
        

    

    
    


    
    


    
    

        
ID: 

        
TH: 

        
DE: 

    

2. 标准表达式语法

• ${…} 变量表达式，Variable Expressions
• @{…} 链接表达式，Link URL Expressions
• #{…} 消息表达式，Message Expressions
• ~{…} 代码块表达式，Fragment Expressions
• *{…} 选择变量表达式，Selection Variable Expressions

代码块表达式的使用

© 2011 The Good Thymes Virtual Grocery









    

    © 2011 The Good Thymes Virtual Grocery
    




© 2011 The Good Thymes Virtual Grocery




© 2011 The Good Thymes Virtual Grocery

• activeUrl变量是通过代码块表达式在其他页面传入的变量，这也是代码块表达式强大的一个功能。

消息表达式

一般用于国际化

th:text=#{msg}

链接表达式

• 无参：@{/xxx}
• 有参：@{/xxx(k1=v1,k2=v2)} 对应url结构：xxx?k1=v1&k2=v2
• 引入本地资源：@{/项目本地的资源路径}
• 引入外部资源：@{/webjars/资源在jar包中的路径}

中文
English

变量表达式

• 可以获取对象的属性和方法

• 可以使用ctx，vars，locale，request，response，session，servletContext内置对象

• 可以使用dates，numbers，strings，objects，arrays，lists，sets，maps等内置方法（重点介绍）

• 常用的内置对象

  • ctx ：上下文对象。
  • vars ：上下文变量。
  • locale：上下文的语言环境。
  • request：（仅在web上下文）的 HttpServletRequest 对象。
  • response：（仅在web上下文）的 HttpServletResponse 对象。
  • session：（仅在web上下文）的 HttpSession 对象。
  • servletContext：（仅在web上下文）的 ServletContext 对象

内置对象demo

// java 代码将用户名放在session中
session.setAttribute("userinfo",username);

// Thymeleaf通过内置对象直接获取
th:text="${session.userinfo}"

• 常用的内置方法

  • strings：字符串格式化方法，常用的Java方法它都有。比如：equals，equalsIgnoreCase，length，trim，toUpperCase，toLowerCase，indexOf，substring，replace，startsWith，endsWith，contains，containsIgnoreCase等

  • numbers：数值格式化方法，常用的方法有：formatDecimal等

  • bools：布尔方法，常用的方法有：isTrue，isFalse等

  • arrays：数组方法，常用的方法有：toArray，length，isEmpty，contains，containsAll等

  • lists，sets：集合方法，常用的方法有：toList，size，isEmpty，contains，containsAll，sort等

  • maps：对象方法，常用的方法有：size，isEmpty，containsKey，containsValue等

  • dates：日期方法，常用的方法有：format，year，month，hour，createNow等

内置方法demo

    
    


    
ITDragon Thymeleaf 内置方法
    
#strings 
    

        
Old Str : 
        
toUpperCase : 
        
toLowerCase : 
        
equals : 
        
equalsIgnoreCase : 
        
indexOf : 
        
substring : 
        
replace : 
        
startsWith : 
        
contains : 
    

    
#numbers 
    

        
formatDecimal 整数部分随意，小数点后保留两位，四舍五入: 
        
formatDecimal 整数部分保留五位数，小数点后保留两位，四舍五入: 
    

    
#bools 
    

        

    

    
#arrays 
    

        
length : 
        
contains : 
        
containsAll : 
    
    
    
#lists 
    

        
size : 
        
contains : 
        
sort : 
    
    
    
#maps 
    

        
size : 
        
containsKey : 
        
containsValue : 
    
    
    
#dates 
    

        
format : 
        
custom format : 
        
day : 
        
month : 
        
monthName : 
        
year : 
        
dayOfWeekName : 
        
hour : 
        
minute : 
        
second : 
        
createNow : 
    

3. springboot使用thymeleaf

• 引入

  UTF-8
  UTF-8
  1.8
  3.0.9.RELEASE
  2.2.2


   
    org.springframework.boot
    spring-boot-starter-thymeleaf
  

• 提取公共资源引入

• 统一左侧菜单栏

    



    
    

    		左侧菜单栏
    

4. 参考文档

Thymeleaf3语法详解