标准表达式语法

我们将在杂货虚拟商店的开发中稍作休息，以了解Thymeleaf标准方言中最重要的部分之一：Thymeleaf标准表达式语法。

我们已经看到在这种语法中表达的两种类型的有效属性值：消息和变量表达式：

<p th:utext="#{home.welcome}">Welcome to our grocery store!</p>

<p>Today is: <span th:text="${today}">13 february 2011</span></p>

但是有更多类型的表达式，以及更多有趣的细节来了解我们已经知道的那些。首先，让我们看一下标准表达式功能的快速摘要：

• Simple expressions:

  • Variable Expressions: ${...}
  • Selection Variable Expressions: * {...}
  • Message Expressions: #{...}
  • Link URL Expressions: @{...}
  • 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: _

所有这些功能都可以组合和嵌套：

'User is of type ' + (${user.isAdmin()} ? 'Administrator' : (${user.type} ?: 'Unknown'))

4.1Messages

我们已经知道，#{...}消息表达式允许我们链接：

<p th:utext="#{home.welcome}">Welcome to our grocery store!</p>

.....对此：

home.welcome=¡Bienvenido a nuestra tienda de comestibles!

但是有一个方面我们还没有想到：如果消息文本不是完全静态会发生什么？例如，如果我们的应用程序知道谁是随时访问该网站的用户并且我们想要通过名字问候他们怎么办？

<p>¡Bienvenido a nuestra tienda de comestibles, John Apricot!</p>

这意味着我们需要在消息中添加一个参数。像这样：

home.welcome=¡Bienvenido a nuestra tienda de comestibles, {0}!

参数是根据java.text.MessageFormat标准语法指定的，这意味着您可以格式化为java.text. * 包中的类的API文档中指定的数字和日期。

为了为我们的参数指定一个值，并给定一个调用的HTTP会话属性user，我们可以：

请注意，使用th:utext此处意味着格式化的消息不会被转义。此示例假定user.name已经转义。

可以指定几个参数，以逗号分隔。

消息密钥本身可以来自变量：

<p th:utext="#{${welcomeMsgKey}(${session.user.name})}">
  Welcome to our grocery store, Sebastian Pepper!
</p>

4.2Variables

我们已经提到${...}表达式实际上是在上下文中包含的变量映射上执行的OGNL（对象 - 图形导航语言）表达式。

有关OGNL语法和功能的详细信息，请阅读OGNL语言指南 在Spring支持MVC的应用程序中，OGNL将被SpringEL取代，但其语法与OGNL的语法非常相似（实际上，对于大多数常见情况来说，完全相同）。

从OGNL的语法，我们知道表达式：

<p>Today is: <span th:text="${today}">13 february 2011</span>.</p>

......实际上相当于这个：

ctx.getVariable("today");

但是OGNL允许我们创建更强大的表达式，这就是：

<p th:utext="#{home.welcome(${session.user.name})}">
  Welcome to our grocery store, Sebastian Pepper!
</p>

...通过执行以下命令获取用户名：

((User) ctx.getVariable("session").get("user")).getName();

但是getter方法导航只是OGNL的一个特性。让我们看看更多：

/*
 * Access to properties using the point (.). Equivalent to calling property getters.
 */
${person.father.name}

/*
 * Access to properties can also be made by using brackets ([]) and writing
 * the name of the property as a variable or between single quotes.
 */
${person['father']['name']}

/*
 * If the object is a map, both dot and bracket syntax will be equivalent to
 * executing a call on its get(...) method.
 */
${countriesByCode.ES}
${personsByName['Stephen Zucchini'].age}

/*
 * Indexed access to arrays or collections is also performed with brackets,
 * writing the index without quotes.
 */
${personsArray[0].name}

/*
 * Methods can be called, even with arguments.
 */
${person.createCompleteName()}
${person.createCompleteNameWithSeparator('-')}

Expression Basic Objects

在上下文变量中评估OGNL表达式时，某些对象可用于表达式以获得更高的灵活性。将以#符号开头引用这些对象（按照OGNL标准）：

• #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.

所以我们可以这样做：

Established locale country: <span th:text="${#locale.country}">US</span>.

您可以在附录A中阅读这些对象的完整参考。

Expression Utility Objects

除了这些基本对象，Thymeleaf还将为我们提供一组实用程序对象，帮助我们在表达式中执行常见任务。

• #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).

您可以在附录B中查看每个实用程序对象提供的功能。

Reformatting dates in our home page

现在我们知道这些实用程序对象，我们可以使用它们来改变我们在主页中显示日期的方式。而不是在我们这样做HomeController：

SimpleDateFormat dateFormat = new SimpleDateFormat("dd MMMM yyyy");
Calendar cal = Calendar.getInstance();

WebContext ctx = new WebContext(request, servletContext, request.getLocale());
ctx.setVariable("today", dateFormat.format(cal.getTime()));

templateEngine.process("home", ctx, response.getWriter());

......我们可以做到这一点：

WebContext ctx =
    new WebContext(request, response, servletContext, request.getLocale());
ctx.setVariable("today", Calendar.getInstance());

templateEngine.process("home", ctx, response.getWriter());

...然后在视图层本身中执行日期格式设置：

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

4.3 Expressions on selections (asterisk syntax)

变量表达式不仅可以写成${...}，也可以作为*{...}。

但是有一个重要的区别：星号语法评估所选对象上的表达式而不是整个上下文。也就是说，只要没有选定的对象，美元和星号语法就会完全相同。

什么是选定的对象？使用th:object属性的表达式的结果。我们在用户个人资料（userprofile.html）页面中使用一个：

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

当对象选择到位时，所选对象也可用作美元表达式作为#object表达式变量：

<div th:object="${session.user}">
  <p>Name: <span th:text="${#object.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>

4.4Link URLs

由于它们的重要性，URL是Web应用程序模板中的一等公民，而Thymeleaf标准方言具有特殊的语法，@语法：@{...}

有不同类型的网址：

• Absolute URLs: http://www.thymeleaf.org
• Relative URLs, which can be:
  • Page-relative: user/login.html
  • Context-relative: /itemdetails?id=3 (context name in server will be added automatically)
  • Server-relative: ~/billing/processInvoice (allows calling URLs in another context (= application) in the same server.
  • Protocol-relative URLs: //code.jquery.com/jquery-2.0.3.min.js

这些表达式的实际处理及其转换为将要输出的URL是通过org.thymeleaf.linkbuilder.ILinkBuilder注册到ITemplateEngine正在使用的对象中的接口的实现来完成的。

默认情况下，此接口的单个​​实现是在类中注册的org.thymeleaf.linkbuilder.StandardLinkBuilder，这对于脱机（非Web）以及基于Servlet API的Web方案都是足够的。其他方案（例如与非ServletAPI Web框架的集成）可能需要链接构建器接口的特定实现。

让我们使用这种新语法。符合th:href属性：

<!-- Will produce 'http://localhost:8080/gtvg/order/details?orderId=3' (plus rewriting) -->
<a href="details.html"
   th:href="@{http://localhost:8080/gtvg/order/details(orderId=${o.id})}">view</a>

<!-- Will produce '/gtvg/order/details?orderId=3' (plus rewriting) -->
<a href="details.html" th:href="@{/order/details(orderId=${o.id})}">view</a>

<!-- Will produce '/gtvg/order/3/details' (plus rewriting) -->
<a href="details.html" th:href="@{/order/{orderId}/details(orderId=${o.id})}">view</a>

有些事情需要注意：

• th:href是一个修饰符属性：一旦处理，它将计算要使用的链接URL并将该值设置href为标记的属性。
• 我们可以使用表达式来指定URL参数（如您所见orderId=${o.id}）。还将自动执行所需的URL参数编码操作。
• 如果需要几个参数，这些参数将用逗号分隔： @{/order/process(execId=${execId},execType='FAST')}
• URL路径中也允许使用变量模板： @{/order/{orderId}/details(orderId=${orderId})}
• 以/（例如:)开头的相对URL /order/details将自动以应用程序上下文名称为前缀。
• 如果未启用cookie或尚未知道cookie，则";jsessionid=..."可能会在相对URL中添加后缀，以便保留会话。这称为URL重写，Thymeleaf允许您通过response.encodeURL(...)Servlet API为每个URL 插入自己的重写过滤器。
• 该th:href属性允许我们（可选）href在我们的模板中具有工作静态属性，以便我们的模板链接在直接打开以进行原型设计时仍可由浏览器导航。

<a th:href="@{${url}(orderId=${o.id})}">view</a>
<a th:href="@{'/details/'+${user.login}(orderId=${o.id})}">view</a>

<p>Please select an option</p>
<ol>
  <li><a href="product/list.html" th:href="@{/product/list}">Product List</a></li>
  <li><a href="order/list.html" th:href="@{/order/list}">Order List</a></li>
  <li><a href="subscribe.html" th:href="@{/subscribe}">Subscribe to our Newsletter</a></li>
  <li><a href="userprofile.html" th:href="@{/userprofile}">See User Profile</a></li>
</ol>

<div th:insert="~{commons :: main}">...</div>

<div th:with="frag=~{footer :: #main/text()}">
  <p th:insert="${frag}">
</div>

<p>
  Now you are looking at a <span th:text="'working web application'">template file</span>.
</p>

<p>The year is <span th:text="2013">1492</span>.</p>
<p>In two years, it will be <span th:text="2013 + 2">1494</span>.</p>

<div th:if="${user.isAdmin()} == false"> ...

<div th:if="${user.isAdmin() == false}"> ...

<div th:if="${variable.something} == null"> ...

<div th:class="content">...</div>

<div th:class="'content'">...</div>

<span th:text="'The name of the user is ' + ${user.name}">

<span th:text="|Welcome to our application, ${user.name}!|">

<span th:text="'Welcome to our application, ' + ${user.name} + '!'">

<span th:text="${onevar} + ' ' + |${twovar}, ${threevar}|">

<div th:with="isEven=(${prodStat.count} % 2 == 0)">

<div th:with="isEven=${prodStat.count % 2 == 0}">

<div th:if="${prodStat.count} &gt; 1">
<span th:text="'Execution mode is ' + ( (${execMode} == 'dev')? 'Development' : 'Production')">

<tr th:class="${row.even}? 'even' : 'odd'">
  ...
</tr>

<tr th:class="${row.even}? (${row.first}? 'first' : 'even') : 'odd'">
  ...
</tr>

<tr th:class="${row.even}? 'alt'">
  ...
</tr>

<div th:object="${session.user}">
  ...
  <p>Age: <span th:text="*{age}?: '(no age specified)'">27</span>.</p>
</div>

<p>Age: <span th:text="*{age != null}? *{age} : '(no age specified)'">27</span>.</p>

<p>
  Name:
  <span th:text="*{firstName}?: (*{admin}? 'Admin' : #{default.username})">Sebastian</span>
</p>

<span th:text="${user.name} ?: 'no user authenticated'">...</span>

<span th:text="${user.name} ?: _">no user authenticated</span>

<td th:text="${{user.lastAccessDate}}">...</td>

article.text=@myapp.translator.Translator@translateToFrench({0})

article.text=@myapp.translator.Translator@translateToSpanish({0})

<p th:text="${__ #{article.text('textVar')}__ }">Some text here...</p>

<p th:text="${@myapp.translator.Translator@translateToFrench(textVar)}">Some text here...</p>