说说在 Spring Boot 中如何集成 JSP 视图技术

2024-01-21 18:20:34

文章目录

有的项目比较老，用的视图技术还是 JSP，现在要求把这些老项目都转为 Spring Boot 项目，这样可以打包成 Docker 镜像，然后部署到容器中进行管理。

为了方便说明、验证。我们新建了一个 Spring Boot 项目。然后把 JSP 视图技术集成进来。具体步骤¹如下：

1 加入 JSP 依赖包

首先在 pom 中加入 JSP 支持包：

<dependency>
    <groupId>org.apache.tomcat.embed</groupId>
    <artifactId>tomcat-embed-jasper</artifactId>
</dependency>

因为 Spring Boot 内置的 tomcat 不包含对 JSP 的支持，所以需要显式引入工程。

如果工程需要在外部 servlet 服务器运行，那就必须加上<scope>provided</scope>，这样不会产生 JSP 包冲突问题，因为外部 servlet 服务器本身已经存在 JSP 支持包。

dependency 的 scope 有四种类型²：

scope	说明
test	在测试范围内有效，在编译和打包时不会加入该依赖。
compile	在编译范围内有效，在编译和打包时会加入该依赖。
provided	在编译和测试范围内有效，打包时不会加入该依赖。
runtime	在运行时范围有效，在编译和打包时不会加入该依赖。

2 配置 resource

如果未配置 <resources> 节点，Maven 会启动默认设置。Maven 的默认设置是³：

源文件路径	目标文件路径	说明
src/main/java	target/classes	comile 阶段进行编译，然后拷贝到目标路径。
src/test/java	targe/test-classes	test-comiple 阶段进行编译，然后拷贝到目标路径。
src/main/resouces	target/classes	路径下的所有文件拷贝到目标路径。
src/test/resources	targe/test-classes	路径下的所有文件拷贝到目标路径。

我们在 pom.xml 的 <build> 节点加入以下配置：

<resources>
    <resource>
        <!--jsp 源文件路径-->
        <directory>src/main/webapp</directory>
        <!--jsp 目标文件路径-->
        <targetPath>META-INF/resources</targetPath>
        <!--需要拷贝的文件名表达式-->
        <includes>
            <include>*.*</include>
        </includes>
    </resource>
</resources>

3 配置视图解析器

在 application.yml 中配置 JSP 视图解析器：

spring:
  mvc:
    # 配置视图解析器
    view:
      prefix: /
      suffix: .jsp

为了安全性，实际应用时更多地是把 jsp 页面配置到 WEB-INF 内，比如放在 /WEB-INF/views/ 文件夹下。这时我们只需修改 prefix 路径即可：

spring:
  mvc:
    # 配置视图解析器
    view:
      prefix: /WEB-INF/views/
      suffix: .jsp

4 配置 webapp 文件夹与 web.xml

在 IDEA 中要确保这个工程正确配置了 webapp 文件夹与 web.xml，形如：

5 新建 JSP

在 webapp 下新建一个 jsp 页面，内容为：

<%@ page contentType="text/html;charset=utf-8" %>
<html>
<body>
<h3>${msg}</h3>
</body>
</html>

6 配置依赖

在 pom.xml 中添加以下依赖：

		<!--web 应用 begin-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--web 应用 end-->

        <!--JSP 支持-->
        <dependency>
            <groupId>org.apache.tomcat.embed</groupId>
            <artifactId>tomcat-embed-jasper</artifactId>
            <scope>provided</scope>
        </dependency>

7 实现 Controller

这里演示了两种方法，一种是返回 ModelAndView 对象，另一种是返回视图名称。

@Controller
public class IndexController {

    @RequestMapping(value = "/index")
    public ModelAndView index(Model model) {
        ModelAndView mv = new ModelAndView();
        mv.addObject("msg", "index page");
        mv.setViewName("index");
        return mv;
    }

    @RequestMapping(value = "/index2")
    public String index2(Model model) {
        model.addAttribute("msg", "index page2");
        return "index";
    }

}

这里的视图名称 index，就是我们在 webapp 中新建的 jsp 文件名称（不包括后缀）。msg是 jsp 文件中定义的变量名称。

8 演示

在浏览器中输入http://127.0.0.1:6670/index，这里的 6670 是工程的端口号。就会输出以下内容：

码农公寓