Thymeleaf是一个java模板引擎,它在独立和Web应用程序中处理六种模板(HTML,CSS,TEXT,JAVASCRIPT,CSS和RAW)。

在这篇文章中,我们来学习如何在Spring MVC应用程序中配置Thymeleaf模板。

本例中使用的工具和技术是 -

  • Spring MVC 5.0.3.RELEASE
  • Servlet API 4.0.0
  • Thymeleaf 3.0.9.RELEASE
  • Java SE 8
  • Maven 3.5.2
  • Jetty Maven plugin 9.4.8
  • Eclipse Oxygen.2 Release (4.7.2) 下面将要编写一个简单的Spring MVC应用程序,它将打印输出“Hello Spring MVC 5!”

第1步 - 使用Maven创建Web项目

首先,用war包装创建一个maven项目。可以参考这篇文章来学习 - 如何在Eclipse IDE中创建一个Maven Web应用程序

应用程序的最终项目结构如下所示 -

1523793424335973.png

第2步 - 添加Jar依赖关系

要在Spring MVC应用程序中使用Thymeleaf,需要添加thymeleaf-spring5作为类路径的依赖关系。

打开Maven项目中的pom.xml文件,并在其中添加以下jar包依赖项。

  1. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  2. xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  3. <modelVersion>4.0.0</modelVersion>
  4. <groupId>com.e-learn</groupId>
  5. <artifactId>springmvc5thymeleaf</artifactId>
  6. <version>0.0.1-SNAPSHOT</version>
  7. <packaging>war</packaging>
  8. <name>Spring MVC - Thymeleaf Integration example</name>
  9.  
  10. <properties>
  11. <failOnMissingWebXml>false</failOnMissingWebXml>
  12. <maven.compiler.source>8</maven.compiler.source>
  13. <maven.compiler.target>8</maven.compiler.target>
  14. </properties>
  15.  
  16. <dependencies>
  17. <dependency>
  18. <groupId>org.springframework</groupId>
  19. <artifactId>spring-webmvc</artifactId>
  20. <version>5.0.3.RELEASE</version>
  21. </dependency>
  22. <dependency>
  23. <groupId>org.thymeleaf</groupId>
  24. <artifactId>thymeleaf-spring5</artifactId>
  25. <version>3.0.9.RELEASE</version>
  26. </dependency>
  27. <dependency>
  28. <groupId>javax.servlet</groupId>
  29. <artifactId>javax.servlet-api</artifactId>
  30. <version>4.0.0</version>
  31. <scope>provided</scope>
  32. </dependency>
  33. </dependencies>
  34. <build>
  35. <plugins>
  36. <!-- Embedded Apache Tomcat required for testing war -->
  37.  
  38. <plugin>
  39. <groupId>org.eclipse.jetty</groupId>
  40. <artifactId>jetty-maven-plugin</artifactId>
  41. <version>9.4.8.v20171121</version>
  42. </plugin>
  43. </plugins>
  44. </build>
  45. </project>

第3步 - Spring MVC配置

com.e-learn.spring.config包下创建一个名为MvcWebConfig@Configuration类。

要在Spring MVC中注册Thymeleaf视图,需要按如下方式定义SpringResourceTemplateResolverSpringTemplateEngine bean方法,如下 -

文件: MvcWebConfig.java -

  1. package com.e-learn.spring.config;
  2.  
  3. import org.springframework.beans.factory.annotation.Autowired;
  4. import org.springframework.context.ApplicationContext;
  5. import org.springframework.context.annotation.Bean;
  6. import org.springframework.context.annotation.ComponentScan;
  7. import org.springframework.context.annotation.Configuration;
  8. import org.springframework.web.servlet.config.annotation.EnableWebMvc;
  9. import org.springframework.web.servlet.config.annotation.ViewResolverRegistry;
  10. import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
  11. import org.thymeleaf.spring5.SpringTemplateEngine;
  12. import org.thymeleaf.spring5.templateresolver.SpringResourceTemplateResolver;
  13. import org.thymeleaf.spring5.view.ThymeleafViewResolver;
  14.  
  15. @Configuration
  16. @EnableWebMvc
  17. @ComponentScan("com.e-learn.spring.controller")
  18. public class MvcWebConfig implements WebMvcConfigurer {
  19.  
  20. @Autowired
  21. private ApplicationContext applicationContext;
  22.  
  23. /*
  24. * STEP 1 - Create SpringResourceTemplateResolver
  25. * */
  26. @Bean
  27. public SpringResourceTemplateResolver templateResolver() {
  28. SpringResourceTemplateResolver templateResolver = new SpringResourceTemplateResolver();
  29. templateResolver.setCharacterEncoding("UTF-8");
  30. templateResolver.setApplicationContext(applicationContext);
  31. templateResolver.setPrefix("/WEB-INF/views/");
  32. templateResolver.setSuffix(".html");
  33. return templateResolver;
  34. }
  35.  
  36. /*
  37. * STEP 2 - Create SpringTemplateEngine
  38. * */
  39. @Bean
  40. public SpringTemplateEngine templateEngine() {
  41. SpringTemplateEngine templateEngine = new SpringTemplateEngine();
  42. templateEngine.setTemplateResolver(templateResolver());
  43. templateEngine.setEnableSpringELCompiler(true);
  44.  
  45. return templateEngine;
  46. }
  47.  
  48. /*
  49. * STEP 3 - Register ThymeleafViewResolver
  50. * */
  51. @Override
  52. public void configureViewResolvers(ViewResolverRegistry registry) {
  53. ThymeleafViewResolver resolver = new ThymeleafViewResolver();
  54. resolver.setTemplateEngine(templateEngine());
  55. registry.viewResolver(resolver);
  56. }
  57.  
  58. }

WebMvcConfigurer接口提供了用于为Spring MVC应用程序定制基于java的配置的默认方法。

@EnableWebMvc注释用于从WebMvcConfigurationSupport(基于Java的MVC配置背后的主类)导入Spring MVC配置。

@ComponentScan扫描basePackages属性指定的包中的构造型注释(@Controller@Service等等)。

SpringResourceTemplateResolver与Spring自己的资源解析基础结构集成。可以使用它来指定模板的位置,模板的模式,缓存过期的TTL等。

SpringTemplateEngine使用SpringStandardDialect,并支持Spring自己的MessageSource消息解析机制解析机制。

在Spring MVC中,需要声明和映射DispatcherServlet,以便使用java或web.xml配置来处理所有请求。

在Servlet 3.0+环境中,可以使用AbstractAnnotationConfigDispatcherServletInitializer类以编程方式注册和初始化DispatcherServlet,文件:MvcWebApplicationInitializer.java -

  1. package com.e-learn.spring.config;
  2.  
  3. import org.springframework.web.servlet.support.AbstractAnnotationConfigDispatcherServletInitializer;
  4.  
  5. public class MvcWebApplicationInitializer extends AbstractAnnotationConfigDispatcherServletInitializer {
  6.  
  7. @Override
  8. protected Class<?>[] getRootConfigClasses() {
  9. return null;
  10. }
  11.  
  12. @Override
  13. protected Class<?>[] getServletConfigClasses() {
  14. return new Class[] { MvcWebConfig.class };
  15. }
  16.  
  17. @Override
  18. protected String[] getServletMappings() {
  19. return new String[] { "/" };
  20. }
  21.  
  22. }

第4步 - 创建Thymeleaf模板/视图

src/main/webapp/WEB-INF/views文件夹下创建一个index.html文件,并在其中写入以下代码。

  1. <!DOCTYPE html>
  2. <html xmlns:th="http://www.thymeleaf.org">
  3. <head>
  4. <meta charset="UTF-8">
  5. <title>SpringMVC5+Thymeleaf示例</title>
  6. </head>
  7. <body>
  8. <h1>Spring MVC + Thymeleaf Hello World example</h1>
  9. <p th:text="${message}"></p>
  10. </body>
  11. </html>

属性th:text =""被称为标准方言,用${…}标准表达式来评估对象。

第5步 - 创建控制器

com.e-learn.spring.controller包下创建一个@Controller类,并在其中写入下面的代码,文件:MyController.java -

  1. package com.e-learn.spring.controller;
  2.  
  3. import org.springframework.stereotype.Controller;
  4. import org.springframework.ui.Model;
  5. import org.springframework.web.bind.annotation.GetMapping;
  6.  
  7. @Controller
  8. public class MyController {
  9.  
  10. @GetMapping("/")
  11. public String index(Model model) {
  12. model.addAttribute("message", "Hello Spring MVC 5!");
  13. return "index";
  14. }
  15. }

第6步 - 运行应用程序

使用以下maven命令来运行您的应用程序。

mvn jetty:run(该命令从其源代码部署webapp,而不是构建war)。

在浏览器的地址栏中输入:http:// localhost:8080 来测试应用程序。如果一切正常,应该会看到类似下面的页面 -

QQ截图20190924132105.jpg

在接下来的Thymeleaf基础标签应用,大部分是基于此应用讲解。