在 Spring Boot 中使用 JSP 的完整指南

在 Spring Boot 项目中,使用 JSP 技术可能遇到一些配置和限制问题,特别是与内嵌 Servlet 容器相关。本文档旨在帮助开发者正确配置 Maven 项目,设置必要的属性,并解决常见的 JSP 相关问题。同时,也建议开发者考虑使用更现代化的模板引擎以获得更好的开发体验。

Spring Boot 中 JSP 的配置

在 S

pring Boot 中使用 JSP,需要进行一些配置才能正常工作。以下步骤将引导你完成配置过程。

  1. 修改 pom.xml 文件

    首先,需要将项目的打包方式从 jar 修改为 war。这是因为 Spring Boot 内嵌 Servlet 容器(如 Tomcat 或 Jetty)对 JSP 的支持在 war 打包方式下更好。

    在 pom.xml 文件中,添加或修改 标签:

    
        ...
        war
        ...
    
  2. 添加必要的依赖

    确保 pom.xml 文件中包含以下依赖项,这些依赖项对于 JSP 的编译和运行至关重要:

    
        org.apache.tomcat.embed
        tomcat-embed-jasper
    
    
        javax.servlet
        jstl
    

    请注意,tomcat-embed-jasper 依赖通常应该具有 provided 作用域,尤其是在部署到外部容器时。

    
        org.springframework.boot
        spring-boot-starter-tomcat
        provided
    
  3. 配置 JSP 视图解析器

    在 application.properties 或 application.yml 文件中,配置 Spring MVC 的视图解析器,指定 JSP 文件的位置和后缀名:

    spring.mvc.view.prefix=/webapp/WEB-INF/jsp/
    spring.mvc.view.suffix=.jsp

    这里,spring.mvc.view.prefix 指定了 JSP 文件存放的目录,spring.mvc.view.suffix 指定了 JSP 文件的后缀名。

  4. 创建 JSP 文件目录

    根据 spring.mvc.view.prefix 配置的路径,创建相应的目录结构。通常,JSP 文件应该放在 src/main/webapp/WEB-INF/jsp/ 目录下。 确保 webapp 目录位于 src/main 目录下。

  5. 编写 Controller

    创建一个 Spring MVC Controller,用于处理请求并返回 JSP 视图:

    @Controller
    public class FirstController {
        @GetMapping("/")
        public String sayHello() {
            return "hello"; // 返回的视图名称,对应 /webapp/WEB-INF/jsp/hello.jsp
        }
    }
  6. 创建 JSP 视图文件

    在 src/main/webapp/WEB-INF/jsp/ 目录下创建一个名为 hello.jsp 的文件,内容如下:

    <%@ page contentType="text/html;charset=UTF-8" language="java" %>
    
    
        Hello JSP
    
    
        

    Hello, World!

注意事项和限制

  • 内嵌 Servlet 容器的限制

    当 Spring Boot 应用使用内嵌 Servlet 容器并打包成可执行的 jar 文件时,JSP 的支持会受到限制。官方文档建议使用 war 打包方式来解决这个问题。

  • Undertow 不支持 JSP

    如果使用 Undertow 作为内嵌 Servlet 容器,则不支持 JSP。

  • 自定义错误页面

    创建自定义的 error.jsp 页面可能无法覆盖默认的错误处理视图。建议使用自定义错误页面来处理错误。

总结与建议

虽然可以在 Spring Boot 中使用 JSP,但由于其固有的限制和维护成本,建议考虑使用更现代化的模板引擎,如 Thymeleaf 或 FreeMarker。这些模板引擎提供了更强大的功能和更好的集成,可以提高开发效率和代码质量。

总之,在 Spring Boot 中使用 JSP 需要进行正确的配置和了解其限制。希望本文档能够帮助你成功配置和使用 JSP,或者引导你选择更合适的替代方案。