Thymeleaf基本用法

特性

 Thymeleaf是spring4.0中推荐的模板引擎技术,一种和 Velocity、FreeMarker 类似的模板引擎,它可以完全替代 JSP 。相较与其他的模板引擎,它有如下三个极吸引人的特点:

  • 1.Thymeleaf 在有网络和无网络的环境下皆可运行,即它可以让美工在浏览器查看页面的静态效果,也可以让程序员在服务器查看带数据的动态页面效果。这是由于它支持 html 原型,然后在 html 标签里增加额外的属性来达到模板+数据的展示方式。浏览器解释 html 时会忽略未定义的标签属性,所以 thymeleaf 的模板可以静态地运行;当有数据返回到页面时,Thymeleaf 标签会动态地替换掉静态内容,使页面动态显示。

  • 2.Thymeleaf 开箱即用的特性。它提供标准和spring标准两种方言,可以直接套用模板实现JSTL、 OGNL表达式效果,避免每天套模板、该jstl、改标签的困扰。同时开发人员也可以扩展和创建自定义的方言。

  • 3.Thymeleaf 提供spring标准方言和一个与 SpringMVC 完美集成的可选模块,可以快速的实现表单绑定、属性编辑器、国际化等功能。

引入

引用命名空间  

 在html中引入此命名空间,可避免编辑器出现html验证错误,虽然加不加命名空间对Thymeleaf的功能没有任何影响

表达式语法

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

变量表达式

变量表达式即Spring EL表达式 

${session.user.name}

它以html的标签属性来表示


  • 选择星号表达式

    和变量表达式类似,不过需要一个预先选择的对象作为容器来执行

    *{user.name}

    被指定的object由th:object来定义

    文字国际化表达式

    文字国际化表达式可以从外部的properties文件中,通过key索引到value

    在 springmvc 中使用消息要额外配置 ResourceBundleMessageSource 这个 bean:

        // 用于外部文本及国际化消息
        @Bean
        public ResourceBundleMessageSource messageSource() {
            ResourceBundleMessageSource messageSource = new ResourceBundleMessageSource();
            messageSource.setBasename("messages");
            return messageSource;
        }
    

    这个 bean 会去 classpath 根目录下去寻找 messages 为基名的 properties 文件. 比如,
    messages.properties, messages_en_US.properties, messages_zh_CN.properties.

    th:text外部文本会替换 p 标签内的内容.

      
    ...  
      
    ...  
    
    ... ...

    URL表达式

    将上下文的信息添加到URL,也称为重写URL

    #url赋值
    
    ... #设置参数 ...
    #设置参数,并再次渲染URL
    ...
    #设置相对路径
    ...

    变量表达式和星号表达式的区别

    如果不考虑上下文的情况下,两者没有区别;星号语法评估在选定对象上表达,而不是整个上下文。

    什么是选定对象,就是父标签的值。

    Name: Sebastian.

    Surname: Pepper.

    Nationality: Saturn.

    上面的等价于:

    Name: Sebastian.

    Surname: Pepper.

    Nationality: Saturn.

    当然,星号语法和美元语法可以混用

    Name: Sebastian.

    Surname: Pepper.

    Nationality: Saturn.

    表达式支持的语法

    字面(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标签

    1、赋值、字符串拼接

     

    description

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

    设置 Attribute 值

           5.1 设置任何Attribute 的方法

              --设置单个

             --一次设置多个

            5.2 设置一些内置的Attribute的方法   

           

  • Product List
  •        

           

            -- 一次设置多个(alt title)的方法

           其它的可用属性:http://www.thymeleaf.org/doc/tutorials/3.0/usingthymeleaf.html#setting-value-to-specific-attributes

            5.3 设置html里没有指的任何属性的语法

            ...   ---whatever 可以换成任何你想设的属性

     

    2、条件判断 If/Unless

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

      
    Login
    

    th:unless于th:if恰好相反,只有表达式中的条件不成立,才会显示其内容。

    也可以使用 (if) ? (then) : (else) 这种语法来判断显示的内容

     

    3、for 循环

     
         1
         
            
         
         Mark
         Otto
         @mdo
         index
     
    

    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等属性,下面是一个例子

    
     view
    
    
    view

    设置背景

    根据属性值改变背景

    几点说明:

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

    5、内联js

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

    在thymeleaf解释器解析代码时会解析里面的[[${session.user.name}]]
    加载静态页时会解析注释后面的语句 var username = 'Sebastian';

    js内联代码中需要加入/**/代码块,thymeleaf才能正确解析一些运算符(<等)和操作符号&/&&等。

    
    

    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等等。
    • objects: 对objects的功能类操作。
    • bools: 对布尔值求值的功能方法。
    • arrays:对数组的功能类方法。
    • lists: 对lists功能类方法
    • sets
    • maps

     

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

    lists

     

    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布局非常的方便

    定义代码片段

    © 2016

    在页面任何地方引入:

     
      

    th:include 和 th:replace区别,include只是加载,replace是替换

    返回的HTML如下:

     
       
    © 2016
    © 2016

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


    Header
    left
    sidebar

    footer

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

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

    
    

    layout 是文件地址,如果有文件夹可以这样写 fileName/layout:htmlhead

    htmlhead 是指定义的代码片段 如 th:fragment="copy"

    转载: https://zhuanlan.zhihu.com/p/24988845

    你可能感兴趣的:(模板引擎)