Spring Boot应用部署于外置Tomcat容器

Desktop

0x01. 概述

SpringBoot平时我们用的爽歪歪，爽到它自己连Tomcat都自集成了，我们可以直接编写SBT启动类，然后一键开启内置的Tomcat容器服务，确实是很好上手。但考虑到实际的情形中，我们的Tomcat服务器一般是另外部署好了的，有专门的维护方式。此时我们需要剥离掉SBT应用内置的Tomcat服务器，进而将应用发布并部署到外置的Tomcat容器之中，本文就实践一下这个。

注：本文原载于 My Personal Blog：， CodeSheep · 程序羊 ！

0x02. 修改打包方式

修改项目的pom.xml配置，我们修改其打包方式为war方式，如：

<groupId>com.example</groupId>
<artifactId>demo</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>war</packaging>

0x03. 移除SBT自带的嵌入式Tomcat

修改pom.xml，从maven的pom中移除springboot自带的的嵌入式tomcat插件

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <!-- 移除嵌入式tomcat插件 -->
    <exclusions>
        <exclusion>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-tomcat</artifactId>
        </exclusion>
    </exclusions>
</dependency>

0x04. 添加servlet-api依赖

修改pom.xml，在maven的pom中添加servlet-api的依赖

<dependency>
    <groupId>javax.servlet</groupId>
    <artifactId>javax.servlet-api</artifactId>
    <version>3.1.0</version>
    <scope>provided</scope>
</dependency>

0x05. 修改启动类，并重写初始化方法

在SpringBoot中我们平常用main方法启动的方式，都有一个SpringBootApplication的启动类，类似代码如下：

@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

而我们现在需要类似于web.xml的配置方式来启动spring应用，为此，我们在Application类的同级添加一个SpringBootStartApplication类，其代码如下:

// 修改启动类，继承 SpringBootServletInitializer 并重写 configure 方法
public class SpringBootStartApplication extends SpringBootServletInitializer {

    @Override
    protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) {
        // 注意这里一定要指向原先用main方法执行的Application启动类
        return builder.sources(Application.class);
    }
}

0x06. 部署到外部的Tomcat容器并验证

在项目根目录下（即包含pom.xml的目录）记性maven打包操作：

mvn clean package

等待打包完成，出现 [INFO] BUILD SUCCESS 即为打包成功

然后我们把target目录下生成的war包放到tomcat的webapps目录下，启动tomcat，即可自动解压部署。

最后在浏览器中验证:

http://YOUR_IP:[端口号]/[打包项目名]

浏览器验证

也可以直接将项目命名为ROOT，这样访问根目录即可访问tomcat中的SpringBoot应用

http://YOUR_IP:[端口号]

直接将项目命令为ROOT