Thymeleaf教程：表达式基本对象详解

概述

在Thymeleaf模板引擎中，表达式基本对象是开发过程中经常使用的重要工具。这些对象提供了访问各种上下文信息的便捷方式，包括请求参数、会话属性、应用上下文等。本文将详细介绍Thymeleaf中可用的基本对象及其使用方法。

上下文对象

#ctx对象

#ctx是Thymeleaf中最核心的上下文对象，它代表了当前模板执行的上下文环境。根据应用类型不同，它可能是IContext或IWebContext的实现：

${#ctx.locale}  // 获取当前Locale
${#ctx.variableNames}  // 获取所有变量名

在Web环境中，还可以访问更多属性：

${#ctx.request}  // 获取HttpServletRequest对象
${#ctx.response}  // 获取HttpServletResponse对象
${#ctx.session}  // 获取HttpSession对象
${#ctx.servletContext}  // 获取ServletContext对象

注意：虽然#vars和#root是#ctx的同义词，但官方推荐使用#ctx以获得更好的代码可读性。

#locale对象

#locale提供了对当前请求Locale的直接访问：

${#locale}  // 获取当前Locale对象

Web上下文命名空间

Thymeleaf为Web环境提供了一系列特殊的命名空间，用于简化常见Web对象的访问。

param命名空间

param命名空间用于访问请求参数，返回的是String数组：

${param.foo}  // 获取名为foo的请求参数数组
${param.foo[0]}  // 获取第一个foo参数值
${param.size()}  // 获取参数数量
${param.isEmpty()}  // 判断参数是否为空
${param.containsKey('foo')}  // 检查是否存在foo参数

session命名空间

session命名空间用于访问会话属性：

${session.foo}  // 获取名为foo的会话属性
${session.size()}  // 获取会话属性数量
${session.isEmpty()}  // 判断会话是否为空
${session.containsKey('foo')}  // 检查是否存在foo属性

application命名空间

application命名空间用于访问ServletContext属性：

${application.foo}  // 获取名为foo的应用属性
${application.size()}  // 获取应用属性数量
${application.isEmpty()}  // 判断应用属性是否为空
${application.containsKey('foo')}  // 检查是否存在foo属性

请求属性访问

请求属性可以直接访问，无需使用特定命名空间：

${myRequestAttribute}  // 直接访问请求属性

Web上下文对象

除了命名空间外，Thymeleaf还提供了直接访问底层Web对象的途径。

#request对象

#request提供了对HttpServletRequest的直接访问：

${#request.getAttribute('foo')}  // 获取请求属性
${#request.getParameter('foo')}  // 获取请求参数
${#request.getContextPath()}  // 获取上下文路径
${#request.getRequestName()}  // 获取请求名称

#session对象

#session提供了对HttpSession的直接访问：

${#session.getAttribute('foo')}  // 获取会话属性
${#session.id}  // 获取会话ID
${#session.lastAccessedTime}  // 获取最后访问时间

#servletContext对象

#servletContext提供了对ServletContext的直接访问：

${#servletContext.getAttribute('foo')}  // 获取应用属性
${#servletContext.contextPath}  // 获取应用上下文路径

最佳实践

1. 优先使用命名空间：对于简单的属性访问，使用param、session和application命名空间比直接访问底层对象更简洁。

2. 复杂操作使用直接对象：当需要进行复杂操作时，再使用#request、#session等直接对象访问方法。

3. 注意作用域：明确区分请求参数、请求属性、会话属性和应用属性的不同作用域。

4. 类型安全：访问对象属性时要注意类型转换，必要时使用Thymeleaf的类型转换工具。

通过熟练掌握这些表达式基本对象，可以大大提高Thymeleaf模板开发的效率和灵活性。