十七、Spring Boot使用Thymeleaf模版引擎以及语法

1、模版引擎

JSP,Velocity,Freemarker,Thymeleaf...

模版引擎.png

Spring Boot推荐的模版引擎:Thymeleaf

2、引入Thymeleaf依赖

<!-- 修改Spring Boot的默认版本 -->
<thymeleaf.version>3.0.9.RELEASE</thymeleaf.version>
<!-- 布局功能的支持程序
      thymeleaf3 对应layout2版本
      thymeleaf2 对应layout1版本
   -->
<thymeleaf-layout-dialect.version>2.2.2</thymeleaf-layout-dialect.version>

<!-- thymeleaf模版引擎 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>

3、Thymeleaf的使用&语法

ThymeleafProperties配置类:

@ConfigurationProperties(prefix = "spring.thymeleaf")
public class ThymeleafProperties {
    //默认编码
    private static final Charset DEFAULT_ENCODING = Charset.forName("UTF-8");
    //文档类型
    private static final MimeType DEFAULT_CONTENT_TYPE = MimeType.valueOf("text/html");
    //模版位置
    public static final String DEFAULT_PREFIX = "classpath:/templates/";
    //模版后缀
    public static final String DEFAULT_SUFFIX = ".html";

    private boolean checkTemplate = true;

    private boolean checkTemplateLocation = true;

    private String prefix = DEFAULT_PREFIX;

    private String suffix = DEFAULT_SUFFIX;

    private String mode = "HTML5";

    private Charset encoding = DEFAULT_ENCODING;

    private MimeType contentType = DEFAULT_CONTENT_TYPE;
    //缓存
    private boolean cache = true;

    private Integer templateResolverOrder;

    private String[] viewNames;

    private String[] excludedViewNames;

    private boolean enabled = true;
    
    //other code...
}

只要把模版html放置在classpath:/templates/目录下,thymeleaf就会自动渲染。

4、使用Thymeleaf:

(1)、导入thymeleaf的名称空间:

<html lang="en" xmlns:th="http://www.thymeleaf.org"></html>

​ (2)、thymeleaf语法:

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
    <div th:text="${hello}">这里是原来的文本!</div>
</body>
</html>

​ (3)、语法规则:

​ i)、th:text:改变当前元素里面的文本内容

th:任意html属性:用来替换原生html属性的值,例如id换成th:id, class换成th:class等等。

thymeleaf语法规则.png

​ ii)、表达式:

Simple expressions:(表达式语法)
    Variable Expressions: ${...}:获取变量值,OGNL表达式
        1)、获取对象的属性、调用方法
        2)、使用内置的基本对象
           #ctx : the context object.
            #vars: the context variables.
            #locale : the context locale.
            #request : (only in Web Contexts) the HttpServletRequest object.
            #response : (only in Web Contexts) the HttpServletResponse object.
            #session : (only in Web Contexts) the HttpSession object.
            #servletContext : (only in Web Contexts) the ServletContext object.
         3)、内置的工具对象
            #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)
            
    Selection Variable Expressions: *{...}:选择表达式,跟${}功能类似
        补充功能:配合th:object进行使用
            <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>
             
    Message Expressions: #{...}:获取国际化内容
    Link URL Expressions: @{...}:定义URL链接
        例子:@{/order/process(execId=${execId},execType='FAST')}
        
    Fragment Expressions: ~{...}:片段引用表达式
        
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)
    
Special tokens:
    No-Operation: _

​ iii)、thymeleaf公共页面元素抽取:

​ 1)、抽取公共片段

<div th:fragment="copy">
    &copy; 版权所有
</div>

​ 2)、引入公共片段

<div th:insert="~{footer :: copy}"></div>

~{templatename :: #selectorId} 表示:模版名::#选择器id

代码片段
<div id="copy-section">
    &copy; 2011 The Good Thymes Virtual Grocery
</div>

插入片段
<div th:insert="~{footer :: #copy-section}"></div>

~{templatename :: fragmentname} 表示:模版名::片段名

代码片段
<div th:fragment="copy">
    &copy; 2011 The Good Thymes Virtual Grocery
</div>

插入片段
<div th:insert="~{footer :: copy}"></div>

​ 3)、默认效果:insert的功能片段会被插入到div标签中。

如果使用th:insert等属性进行引入,可以不用写~{},可以直接写templatename::#selectorId/fragmentname。

但是如果是行内写法,必须加上~{}, 如[[~{}]]。

三种引入公共片段的th属性:

th:insert:将公共片段整个插入到声明引入的元素中

th:replace:将声明引入的元素替换为公共片段

th:include:将被引入的片段的内容包含到引入的元素中

代码片段
<footer th:fragment="copy">
    &copy; 版权所有
</footer>

引入方式
<div th:insert="~{footer::copy}"></div>
<div th:replace="~{footer::copy}"></div>
<div th:include="~{footer::copy}"></div>

实际效果:
th:insert效果
<div>
    <footer>
        &copy; 版权所有
    </footer>
</div>

th:replace效果
<footer>
    &copy; 版权所有
</footer>

th:include效果
<div>
    &copy; 版权所有
</div>

​ (4)、在引入代码片段的时候,可以使用传递参数的方式,这样在代码片段中就可以使用传递过来的参数。

<div th:fragment="frag">
...
</div>

<div th:replace="::frag (onevar=${value1},twovar=${value2})">

<div th:fragment="frag (onevar,twovar)">
<p th:text="${onevar} + ' - ' + ${twovar}">...</p>
</div>

<div th:replace="::frag (${value1},${value2})">...</div>
使用命名参数时顺序不重要
<div th:replace="::frag (onevar=${value1},twovar=${value2})">...</div>
<div th:replace="::frag (twovar=${value2},onevar=${value1})">...</div>

比如,在templates/commons/bar.html中定义了如下代码片段

<nav id="sidebar">
    <a class="nav-link" th:class="${activeUrl == 'main' ? 'nav-link active' : 'nav-link'}" ...> 
        ...
    </a>
</nav>

在引入该代码片段的时候,可以使用传递参数的方式。

<div th:replace="commons/bar::#sidebar(activeUrl='main')">...</div>
或
<div th:replace="commons/bar::#sidebar(activeUrl='emps')">...</div>

至于其他Thymeleaf语法可以参考Thymeleaf官网http://www.thymeleaf.org

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,233评论 4 360
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,013评论 1 291
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,030评论 0 241
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,827评论 0 204
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,221评论 3 286
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,542评论 1 216
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,814评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,513评论 0 198
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,225评论 1 241
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,497评论 2 244
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,998评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,342评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,986评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,055评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,812评论 0 194
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,560评论 2 271
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,461评论 2 266

推荐阅读更多精彩内容