Spring Boot应用部署到Tomcat中无法启动问题

451次阅读

共计 4277 个字符，预计需要花费 11 分钟才能阅读完成。

背景

最近公司在做一些内部的小型 Web 应用时，为了提高开发效率决定使用 Spring Boot，这货自带 Servlet 容器，
你在开发 Web 应用时可以直接在本地像运行控制台应用一样启动，省去了重复部署的时间；配置上相比于 SpringMVC 也是有了大大的简化。SpringBoot 的应用可以直接打成一个可运行的 jar 包，
你无需发愁为了不同应用要部署多个 Tomcat。但是实际部署时你会发现打成 Jar 包的方式有一个致命的缺点，
当你改动了一个资源文件、或者一个类时，打要往服务器重新上传全量 jar 包。比如网速慢的公司 (比如我们) 来说，那简直是不能忍受的！！！

还好 Spring Boot 也支持打包成普通的 war 包，
这样你本地开发环境直接用控制台方式运行，部署到服务器时打成普通 war 包部署。这样既享受到了 SpringBoot 开发带来的快感，
又避免了增量部署不方便的问题。可谓两全其美。不过在打成 War 包时，我也遇到了一些问题

问题描述

我修改 pom.xml 将打包方式改成 war

<packaging>war</packaging>

完事儿打完包以后，放到我本地 Tomcat 上跑了跑，发现没问题。但是部署到服务器上的 Tomcat 以后，发现无法启动，错误如下：

org.apache.catalina.LifecycleException: Failed to start component [StandardEngine[Catalina].StandardHost[localhost].StandardContext[/report]]
        at org.apache.catalina.util.LifecycleBase.start(LifecycleBase.java:153)
        at org.apache.catalina.core.ContainerBase.addChildInternal(ContainerBase.java:899)
        at org.apache.catalina.core.ContainerBase.addChild(ContainerBase.java:875)
        at org.apache.catalina.core.StandardHost.addChild(StandardHost.java:652)
        at org.apache.catalina.startup.HostConfig.deployWAR(HostConfig.java:1092)
        at org.apache.catalina.startup.HostConfig$DeployWar.run(HostConfig.java:1984)
        at java.util.concurrent.Executors$RunnableAdapter.call(Executors.java:471)
        at java.util.concurrent.FutureTask.run(FutureTask.java:262)
        at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1145)
        at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:615)
        at java.lang.Thread.run(Thread.java:745)
Caused by: java.lang.NoSuchMethodError: javax.servlet.ServletContext.getVirtualServerName()Ljava/lang/String;
        at org.apache.tomcat.websocket.server.WsServerContainer.<init>(WsServerContainer.java:150)
        at org.apache.tomcat.websocket.server.WsSci.init(WsSci.java:131)
        at org.apache.tomcat.websocket.server.WsSci.onStartup(WsSci.java:47)
        at org.apache.catalina.core.StandardContext.startInternal(StandardContext.java:5573)
        at org.apache.catalina.util.LifecycleBase.start(LifecycleBase.java:147)
        ... 10 more

明显不是应用代码错误，猜想应该是环境问题。经过分析，我本地的 Tomcat 版本是 8.0.28，而服务器上的 Tomcat 是 7.0.69。我在本地下了个 Tomcat7.0.70 部署也报同样错误。更加确定问题跟 Tomcat 版本有关。经过多方查找资料，最后在 Stackoverflow 上看到一个老外说 SpringBoot 默认 Servlet 容器是基于 Tomcat8 的

在打好的 war 包中确实发现了 Tomcat 相关 jar 包，而且是 Tomcat8 的，拿 Tomcat8 的 embed 包在 Tomcat7 下面那肯定是不能用啊
Spring Boot 应用部署到 Tomcat 中无法启动问题

要支持低版本 Tomcat 需要在 maven 中指定 Tomat 版本，配置如下：

<properties>
    <tomcat.version>7.0.69</tomcat.version>
</properties>

然后依赖中加上（这个其实不加也行，官方文档是加上的）

<dependency>
    <groupId>org.apache.tomcat</groupId>
    <artifactId>tomcat-juli</artifactId>
    <version>${tomcat.version}</version>
</dependency>

加上以后试了下，果然是没问题了。看了下 war 包中的 lib 目录，确实已经变成 Tomcat7 的包了
Spring Boot 应用部署到 Tomcat 中无法启动问题

但是我还是有点疑惑，这样配置打成包岂不是换个 Tomcat 版本就要重新打次包？既然是由于 SpringBoot 内部的 Servlet 容器造成了这个限制，那我不用行不行？又查了很多资料，还真有办法！

<!-- 打 war 包时加入此项，告诉 spring-boot tomcat 相关 jar 包用外部的，不要打进去 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-tomcat</artifactId>
    <scope>provided</scope>
</dependency>

试了下，加上这个后，上面说 Tomcat 的版本无需指定了，耶! ^_^

总结

总结下 SpringBoot 应用部署到 Tomcat 下的配置方法用于备忘也方便遇到同样问题的朋友

将打包方式改成 war
这个没啥好说的，肯定要改成 war

配置嵌入 Tomcat 中的方式
这里有两种方式可选择：

方式一：用 spring-boot 内置的 tomcat 库，并指定你要部署到 Tomcat 的版本

<properties>
    <tomcat.version>7.0.69</tomcat.version>
</properties>
<dependency>
    <groupId>org.apache.tomcat</groupId>
    <artifactId>tomcat-juli</artifactId>
    <version>${tomcat.version}</version>
</dependency>

方式二：不用 spring-boot 内置的 tomcat 库（强烈推荐这种方式！！）

<!-- 打 war 包时加入此项，告诉 spring-boot tomcat 相关 jar 包用外部的，不要打进去 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-tomcat</artifactId>
    <scope>provided</scope>
</dependency>

maven-war-plugin (可选)
与 maven-resources-plugin 类似，当你有一些自定义的打包操作，比如有非标准目录文件要打到 war 包中或者有配置文件引用了 pom 中的变量。具体用法参见官方文档：http://maven.apache.org/components/plugins/maven-war-plugin/

完！

Spring Boot 入门学习笔记 http://www.linuxidc.com/Linux/2016-10/135889.htm

Spring Boot+Nginx+Tomcat+SSL 配置笔记 http://www.linuxidc.com/Linux/2016-01/127134.htm

Spring Boot 实践心得笔记 http://www.linuxidc.com/Linux/2017-01/139576.htm

Spring Boot 的启动器 Starter 详解 http://www.linuxidc.com/Linux/2016-10/136430.htm

Spring Boot 在整合项目依赖 jdk 反复变成 1.5 版本的问题 http://www.linuxidc.com/Linux/2017-03/141485.htm

Spring Boot 项目搭建入门教程 http://www.linuxidc.com/Linux/2017-01/139901.htm

Spring Boot 常用注解 http://www.linuxidc.com/Linux/2017-03/142209.htm

Spring Boot 整合 jedisCluster http://www.linuxidc.com/Linux/2017-03/142208.htm

Spring Boot 装载自定义 yml 文件 http://www.linuxidc.com/Linux/2017-04/142749.htm

Spring Boot 的详细介绍：请点这里
Spring Boot 的下载地址：请点这里

本文永久更新链接地址：http://www.linuxidc.com/Linux/2017-10/147870.htm