Java 开发之旅：Spring Boot 返回 JSP 无效——多模块、Web 启动项与 view.suffix 配置解析

一、引言

作为Java开发者，我们时常需要处理前后端分离的项目架构，其中Spring Boot以其简洁易用性和高度自动化的特点，成为了构建现代Web应用的理想选择。然而，在实际做开发的时候，特别是在捣鼓那些老派的JSP视图渲染，还有跨模块配置这些事儿，咱们有时会遇到一些让人挠头的问题。就比如这次提到的，你设置了`spring.mvc.view.suffix`这个参数却没见生效的情况，是不是挺让人头疼的？接下来，我们将深入剖析这个现象，并给出针对性的解决方案。

二、背景与问题描述

假设我们正在使用Spring Boot构建一个多模块的应用，其中一个模块专门负责Web服务提供，使用了Spring MVC作为控制器及其视图层的框架。为了让HTML模板与Java逻辑更加清晰地分隔，我们在项目的布局中采用了如下结构：

1. `module-core`: 应用的核心业务逻辑和服务模块

2. `module-web`: 启动项，主要包含Web相关的配置与控制层逻辑，依赖于`module-core`

3. `module-views`: 存放JSP视图文件，用于前端展示

在此场景下，为确保正确识别并加载JSP视图，我们需要在`module-web`的配置文件中指定JSP后缀名（`spring.mvc.view.suffix`），例如：

spring:
  mvc:
    view:
      prefix: /WEB-INF/views/
      suffix: .jsp

然而，当运行程序并尝试访问Controller中带有相关视图名称的方法（如`@GetMapping("/home")`映射到`WEB-INF/views/homePage.jsp`）时，浏览器却无法显示出预期的JSP页面内容，且并未抛出任何异常，而是默认返回了空响应或者错误状态码。

三、问题分析与排查

面对这一看似简单的配置失效问题，我们首先需要进行如下几个方面的排查：

1. 检查视图解析器配置

确保视图解析器`org.springframework.web.servlet.view.InternalResourceViewResolver`已被正确注册并设置了`prefix`与`suffix`属性。检查Spring Boot启动类（如`WebMvcConfig.java`或`Application.java`中的`WebMvcConfigurer`实现）：

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
    @Override
    public void configureViewResolvers(ViewResolverRegistry registry) {
        InternalResourceViewResolver resolver = new InternalResourceViewResolver();
        resolver.setPrefix("/WEB-INF/views/");
        resolver.setSuffix(".jsp");
        registry.viewResolver(resolver);
    }
}

2. 模块间依赖与资源路径映射

确认`module-web`是否正确引入了`module-views`的相关JSP文件，并指定了正确的资源路径。查看`module-web`的`pom.xml`或`build.gradle`文件中对视图资源模块的依赖路径：

<!-- Maven -->
<dependencies>
    <dependency>
        <groupId>com.example</groupId>
        <artifactId>module-views</artifactId>
        <version>1.0.0</version>
        <type>war</type>
        <scope>runtime</scope>
        <classifier>classes</classifier>
    </dependency>
</dependencies>
// Gradle
dependencies {
    runtimeOnly 'com.example:module-views:1.0.0'
}

以及主启动类（如`Application.java`)中的静态资源映射配置：

@SpringBootApplication
public class Application {
    @Bean
    TomcatServletWebServerFactory tomcat() {
        TomcatServletWebServerFactory factory = new TomcatServletWebServerFactory();
        factory.addContextCustomizer((TomcatWebServerContext context) -> {
            // 将模块视图目录映射到根URL下
            context.addWelcomeFile("index.jsp");
            WebResourceRoot resourceRoot = new TomcatWebResourceRoot(context, "static", "/");
            resourceRoot.addDirectory(new File("src/main/resources/static"));
            context.setResources(resourceRoot);
        });
        return factory;
    }
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

3. 检查JSP引擎配置

确保Tomcat服务器配置已启用JSP支持。在`module-web`对应的`application.properties`或`application.yml`文件中配置JSP引擎：

server.tomcat.jsp-enabled=true
server.tomcat.jsp.version=2.3

或者在`module-web`的`pom.xml`或`build.gradle`文件中为Tomcat添加Jasper依赖：

<!-- Maven -->
<dependencies>
    <dependency>
        <groupId>org.apache.tomcat.embed</groupId>
        <artifactId>tomcat-embed-jasper</artifactId>
        <scope>provided</scope>
    </dependency>
</dependencies>
// Gradle
dependencies {
    implementation 'org.apache.tomcat.embed:tomcat-embed-jasper:9.0.54'
}

4. 控制器与视图名称匹配验证

在完成上述配置后，请务必核实Controller中返回的视图名称与其实际路径是否一致。如果存在命名冲突或者拼写错误，将会导致Spring MVC无法找到预期的JSP视图：

@GetMapping("/home")
public String home(Model model) {
    return "homePage"; // 视图名称应更改为"WEB-INF/views/homePage.jsp"
}

四、总结与解决办法

综上所述，Spring Boot返回JSP无效的问题可能源于多个因素的叠加效应，包括但不限于视图解析器配置不完整、模块间依赖关系未正确处理、JSP引擎支持未开启、或Controller与视图名称之间的不对应等。要解决这个问题，需从以上几个方面进行逐一排查和修正。
切记，在面对这类问题时，要保持冷静并耐心地定位问题所在，仔细分析配置文件、源代码和日志输出，才能准确找出症结所在，进而成功解决问题。这不仅让我们实实在在地磨炼了编程功夫，更是让咱们对Spring Boot这家伙的工作内幕有了更深的洞察。这样一来，我们在实际项目中遇到问题时，调试和应对的能力都像坐火箭一样嗖嗖提升啦！