Spring Boot + 外置tomcat + docker 打包部署

前言

最近这段时间在做一个有关于"Docker Graceful shutdown"，于是自己就开始做起了各种"小实验"。

虽然说过程有点痛苦，但是结果总是好的，让我对于docker有了一些新的认识。

正文

言归正传，今天我们的主题是Spring Boot + 外置tomcat + Docker，然后用做好的镜像可以去做部署。

我们需要修改两大块的地方：

1. Spring boot
2. Docker

我并不是把tomcat落下了。原因是我们可以让docker引用tomcat的镜像。

---

首先我们来改造Spring boot 项目，让他"摆脱"内置的tomcat

pom.xml:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.1.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.demo</groupId>
    <artifactId>externaltomcattest</artifactId>
    <version>1.0</version>
    <packaging>war</packaging>
    <name>externaltomcattest</name>
    <description>This project is used to test graceful shutdown, and use external tomcat</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <exclusions>
                  <!--这个地方时摆脱tomcat的关键-->
                <exclusion>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter-tomcat</artifactId>
                </exclusion>
                <exclusion>
                    <groupId>ch.qos.logback</groupId>
                    <artifactId>logback-classic</artifactId>
                </exclusion>
                <exclusion>
                    <groupId>ch.qos.logback</groupId>
                    <artifactId>logback-core</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

      <!--将tomcat的scope的作用域设置为provided，这个地方和上面说的那个exclusion里面其实选其一就行-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-tomcat</artifactId>
            <scope>provided</scope>
        </dependency>

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

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

启动类：

package com.demo.externaltomcattest;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class ExternaltomcattestApplication {

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

}

和启动类同级的地方，我们添加上这样一个类，名字叫做ServletInitializer：

package com.demo.externaltomcattest;

import org.springframework.boot.builder.SpringApplicationBuilder;
import org.springframework.boot.web.servlet.support.SpringBootServletInitializer;

public class ServletInitializer extends SpringBootServletInitializer {

    @Override
    protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {
        return application.sources(ExternaltomcattestApplication.class);
    }

}

关键就是以上三步。

有不懂的可以参考我的github：https://github.com/luckypoison/SpringBootTomcatExternalTest。

️只需要注意上面我说的那几个地方就行，剩下的是我为了做grace-shutdown测试用的‍️。

---

接下来我们需要打出来一个war包用于部署，不知道何为war包的，可以去自行搜索。

使用下面的命令进行打包：

mvn clean package

然后我们就可以在当前项目目录下面的target目录下面找到war包了。

---

在接下来我们就应该在一个空的文件夹下面，放上dockerfile，和我们的war包。

Dockerfile内容如下：

FROM tomcat:9.0

COPY externaltomcattest-1.0.war /usr/local/tomcat/webapps 

EXPOSE 8080

CMD ["catalina.sh", "run"]

下面做一下基本的讲解：

1. FROM 指令告诉我们需要使用的Docker应该使用哪一个basic的镜像
2. 拷贝我们的war包到docker中的tomcat的一个路径下。
3. 暴露8080端口
4. 启动tomcat

然后使用下面的命令进行构建：

首先我们需要进到刚刚我们新创建的文件夹下面。

docker build -t external-tomcat-test:1.0 .

-t 后面跟着的是我们需要打包出来的镜像的名字和版本号。

️后面的"."是不可以缺少的。

然后使用下面的命令，如果里面有我们刚刚打包出来的镜像，证明我们构建成功：

docker images

最后启动就可以了。

docker run -p 8080:8080 <imageId>

如果有需要可以把构建镜像和启动放在需要的地方。

后记

这是一个简单的例子，如果对docker上有什么知道的命令可以去官网进行查询：

https://docs.docker.com/engine/reference/run/

如果遇到了什么问题，可以在下方评论区告诉我们，我会尽量进行解答。