Springboot集成JSP

Springboot集成JSP

虽然SpringBoot官方不推荐使用jsp，但是这里是中国一个注重速度和效率的国度，北京十三号线的速度严重影响了中国互联网的进程，西二旗莫得感情！原有项目使用的是jsp，现在让你给你几天时间用Sprinboot升级一下而且你肯定不想把原有的页面也重写一遍。

问题1：Springboot如何集成jsp

1、项目结构

使用IDEA新建一个依赖spring-boot-starter-web的项目，默认是没有webapp和web.xml的，需要打开项目结构 project Structure进行配置。

最终项目框架结构如下：

2、引入依赖

<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-web</artifactId>
</dependency>

<!--jsp页面使用jstl标签-->
<dependency>
	<groupId>javax.servlet</groupId>
	<artifactId>jstl</artifactId>
</dependency>

<!--用于编译jsp-->
<dependency>
	<groupId>org.apache.tomcat.embed</groupId>
	<artifactId>tomcat-embed-jasper</artifactId>
	<scope>provided</scope>
</dependency>

使用内嵌的tomcat容器来运行的话只要这3个就好了。这里介绍下maven中scope依赖范围的概念，因为后续涉及到这个会有问题。

依赖范围就是用来控制依赖和三种classpath(编译classpath，测试classpath、运行classpath)的关系，Maven有如下几种依赖范围：

compile:编译依赖范围。如果没有指定，就会默认使用该依赖范围。使用此依赖范围的Maven依赖，对于编译、测试、运行三种classpath都有效。典型的例子是spring-code,在编译、测试和运行的时候都需要使用该依赖。
test: 测试依赖范围。使用次依赖范围的Maven依赖，只对于测试classpath有效，在编译主代码或者运行项目的使用时将无法使用此依赖。典型的例子是Jnuit,它只有在编译测试代码及运行测试的时候才需要。
provided:已提供依赖范围。使用此依赖范围的Maven依赖，对于编译和测试classpath有效，但在运行时候无效。典型的例子是servlet-api,编译和测试项目的时候需要该依赖，但在运行项目的时候，由于容器以及提供，就不需要Maven重复地引入一遍。

3、application.properties配置

要支持jsp，需要在application.properties中配置返回文件的路径以及类型

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

这里指定了返回文件类型为jsp,路径是在/WEB-INF/jsp/下面。

4、HelloController和index.jsp

package com.cnsyear.demo.web;

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;

/**
 * @Description 测试控制器
 * @Author jie.zhao
 * @Date 2019/8/23 10:46
 */
@Controller
public class HelloController {

    @RequestMapping(value = {"/", "/index"})
    public String index(Model model) {
        model.addAttribute("name","ZHAOJIE");
        model.addAttribute("age","18");
        return "index";
    }
}

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>首页</title>
</head>
<body>

<h2>Hello,Springboot JSP !</h2>

<h3>name:${name}</h3>
<h3>age:${age}</h3>
</body>
</html>

5、启动项目

访问http://localhost:8080/

问题2：如何使用内置Tomcat部署

springboot推荐部署方式是jar包部署，这里我们运行mvn package 打包，使用java -jar xx.jar命令运行。
你会发现启动没有问题，而访问页面的时候却访问不到。

然后我们把部署方式改为war包，使用java -jar xx.war命令运行。启动完成后访问页面，你会发现是正常的。

1 2	修改pom.xml 指定打包方式 <packaging>war</packaging>

为什么jar包运行不行呢，我们打开打包的jar和war分别看看区别：

从上面可以看出来，jar包运行的时候会404错误，因为默认jsp不会被拷贝进来，而war包里面有包含了jsp，所以没问题。

内嵌Tomcat属性配置

关于Tomcat的偶有属性都在org.springframework.boot.autoconfigure.web.ServerProperties配置类中做了定义，我们只需在application.properties配置属性做配置即可。通用的Servlet容器配置都已”server”左右前缀，而Tomcat特有配置都以”server.tomcat”作为前缀。下面举一些常用的例子。

配置Servlet容器：

#配置程序端口，默认为8080
server.port= 8080
#用户绘画session过期时间，以秒为单位
server.session.timeout=
# 配置默认访问路径，默认为/
server.context-path=

配置Tomcat：

# 配置Tomcat编码,默认为UTF-8
server.tomcat.uri-encoding=UTF-8
# 配置最大线程数
server.tomcat.max-threads=1000

问题3：如何使用外部Tomcat部署

对于生产环境来说，像这种war部署的项目一般都使用外部容器Tomcat、resin等。
我这里使用Tomcat9.0.24部署官网下载。

Spring Boot项目需要部署在外部容器中的时候，Spring Boot导出的war包如果直接在Tomcat的部署会报错，不信你可以试试看。

需要做到下面两点修改才可以：

1、继承SpringBootServletInitializer

外部容器部署的话，就不能依赖于Application的main函数了，而是要以类似于web.xml文件配置的方式来启动Spring应用上下文，此时我们需要在启动类中继承SpringBootServletInitializer并实现configure方法：

public class Application extends SpringBootServletInitializer {
    @Override
    protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {
        return application.sources(DemoApplication.class);
    }
}

这个类的作用与在web.xml中配置负责初始化Spring应用上下文的监听器作用类似，只不过在这里不需要编写额外的XML文件了。

2、pom.xml修改tomcat相关的配置

如果要将最终的打包形式改为war的话，还需要对pom.xml文件进行修改，因为spring-boot-starter-web中包含内嵌的tomcat容器，所以直接部署在外部容器会冲突报错。这里有两种方法可以解决，如下

方法一

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <exclusions>
        <exclusion>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-tomcat</artifactId>
        </exclusion>
    </exclusions>
</dependency>

在这里需要移除对嵌入式Tomcat的依赖，这样打出的war包中，在lib目录下才不会包含Tomcat相关的jar包，否则将会出现启动错误。
还有一个很关键的关键点，就是tomcat-embed-jasper中scope必须是provided。

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

原因是因为SpringBootServletInitializer需要依赖 javax.servlet，而tomcat-embed-jasper下面的tomcat-embed-core中就有这个javax.servlet，如果没用provided，最终打好的war里面会有servlet-api这个jar，这样就会跟tomcat本身的冲突了。这个关键点同样适应于下面说的第二种方法。

方法二

直接添加如下配置即可：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-tomcat</artifactId>
    <scope>provided</scope>
</dependency>

provided的作用上面已经介绍的很透彻了，这里就不啰嗦了，这种方式的好处是，打包的war包同时适合java -jar命令启动以及部署到外部容器中。

最好部署到webapps下启动项目访问即可。

源码地址：https://github.com/cnsyear/tools/tree/master/springboot-jsp

参考文档：

http://tengj.top/2017/03/13/springboot5/

https://blog.csdn.net/qq_34021712/article/details/79976349