Thymeleaf与JSP在Spring Boot项目中的混合使用实践

前言

在现代Java Web开发中，模板引擎的选择是一个重要决策。Thymeleaf作为Spring官方推荐的模板引擎，以其自然模板和强大的功能受到开发者青睐，而传统的JSP技术在一些遗留系统中仍然广泛使用。本文将详细介绍如何在Spring Boot项目中同时配置和使用Thymeleaf和JSP两种视图技术。

技术背景

Thymeleaf是一个现代化的服务器端Java模板引擎，支持HTML、XML、JavaScript等多种模板模式。它最大的特点是能够直接在浏览器中打开模板文件而不会报错，这得益于它的"自然模板"特性。JSP(JavaServer Pages)则是Java EE规范中的传统视图技术，基于Servlet实现，使用JSTL标签库进行逻辑控制。

配置方案

1. 项目结构准备

首先需要确保项目采用传统的WAR包结构，在src/main下创建webapp目录作为Web资源根目录。模板文件(.html)和JSP文件(.jsp)都应放置在此目录下。

2. 依赖配置

在pom.xml中需要同时添加Thymeleaf和JSP相关的依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
<dependency>
    <groupId>org.apache.tomcat.embed</groupId>
    <artifactId>tomcat-embed-jasper</artifactId>
    <scope>provided</scope>
</dependency>
<dependency>
    <groupId>javax.servlet</groupId>
    <artifactId>jstl</artifactId>
</dependency>

3. 视图解析器配置

核心在于配置两个视图解析器，并确保它们能协同工作：

@Autowired
WebApplicationContext webApplicationContext;

@Bean
public SpringResourceTemplateResolver thymeleafTemplateResolver(){
    SpringResourceTemplateResolver templateResolver = new SpringResourceTemplateResolver();
    templateResolver.setApplicationContext(webApplicationContext);
    templateResolver.setOrder(9);  // 设置优先级
    templateResolver.setPrefix("/"); // 从webapp根目录查找
    templateResolver.setSuffix("");  // 不设置默认后缀
    return templateResolver;
}

@Bean
public SpringTemplateEngine templateEngine() {
    SpringTemplateEngine springTemplateEngine = new SpringTemplateEngine();
    springTemplateEngine.setTemplateResolver(thymeleafTemplateResolver());
    springTemplateEngine.setEnableSpringELCompiler(true);
    return springTemplateEngine;
}

@Bean
public ThymeleafViewResolver thymeleafViewResolver(){
    final ThymeleafViewResolver viewResolver = new ThymeleafViewResolver();
    viewResolver.setViewNames(new String[] {"*.html"});  // 只处理.html文件
    viewResolver.setExcludedViewNames(new String[] {"*.jsp"});  // 排除.jsp文件
    viewResolver.setTemplateEngine(templateEngine());
    viewResolver.setCharacterEncoding("UTF-8");
    return viewResolver;
}

@Bean
public InternalResourceViewResolver jspViewResolver(){
    final InternalResourceViewResolver viewResolver = new InternalResourceViewResolver();
    viewResolver.setOrder(10);  // 优先级低于Thymeleaf
    viewResolver.setViewClass(JstlView.class);
    viewResolver.setPrefix("/");  // 从webapp根目录查找
    viewResolver.setSuffix("");  // 不设置默认后缀
    viewResolver.setViewNames("*.jsp");  // 只处理.jsp文件
    return viewResolver;
}

关键配置解析

1. 优先级设置：通过setOrder()方法确保视图解析器按预期顺序工作，数字越小优先级越高。这里Thymeleaf(9)比JSP(10)优先级高。

2. 视图名称过滤：通过setViewNames()和setExcludedViewNames()精确控制每种解析器处理的文件类型，避免冲突。

3. 路径配置：将prefix都设置为"/"，意味着模板文件直接放在webapp目录下，也可以根据需要设置为子目录。

4. 后缀处理：不设置默认后缀，而是在控制器中返回完整文件名，如"user-form.jsp"或"index.html"。

控制器示例

@Controller
public class WebController {
    
    @GetMapping("/positions")
    public String showPositions() {
        return "positions.html";  // 使用Thymeleaf渲染
    }
    
    @GetMapping("/user2")
    public String showUser2() {
        return "user-form.jsp";  // 使用JSP渲染
    }
}

最佳实践建议

1. 文件组织：虽然可以直接放在webapp根目录，但建议按类型建立子目录，如/webapp/html/和/webapp/jsp/，提高可维护性。

2. 统一编码：确保所有模板文件使用UTF-8编码，避免乱码问题。

3. 性能考虑：Thymeleaf模板在开发期间可以关闭缓存，生产环境务必开启。

4. 逐步迁移：对于从JSP迁移到Thymeleaf的项目，这种混合方案可以作为过渡策略。

常见问题解决

1. JSP标签不生效：确保已正确配置JSTL依赖，并在JSP文件中正确引入标签库。

2. 模板文件找不到：检查文件是否放在正确目录，以及视图解析器的prefix配置。

3. 渲染结果不符合预期：确认视图解析器的order设置是否正确，以及viewNames是否准确匹配。

总结

通过合理配置多个视图解析器，Spring Boot项目可以同时支持Thymeleaf和JSP两种视图技术。这种方案特别适合需要逐步迁移的项目或需要同时维护两种技术的场景。关键在于正确设置解析器的优先级和文件类型过滤规则，避免冲突。随着现代前端技术的发展，建议新项目优先考虑Thymeleaf或其他现代模板引擎，以获得更好的开发体验和功能支持。