Thymeleaf+Spring整合--（附带自己补充）

转载自https://www.cnblogs.com/jiangchao226/p/5937458.html

前言

这个教程介绍了Thymeleaf与Spring框架的集成，特别是SpringMvc框架。

注意Thymeleaf支持同Spring框架的3.和4.版本的集成，但是这两个版本的支持是封装在thymeleaf-spring3和thymeleaf-spring4这两个独立的库中，项目中需要根据实际情况分别引用。

样例代码针对的是spring4.，但一般情况下，spring3.也可以无缝使用，所需要的仅仅是改变一下引用库。

1 Thymeleaf同Spring的整合

Thymeleaf与Spring进行整合后，可以在SpringMVC应用中完全替代JSP文件。

集成后你将：

• 就像控制JSP一样，使用SpringMvc的@Controller注解来映射Thymeleaf的模板文件。
• 在模板中使用SpringEL表达式来替换OGNL
• 在模板中创建的表单，完全支持Beans和结果的绑定，包括使用PropertyEditor，转换，和验证等。
• 可以通过Spring来管理国际化文件显示国际化信息。

注意，在使用本教程之前，您应该充分了解Thymeleaf的标准方言。

2 Spring标准方言

为了更加方便，更快捷的集成，Thymeleaf提供了一套能够与Spring正确工作的特有方言。

这套方言基于Thymeleaf标准方言实现，它在类org.thymeleaf.spring.dialect.SpringStandardDialect中，事实上，他继承于org.thymeleaf.standard.StandardDialect中。

除了已经出现在标准方言中的所有功能，Spring中还有以下特点：

• 不适用OGNL，而是SpringEL做完变量表达式，因此，所有的${...}和*{...}表达式将用Spring的表达式引擎进行处理。
• 访问应用context中的beans可以使用SpringEL语法:${@myBean.doSomething()}
• 基于表格处理的新属性：th:field,th:errors和th:errorclass,除此还有一个th:object的新实现，允许它使用表单命令选择器（？？）。
• 一个新的表达式：#themes.code(...)，相当于jsp自定义标签中的spring:theme。
• 在spring4.0集成中的一个新的表达式:#mvc.uri(...)，相当于jsp自定义标签中的spring:mvcUrl(...)

注意，上述这些方言特性是不能再普通的TemplateEngine对象中使用的，应该配置一个org.thymeleaf.spring4.SpringTemplateEngine来执行。

一个配置的简单例子：

<bean id="templateResolver" class="org.thymeleaf.templateresolver.ServletContextTemplateResolver">
    <property name="prefix" value="/WEB-INF/templates/" />
    <property name="suffix" value=".html" />
</bean>

<bean id="templateEngine"   class="org.thymeleaf.spring4.SpringTemplateEngine">
    <property name="templateResolver" ref="templateResolver" />
</bean>

在thymeleaf3.0版本中已经使用SpringResourceTemplateResolver代替了ServletContextTemplateResolver，由于我使用的是thymeleaf3.0，所以将配置文件中改为了SpringResourceTemplateResolver 

参考springmvc+thymeleaf搭建框架启动报错 这篇文章中作者搭建环境时遇到的问题。

<bean id="templateResolver" class="org.thymeleaf.spring4.templateresolver.SpringResourceTemplateResolver">
         <property name="prefix" value="/WEB-INF/views/" />
         <property name="suffix" value=".html" />
         <property name="templateMode" value="HTML5" />
         <property name="cacheable" value="false" />
</bean>

<bean id="templateEngine" class="org.thymeleaf.spring4.SpringTemplateEngine">
         <property name="templateResolver" ref="templateResolver" />
</bean>

 

视图和视图解释器

SpringMvc中的视图和视图解释器

Spring有两个符合其模板系统核心的接口：

• org.springframework.web.servlet.View
• org.springframework.web.servlet.ViewResolver

视图模型页面在应用中，让我修改和预定义他的行为的页面，可将其作为Bean来定义，视图是负责渲染实际的HTML，通常由一些模板引擎来负责，如JSP和Thymeleaf。

ViewResolvers是一个获取特定操作和语言的视图对象的对象。通常，controller会向ViewResolvers要求转发到一个特定的视图(视图名为控制器返回的字符串)。然后在顺序执行应用中所有的视图解析器，直到有一个能够解析这个视图。在这种情况下，视图对象返回并控制传递给他的一个html渲染相。

注意，在一个应用中，并不是所有的页面都被定义为视图，但是只有那些行为我们希望以特定的方式进行非标准方式操作或者进行特定配置，例如，一些特殊的bean。如果一个ViewResolver请求一个view但没有响应的bean(这是一个常见的情况)，一个新的视图对象将被临时创建并返回。

一个SpringMVC中Jsp+JSTL视图解释器的典型配置如下：

<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
  <property name="viewClass" value="org.springframework.web.servlet.view.JstlView" />
  <property name="prefix" value="/WEB-INF/jsps/" />
  <property name="suffix" value=".jsp" />
  <property name="order" value="2" />
  <property name="viewNames" value="*jsp" />
</bean>

根据他的属性就足够知道他是怎么配置的了：

• viewClass:建立视图实例的类，在JSP解析的时候所必须的，但是现在我们使用Thymeleaf，所以它是不需要的。
• prefix和suffix,和Thymeleaf的TemplateResolver对象的方式一直，设置前缀和后缀属性。
• order：设置在视图解析器查询链中的顺序
• viewNames:允许定义视图名称(可通过通配符)，定义内的视图由视图解析器解析。

  Thymeleaf中的视图和视图解析器

  Thymeleaf和Spring类似，同样是对应两个接口：

• org.thymeleaf.spring4.view.ThymeleafView
• org.thymeleaf.spring4.view.ThymeleafViewResolver

• 这两个类将用于处理控制器返回Thymeleaf执行的结果。

  Thymeleaf视图解析器的配置同样和JSP是非常相似的：

<bean class="org.thymeleaf.spring4.view.ThymeleafViewResolver">
  <property name="templateEngine" ref="templateEngine" />
  <property name="order" value="1" />
  <property name="viewNames" value="*.html,*.xhtml" />
</bean>

ThymeleafViewResolver类部分代码

从对类的注释中可以看出，在Controller执行完之后，会执行ThymeleafViewResolver，它会接收需要处理的视图的名称，并且负责创建相应的对象。

/**
 * <p>
 *   Implementation of the Spring MVC {@link org.springframework.web.servlet.ViewResolver}
 *   interface.
 * </p>
 * <p>
 *   View resolvers execute after the controller ends its execution. They receive the name
 *   of the view to be processed and are in charge of creating (and configuring) the
 *   corresponding {@link View} object for it.
 * </p>
 * <p>
 *   The {@link View} implementations managed by this class are subclasses of 
 *   {@link AbstractThymeleafView}. By default, {@link ThymeleafView} is used.
 * </p>
 * 
 * @author Daniel Fern&aacute;ndez
 * 
 * @since 1.0
 *
 */
public class ThymeleafViewResolver 
        extends AbstractCachingViewResolver 
        implements Ordered {}

它的templateEngin的值当然是前一章定义的SpringTemplateEngin对象，另外两个参数都是可选的，并且也之前的JSP 视图解析器配置的时候参数含义相同

需要注意一点，我们并不需要配置前缀和后缀，因为这些已经在模板解析器中指定，并会依次传递到模板引擎中。

如果我们想定义一个View的bean并设置一些静态变量该如何做呢？很简单：

<bean name="main" class="org.thymeleaf.spring4.view.ThymeleafView">
<property name="staticVariables">
    <map>
    <entry key="footer" value="foot信息" />
    </map>
 </property>
</bean>

模板配置

Spring基础配置

在与Spring配合使用的时候，Thymeleaf提供了ITemplateResolver和与之相关联的IResourceResolver的与Spring资源处理器相结合的实现，这些是：

• org.thymeleaf.spring4.templateresolver.SpringResourceTemplateResolver用于解析模板.
• org.thymeleaf.spring4.resourceresolver.SpringResourceResourceResolver主要供内部使用.

这个模板解析器允许应用使用标准Spring资源解析语法来解析模板程序，它可以这样配置：

<bean id="templateResolver"
  class="org.thymeleaf.spring4.templateresolver.SpringResourceTemplateResolver">
    <property name="suffix" value=".html" />
    <property name="templateMode" value="HTML5" />
</bean>

然后就可以像这样使用视图：

@RequestMapping("/doit")
public String doIt() {
    ...
    return "classpath:resources/templates/doit";
}

注意Spring基础的资源解析器不会被默认使用，它只是一个除了Thymeleaf核心所提供的模板资源解析器之外的模板资源解析器。