Spring Boot干货系列:(五)开发Web应用JSP篇

Spring Boot 干货系列:(五)开发 Web 应用 JSP 篇

原创 2017-04-05 嘟嘟 MD 嘟爷 java 超神学堂

前言

上一篇介绍了 Spring Boot 中使用 Thymeleaf 模板引擎,今天来介绍一下如何使用 SpringBoot 官方不推荐的 jsp, 虽然难度有点大,但是玩起来还是蛮有意思的。

正文

先来看看整体的框架结构,跟前面介绍 Thymeleaf 的时候差不多,只是多了 webapp 这个用来存放 jsp 的目录,静态资源还是放在 resources 的 static 下面。

引入依赖

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

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

  • compile: 编译依赖范围。如果没有指定,就会默认使用该依赖范围。使用此依赖范围的 Maven 依赖,对于编译、测试、运行三种 classpath 都有效。典型的例子是 spring-code, 在编译、测试和运行的时候都需要使用该依赖。

  • test: 测试依赖范围。使用次依赖范围的 Maven 依赖,只对于测试 classpath 有效,在编译主代码或者运行项目的使用时将无法使用此依赖。典型的例子是 Jnuit, 它只有在编译测试代码及运行测试的时候才需要。

  • provided: 已提供依赖范围。使用此依赖范围的 Maven 依赖,对于编译和测试 classpath 有效,但在运行时候无效。典型的例子是 servlet-api, 编译和测试项目的时候需要该依赖,但在运行项目的时候,由于容器以及提供,就不需要 Maven 重复地引入一遍。

application.properties 配置

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

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

控制类

上面步骤有了,这里就开始写控制类,直接上简单的代码,跟正常的 springMVC 没啥区别:

jsp 页面编写

启动类

启动类不变还是最简单的

内嵌 Tomcat 容器运行项目

基本配置好了就可以启动项目,通过 http://localhost:8080/learn 访问,我使用的 SpringBoot 是1.5.2 版本,jdk1.8, 以前介绍过,运行项目有三种方式,这里我都做过了一次测试,发现在 maven 中 jasper 依赖有加 provided 和注释掉该依赖范围运行的效果不大一样,具体对比如下:

有添加 provided 的情况:

  • 右键运行启动类,访问页面报 404 错误

  • 使用 spring-boot:run 运行正常

  • 打包成 jar,通过 java -jar demo-0.0.1-SNAPSHOT.jar 运行报错

  • 打包成 war,通过 java -jar demo-0.0.1-SNAPSHOT.war 运行正常

把 provided 注释掉的情况:

  • 右键运行启动类,访问页面正常

  • spring-boot:run 运行 访问页面正常

  • 打包成 jar,通过 java -jar demo-0.0.1-SNAPSHOT.jar 运行报错

  • 打包成 war,通过 java -jar demo-0.0.1-SNAPSHOT.war 运行正常

我测试了好几次都是这样,就是有加 provided 的时候,右键运行启动类访问页面的时候,提示 404 错误。

其他 3 种情况都一样, jar 运行也报 404,spring-boot:run 以及 war 运行都可以。

为什么 jar 包运行不行呢,我们打开打包的 jar 和 war 分别看看区别,如下 2 图所示:

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

内嵌 Tomcat 属性配置

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

配置 Servlet 容器:

配置 Tomcat:

更为详细的 Servlet 容器配置以及 Tomcat 配置,可以前往博主之前文章查看:Spring Boot 干货系列:常用属性汇总

外部的 Tomcat 服务器部署 war 包

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

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

  • 继承 SpringBootServletInitializer

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

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

  • pom.xml 修改 tomcat 相关的配置

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

    方法一:

在这里需要移除对嵌入式 Tomcat 的依赖,这样打出的 war 包中,在 lib 目录下才不会包含 Tomcat 相关的 jar 包,否则将会出现启动错误。

还有一个很关键的关键点,就是 tomcat-embed-jasper 中 scope 必须是 provided。

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

方法二:

直接添加如下配置即可:

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

如果你不喜欢默认的打包名称,你可以通过节点里添加内容。

最后启动 tomcat 输入 http://localhost:8080/springBootJsp/learn 查看效果,还是美美哒

关于使用 jar 部署

上面已经测试过了,正常情况下包含 jsp 的页面是无法用 jar 的运行的,因为 jsp 默认是在 webapp 目录下,可是打包成 jar 是没有 webapp 这个目录结构的。

虽然网上有介绍说通过 pom.xml 配置,把 WEB-INF 目录复制到 META-INF/resources 下面。但是博主试了一整天还是访问不了,最后放弃了。各位如何有兴趣可以继续尝试,毕竟 war 也可以通过 java -jar 命令来启动的不是么。

总结

我相信全网都找不到一篇有我这篇这么详细的介绍 Spring Boot 使用 jsp 的文章。有很多人问我,为什么我的很多文章这么简单易懂,我每次都是哭着回复他们四个字:主题阅读,天知道我参考了多少篇网上的文章,外加多少本相关书籍中关于这个章节的内容,反复对比提炼,最后才产出对应的博文。说真的,我很羡慕你们在这个信息爆炸的时代,刚好看到一篇自己要学习的技术的好文章,少走多少弯路。

说了这么多煽情的话,哪位大兄弟带一波节奏啊,好久没收到打赏了 d=====( ̄▽ ̄*)b

源码下载

( ̄︶ ̄)↗[相关示例完整代码]

https://github.com/tengj/SpringBootDemo/tree/master