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

不念不忘少年蓝@ 2022-09-09 15:58 157阅读 0赞

### 文章目录 ###

*   *  1 加入 JSP 依赖包
     *  2 配置 resource
     *  3 配置视图解析器
     *  4 配置 webapp 文件夹与 web.xml
     *  5 新建 JSP
     *  6 配置依赖
     *  7 实现 Controller
     *  8 演示

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

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

## 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 有四种类型2：

<table> 
 <thead> 
  <tr> 
   <th>scope</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>test</td> 
   <td>在测试范围内有效，在编译和打包时不会加入该依赖。</td> 
  </tr> 
  <tr> 
   <td>compile</td> 
   <td>在编译范围内有效，在编译和打包时会加入该依赖。</td> 
  </tr> 
  <tr> 
   <td>provided</td> 
   <td>在编译和测试范围内有效，打包时不会加入该依赖。</td> 
  </tr> 
  <tr> 
   <td>runtime</td> 
   <td>在运行时范围有效，在编译和打包时不会加入该依赖。</td> 
  </tr> 
 </tbody> 
</table>

## 2 配置 resource ##

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

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

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

<resources>
        <resource>
            
            <directory>src/main/webapp</directory>
            
            <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，形如：

![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBAZGVuaXJvX2xp_size_20_color_FFFFFF_t_70_g_se_x_16]

## 5 新建 JSP ##

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

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

## 6 配置依赖 ##

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

<dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            
    
            
            <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 是工程的端口号。就会输出以下内容：

![在这里插入图片描述][f621b3f3ef0f4c65a6271893d1617ae1.png]

![在这里插入图片描述][dfcb9eb4c52a47a8ab45c9cccc4c2df8.png]

[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBAZGVuaXJvX2xp_size_20_color_FFFFFF_t_70_g_se_x_16]: /images/20220829/996b36398270489499f0f3aac57e937b.png
[f621b3f3ef0f4c65a6271893d1617ae1.png]: /images/20220829/45c6407ba0b44874b831a1811e547a15.png
[dfcb9eb4c52a47a8ab45c9cccc4c2df8.png]: /images/20220829/b7e9440d000d4a72bd1f3c47a98d65d4.png