正文

spring整合thymeleaf

IP云
IP云V管理员/7 阅读
08/14
提示：扫一扫查出行
【扫一扫了解最新限行尾号】
复制提示

官方文档入口：https://www.thymeleaf.org/doc/tutorials/2.1/thymeleafspring.html

1、首先需要引入thymeleaf的依赖（据官网文档，thymeleaf-spring3与thymeleaf-spring4用法基本一致）

<dependency> <groupId>org.thymeleaf</groupId> <artifactId>thymeleaf-spring4</artifactId> <version>3.0.11.RELEASE</version></dependency>

2、配置thymeleaf的模板解析器、模板引擎与视图解析器

官方文档以xml作为配置方法，因为不是很方便，此处使用java方式进行配置

package com.example.demo.config;import javax.servlet.ServletContext;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.ComponentScan;import org.springframework.web.context.ServletContextAware;import org.thymeleaf.spring4.SpringTemplateEngine;import org.thymeleaf.spring4.view.ThymeleafViewResolver;import org.thymeleaf.templateresolver.ServletContextTemplateResolver;@ComponentScan(basePackages="com.example.demo.controller")public class ServletConfig implements ServletContextAware { private ServletContext servletContext; @Override public void setServletContext(ServletContext servletContext) { this.servletContext = servletContext; } /* 加载thymeleaf模板 */ @Bean public ServletContextTemplateResolver templateResolver() { ServletContextTemplateResolver resolver = new ServletContextTemplateResolver(this.servletContext); resolver.setPrefix("/WEB-INF/templates/"); resolver.setSuffix(".html"); resolver.setTemplateMode(TemplateMode.HTML); resolver.setCharacterEncoding("UTF-8"); resolver.setCacheable(true); return resolver; }

/* 模板引擎，渲染并返回结果 */ @Bean public SpringTemplateEngine templateEngine() { SpringTemplateEngine templateEngine = new SpringTemplateEngine(); templateEngine.setTemplateResolver(templateResolver()); templateEngine.setEnableSpringELCompiler(true); return templateEngine; } /* 视图解析器 */ @Bean public ThymeleafViewResolver viewResolver() { ThymeleafViewResolver viewResolver = new ThymeleafViewResolver(); viewResolver.setTemplateEngine(templateEngine()); viewResolver.setCharacterEncoding("UTF-8"); return viewResolver; }}

在配置模板解析器的时候，我选择的是实现ServletContextAware接口以获取ServletContext，并以此为参数创建ServletContextTemplateResolver。此处应该还可以用另一种方式进行配置：

public class WebConfig implements ApplicationContextAware{ private ApplicationContext applicationContext; public void setApplicationContext(ApplicationContext applicationContext) throws BeansException { this.applicationContext = applicationContext; } //加载 Thymeleaf 模板 @Bean public SpringResourceTemplateResolver templateResolver() { SpringResourceTemplateResolver templateResolver = new SpringResourceTemplateResolver(); templateResolver.setApplicationContext(this.applicationContext); templateResolver.setPrefix("/WEB-INF/templates/"); templateResolver.setSuffix(".html"); return templateResolver; }}

3、测试：

@RequestMapping("/test") public String test(Model model) throws IOException { List<User> userList = baseService.queryUsers(); model.addAttribute("userList", userList); return "test"; }

<!DOCTYPE html><html><head><meta charset="UTF-8"><title>测试页面</title></head><body> <ul th:each="prop : ${userList}"> <li th:text="${prop.userName}"></li> </ul></body></html>

4、此外，html页面常需要引入静态文件，为了饮用方便以及避免静态文件路径错误导致的异常，需要通过WebMvcConfigurer接口设置静态文件的根路径，避免路径错误导致的异常

@EnableWebMvcpublic class ServletConfig implements WebMvcConfigurer,ServletContextAware { public void addResourceHandlers(ResourceHandlerRegistry registry) { registry.addResourceHandler("/static/**").addResourceLocations("/WEB-INF/templates/static/"); }}

注：需要在类上加入@EnableWebMvc注解表示启用java config，否则此方法不会生效。