SpringBoot應用部署到Tomcat中沒法啓動問題

背景

最近公司在作一些內部的小型Web應用時， 爲了提升開發效率決定使用SpringBoot， 這貨自帶Servlet容器，
你在開發Web應用時能夠直接在本地像運行控制檯應用同樣啓動，省去了重複部署的時間；配置上相比於SpringMVC也是有了大大的簡化。SpringBoot的應用能夠直接打成一個可運行的jar包，
你無需發愁爲了避免同應用要部署多個Tomcat。可是實際部署時你會發現打成Jar包的方式有一個致命的缺點，
當你改動了一個資源文件、或者一個類時， 打要往服務器從新上傳全量jar包。好比網速慢的公司(好比咱們)來講， 那簡直是不能忍受的！！！

還好SpringBoot也支持打包成普通的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下面那確定是不能用啊

要支持低版本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的包了

可是我仍是有點疑惑， 這樣配置打成包豈不是換個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下的配置方法用於備忘也方便遇到一樣問題的朋友

1. 將打包方式改爲war
   這個沒啥好說的， 確定要改爲war

2. 配置嵌入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>

3. maven-war-plugin (可選)
   與maven-resources-plugin相似，當你有一些自定義的打包操做， 好比有非標準目錄文件要打到war包中或者有配置文件引用了pom中的變量。 具體用法參見官方文檔：http://maven.apache.org/components/plugins/maven-war-plugin/