A、Thymeleafの概要
一般的には、一般的に使用されるテンプレートエンジンJSP、速度、Freemarkerの、Thymeleaf。
SpringBootはThymeleafを推奨 - シンプルな文法、より強力な。
Thymeleafは、Java XML / XHTML / HTML5テンプレートエンジンである、あなたは、Webおよび非Web環境を使用することができます。
ビュー層にMVCベースのWebアプリケーションをXHTML / HTML5を提供するために、より適しているが、それでもオフライン環境で、それはまた、任意のXMLファイルを扱うことができます。それは完全な春のフレームワークとの統合を提供します。
第二に、標準の表現の構文
これらは4つのカテゴリに分類されます。
- 1.変数式
- 2.式またはアスタリスクを選択
- 表現の3.国際的な文字
- 4.URL式
変数式
すなわちELスプリングOGNL式または式可変式(点でSpringは、モデルの属性と呼ばれます)。次のように:
${session.user.name}
彼らは、HTMLタグを表すために属性ます。
<span th:text="${book.author.name}">
<li th:each="book : ${books}">
(アスタリスク)の発現を選択
式のような式の変数を選択しますが、彼らは事前に選択されたターゲットを使用する代わりに、次のようにコンテキスト変数コンテナ(地図)が実行されます。
*{customer.name}
定義されたオブジェクトのプロパティ:番目によって指定されたオブジェクト。
<div th:object="${book}">
...
<span th:text="*{title}">...</span>
...
</div>
テキスト国際化表現
国際リテラル式は、私たちは、外部ファイルからテキストメッセージエリア(.propertiesファイル)を取得することができ、キーインデックス値を使用し、また、パラメータ(オプション)のセットを提供することができます。
#{main.title}
#{message.entrycreated(${entryId})}
このような表現コードは、テンプレートファイルに記載されています:
<table>
...
<th th:text="#{header.address.city}">...</th>
<th th:text="#{header.address.country}">...</th>
...
</table>
URL式
URL式は便利なコンテキスト情報を追加するか、このプロセスは、多くの場合、URLの書き換えと呼ばれているURLに答えることを指します。
@{/order/list}
URLはまた、パラメータを設定できます。
@{/order/details(id=${orderId})}
相対パス:
@{../documents/report}
のは、これらの式を見てみましょう:
<form th:action="@{/createOrder}">
<a href="main.html" th:href="@{/main}">
変数式および発現アスタリスクは任意の違いはありますか?
次の2つの違いはありません、例文脈を考慮していない場合は、選択したオブジェクト上で評価星型構文表現の全体ではなく、文脈
選択したオブジェクトが何でありますか?次のように親のラベルの値は、次のとおりです。
<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>
これは、とまったく同じです。
<div th:object="${session.user}">
<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: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>
式の構文をサポート
リテラル(リテラル)
- テキストテキスト(文字リテラル):
'one text', 'Another one!',…
- デジタルテキスト(数値リテラル):
0, 34, 3.0, 12.3,…
- ブールテキスト(ブールリテラル):
true, false
- 空(NULLリテラル):
null
- ワードマーク(リテラルトークン):
one, sometext, main,…
操作テキスト(テキスト・オペレーション)
- 文字列の連結(文字列連結):
+
- テキスト(リテラル置換)を置き換えます。
|The name is ${name}|
算術(演算)
- バイナリ演算子(二項演算子):
+, -, *, /, %
- マイナス(単項)マイナス記号(単項演算子):
-
ブーリアン演算(ブール演算)
- バイナリ演算子(二項演算子):
and, or
- ブール否定(単項)ブール否定(単項演算子):
!, not
比較と同等物(比較と平等)
- (コンパレータ)を比較します。
>, <, >=, <= (gt, lt, ge, le)
- 等価演算子(等価演算子):
==, != (eq, ne)
条件演算子(条件演算子)
- IF-THEN:
(if) ? (then)
- IF-THEN-ELSE:
(if) ? (then) : (else)
- デフォルト:(値)?:
(defaultvalue)
これらの機能のすべてを合わせ、入れ子にすることができます。
'User is of type ' + (${user.isAdmin()} ? 'Administrator' : (${user.type} ?: 'Unknown'))
第三に、目の共通ラベル
公式文書が多数を詳しく説明:
https://www.thymeleaf.org/doc/tutorials/3.0/usingthymeleaf.html
キーワード | 特長 | ケース |
---|---|---|
目:ID | IDを交換してください | <input th:id="'xxx' + ${collect.id}"/> |
目:テキスト | テキスト置換 | <p th:text="${collect.description}">description</p> |
目:のutext | HTMLのテキスト置換をサポートしています | <p th:utext="${htmlcontent}">conten</p> |
目:オブジェクト | オブジェクトの交換 | <div th:object="${session.user}"> |
目:値 | プロパティの割り当て | <input th:value="${user.name}" /> |
目:付き | 変数代入演算子 | <div th:with="isEven=${prodStat.count}%2==0"></div> |
目:スタイル | スタイルを設定します | th:style="'display:' + @{(${sitrue} ? 'none' : 'inline-block')} + ''" |
目:onclickの | イベントをクリックします | th:onclick="'getCollect()'" |
目:各 | プロパティの割り当て | tr th:each="user,userStat:${users}"> |
第ます。if | 条件を決定 | <a th:if="${userId == collect.userId}" > |
目:ない限り、 | そして目:もし反対の決意 | <a th:href="@{/login}" th:unless=${session.user != null}>Login</a> |
目:HREF | リンクアドレス | <a th:href="@{/login}" th:unless=${session.user != null}>Login</a> /> |
目:スイッチ | ケース用途:番目とマルチプレクサ | <div th:switch="${user.role}"> |
目:ケース | 目:スイッチのブランチ | <p th:case="'admin'">User is an administrator</p> |
目:フラグメント | レイアウト]タブ、スニペットを定義し、他の場所で便利な引用 | <div th:fragment="alert"> |
目:含めます | ファイルの内容を置き換えるために導入された[レイアウト]タブ、 | <head th:include="layout :: htmlhead" th:with="title='xx'"></head> /> |
目:置き換えます | タグ全体のファイルを置き換えるために導入された[レイアウト]タブ、 | <div th:replace="fragments/header :: title"></div> |
目:選択しました | 選択マーキーで選択 | th:selected="(${xxx.id} == ${configObj.dd})" |
目:SRC | 絵のカテゴリはアドレスを導入しました | <img class="img-responsive" alt="App Logo" th:src="@{/img/logo.png}" /> |
細い線 | JSスクリプトは、変数の定義を使用することができます | <script type="text/javascript" th:inline="javascript"> |
目:アクション | 住所フォームの送信 | <form action="subscribe.html" th:action="@{/subscribe}"> |
目:削除 | プロパティを削除します。 | <tr th:remove="all"> 1.all:删除包含标签和所有的孩子。2.body:不包含标记删除,但删除其所有的孩子。3.tag:包含标记的删除,但不删除它的孩子。4.all-but-first:删除所有包含标签的孩子,除了第一个。5.none:什么也不做。这个值是有用的动态评估。 |
目:ATTR | ラベル属性セット、複数の属性はコンマで分離することができます | 例えばth:attr="src=@{/image/aa.jpg},title=#{logo}" 、このラベルはあまりエレガントで、あまり一般的な使用です。 |
タグは番目の複数を含むことができるので、ラベルの多くは、最も一般的に使用されるのはほんのあります:x属性、有効である優先順位:include,each,if/unless/switch/case,with,attr/attrprepend/attrappend,value/href,src ,etc,text/utext,fragment,remove。
第四に、表現
単純な式
- 変数式:$ {...}
- * {...}:変数式を選択
- メッセージ式:{...}#
- リンク式:@ {...}
- フラグメントの発現:〜{...}
データの種類
- テキスト:「1つの文字」、「もう1!」、...
- 数字文字:0, 34, 3.0, 12.3,…
- ブールテキスト:真、偽
- NULLテキスト:ヌル
- ワードマーク:1、sometext、メイン、...
テキストの操作
- 文字列の連結:+
- 文字通り置き換え:|名前は$ {名前}です|
算術
- 二項演算子:+、 - 、*、/、%
- マイナス(単項): -
ブール演算
- 二項演算子:AND、OR
- ブール否定(単項演算子):!、偽
条件演算子
- 比較値:>、<、> =、<=
- == ,! =:等しく分析
条件付きの
- (あれば)?(次に)
- (あれば)?(当時):(他)
- 三元:(値)?値:DEFAULTVALUE
第五に、表現オブジェクト
巧みにこれらの組み込みクラスを使用して、クラスの日付は時間をフォーマットすることができ、このような表現のツールとして、私たちが表示されるコンテンツに対処できるオブジェクト式は、あなたは、私たちはThymeleafは多くのことを改善し、効率を使用させることができます。
- #ctx:操作現在のコンテキスト。
- #vars:コンテキスト変数を操作します。
- #request:(のみWebプロジェクト用)HttpServletRequestオブジェクト。
- #response:(のみWebプロジェクト用)のHttpServletResponseオブジェクト。
- #session: (仅适用于Web项目) HttpSession 对象.
- #servletContext: (仅适用于Web项目) ServletContext 对象.
表达式实用工具类:
- #execInfo: 操作模板的工具类,包含了一些模板信息,比如:${ #execInfo.templateName }
- #uris: url处理的工具
- #conversions: methods for executing the configured conversion service (if any).
- #dates: 方法来源于 java.util.Date 对象,用于处理时间,比如:格式化.
- #calendars: 类似于 #dates, 但是来自于 java.util.Calendar 对象.
- #numbers: 用于格式化数字.
- #strings: methods for String objects: contains, startsWith, prepending/appending, etc.
- #objects: 普通的object对象方法.
- #bools: 判断bool类型的工具.
- #arrays: 数组操作工具.
- #lists: 列表操作数据.
- #sets: Set操作工具.
- #maps: Map操作工具.
- #aggregates: 操作数组或集合的工具.
六、几种常用的使用方法
1、赋值、字符串拼接
<p th:text="${collect.description}">description</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.title}">Otto</td>
<td th:text="${collect.description}">@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-object 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/javascript/none"
激活,th:inline
可以在父级标签内使用,甚至作为 body 的标签。内联文本尽管比th:text
的代码少,不利于原型显示。
<script th:inline="javascript">
/*<![CDATA[*/
...
var username = /*[[${sesion.user.name}]]*/ 'Sebastian';
var size = /*[[${size}]]*/ 0;
...
/*]]>*/
</script>
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
…
下面用一段代码来举例一些常用的方法:
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)}
七、使用基本步骤
我认为可以大致分为四步:
- pom.xml 添加 Thymeleaf 模板引擎。
- application.yml 配置 Thymeleaf 信息。
- 创建controller类,编写代码。
- 创建模板,编写html代码。
1. pom.xml 添加依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
2. .properties 配置 Thymeleaf 信息
server:
port: 8081
spring:
thymeleaf:
# 是否启用
enabled: true
# 模板编码
encoding: UTF-8
# 模板模式
mode: HTML5
# 模板存放路径
prefix: classpath:/templates/
# 模板后缀
suffix: .html
# 启用缓存,建议生产开启
cache: false
# 校验模板是否存在
check-template-location: true
# Content-type值
servlet:
content-type: text/html
# 加配置静态资源
resources:
static-locations: classpath:/
3. 创建controller类,编写代码
@RequestMapping("/me")
public String kownMe(Map<String,Object> map) {
List<String> list = new ArrayList<String>();
list.add("鸟不拉屎:一个正在努力Coding的未来架构师");
list.add("记录菜鸟的成长");
list.add("个人博客:https://niaobulashi.com");
list.add("github博客:https://niaobulashi.github.io");
map.put("msg", "Yoyoyoyoyo");
map.put("images", "Yoyoyoyoyo");
map.put("lists", list);
return "me";
}
注意:返回的”me″是我HTML文件 me.html的名称哦
4. 创建 page1.html 。编写html代码
只要把写好的HTML页面放在 classpath:/templates/ 下,thymeleaf就能自动渲染。
注意导入:
<html lang="en" xmlns:th="http://www.thymeleaf.org">
否则没提示哦~
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org" >
<head>
<meta charset="UTF-8">
<meta content="text/html;charset=UTF-8"/>
<title>鸟不拉屎</title>
<link rel="stylesheet" href="static/layui/css/layui.css">
</head>
<body>
<div class="layui-container">
<h1>templates示例</h1>
<!-- th:text="" 将h2的文本值视为指定参数 -->
<hr>
<h2 th:text="${msg}">这是h2</h2>
<fieldset class="layui-elem-field layui-field-title" style="margin-top: 20px;">
<legend>循环</legend>
</fieldset>
<table style="text-align: center" class="layui-table" lay-skin="line" >
<colgroup>
<col width="350">
</colgroup>
<thead>
<tr>
<th>NAME</th>
</tr>
</thead>
<tbody>
<!-- th循环遍历传来的参数 -->
<tr th:each="str : ${lists}" >
<th th:text="${str}" ></th>
</tr>
</tbody>
</table>
<img th:src="${images}" >
</div>
</body>
</html>
运行效果(样式用的layUI~~):