引用:
持续集成测试(1) -- docker-maven-plugin初探
docker与Spring boot的集成:docker-maven-plugin使用
使用Docker部署 spring-boot maven应用
首先准备一个简单的Spring Boot项目:
在 pom.xml
中 ,使用 Spring Boot 2.0 相关依赖
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.0.0.RELEASE</version>
</parent>
添加 web 和测试依赖
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
创建一个 DockerController,在其中有一个index()
方法,访问时返回:Hello Docker!
@RestController
public class DockerController {
@RequestMapping("/")
public String index() {
return "Hello Docker!";
}
}
启动类
@SpringBootApplication
public class DockerApplication {
public static void main(String[] args) {
SpringApplication.run(DockerApplication.class, args);
}
}
添加完毕后启动项目,启动成功后浏览器放问:http://localhost:8080/
,页面返回:Hello Docker!
,说明 Spring Boot 项目配置正常。
Spring Boot 项目添加 Docker 支持
在 pom.xml文件中的properties标签
中添加将要生成的 Docker 镜像的名称(做引用变量用,被下面引用)
<properties>
<docker.image.prefix>finance</docker.image.prefix>
</properties>
1.plugins 中添加 Docker 构建插件(不使用Dockerfile的方式):
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
<!-- Docker maven plugin -->
<plugin>
<groupId>com.spotify</groupId>
<artifactId>docker-maven-plugin</artifactId>
<!--这里最好使用0.4.13版本以及以上的-->
<version>1.0.0</version>
<configuration>
<imageName>registry.test.com/finane</imageName>
<baseImage>registry.test.com/base_image</baseImage>
<entryPoint>["sh", "start.sh"]</entryPoint>
<-- 采用Doderfile方式的,上面2个标签可不要-->
<resources>
<resource>
<targetPath>/</targetPath>
<directory>${project.build.directory}</directory>
<include>**/*</include>
</resource>
</resources>
</configuration>
</plugin>
<!-- Docker maven plugin -->
</plugins>
</build>
对上面的标签进行解释:
- imageName:即将构建的镜像名 ,可以通过${project.groupId}/${project.artifactId}:${project.version} 动态制定镜像名称
- baseImage: 构建镜像时需要的基础镜像,类似于Dockerfile的From
- entryPoint: 容器启动时执行的命令
- resources:拷贝一些额外的文件到指定路径(targetPath)下,比如${project.build.finalName}.jar文
一些maven的内置变量:
- ${basedir} 项目根目录
- ${project.build.directory} 构建目录,默认为target
- ${project.build.outputDirectory} 构建过程输出目录,默认为target/classes,target/test-classes
- ${project.build.finalName} 打包后生成的结果名称,默认为${project.artifactId}-${project.version}
- ${project.packaging} 打包类型,默认为jar
maven一些标签:
- targetPath:指定build资源到哪个目的目录,默认是base directory
- directory:指定属性文件的目录,build的过程需要找到它,并且将其放到targetPath下。
- includes:指定包含文件的patterns,符合样式并且在directory目录下的文件将会是包含进project的资源文件
- excludes:指定不包含在内的patterns,如果includes与excludes有冲突,那么excludes胜利,那些符合冲突样式的文件还是不会包含进来的
2.plugins 中添加 Docker 构建插件(使用Dockerfile的方式):
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
<!-- Docker maven plugin -->
<plugin>
<groupId>com.spotify</groupId>
<artifactId>docker-maven-plugin</artifactId>
<version>1.0.0</version>
<configuration>
<imageName> ${docker.repostory}/${docker.registry.name}:${project.version} </imageName>
<dockerDirectory>${project.basedir}/src/main/docker</dockerDirectory>
<!--给当前将要生成的镜像指定多个标签,镜像ID是同一个,只是tag标签不同,可以多标签指定,出来下面指定的标签外,imageName也会生成出来一个单独标签-->
<imageTags>
<imageTag>tag01</imageTag>
<imageTag>tag02</imageTag>
</imageTags>
<!--覆盖相同标签镜像 true 覆盖,false不覆盖-->
<forceTags>true</forceTags>
<!--是否跳过镜像构建,true跳过,false不跳过-->
<skipDockerBuild>false</skipDockerBuild>
<resources>
<resource>
<targetPath>/</targetPath>
<directory>${project.build.directory}</directory>
<include>${project.build.finalName}.${project.packaging}</include>
</resource>
</resources>
</configuration>
</plugin>
<!-- Docker maven plugin -->
</plugins>
</build>
说明:
- <dockerDirectory> :依赖于Dockerfile构建镜像,需指定dockerDirectory 来查找Dockerfile所在文件目录,指定dockerDirectory 后,baseImage, maintainer, cmd和entryPoint等标签均失效。dockerDirectory目录下的所有内容默认会被复制到${project.build.directory}/docker目录(也就是targetPath目录)下。
- 这里Dockerfile指定在src/main/docker目录中,当执行 mvn clean package -DskipTests=true docker:build 后会生成一target目录并生成里面的文件(如jar),生成target目录后还会默认生成docker文件夹,继续查看docker文件夹时可见,src/main/docker 目录的所有内容都被copy到该文件夹下,在进行docker build的过程中也是在target/docker目录下根据Dockerfile执行。
在目录 src/main/docker
下创建 Dockerfile 文件,Dockerfile 文件用来说明如何来构建镜像。
FROM openjdk:8-jdk-alpine
VOLUME /tmp
ADD finane.jar finane.jar
ENTRYPOINT ["java","-Djava.security.egd=file:/dev/./urandom","-jar","/finane.jar"]
这个 Dockerfile 文件很简单,构建 Jdk 基础环境,添加 Spring Boot Jar 到镜像中,简单解释一下:
- FROM ,表示使用 Jdk8 环境 为基础镜像,如果镜像不是本地的会从 DockerHub 进行下载
- VOLUME ,VOLUME 指向了一个
/tmp
的目录,由于 Spring Boot 使用内置的Tomcat容器,Tomcat 默认使用/tmp
作为工作目录。这个命令的效果是:在宿主机的/var/lib/docker
目录下创建一个临时文件并把它链接到容器中的/tmp
目录 - ADD ,拷贝文件并且重命名
- ENTRYPOINT ,为了缩短 Tomcat 的启动时间,添加
java.security.egd
的系统属性指向/dev/urandom
作为 ENTRYPOINT
这样 Spring Boot 项目添加 Docker 依赖就完成了。
构建打包环境
我们需要有一个 Docker 环境来打包 Spring Boot 项目,在 Windows 搭建 Docker 环境很麻烦,因此我这里以 Centos 7 为例。
安装 Docker 环境
安装
yum install docker
安装完成后,使用下面的命令来启动 docker 服务,并将其设置为开机启动:
ervice docker start
chkconfig docker on
#LCTT 译注:此处采用了旧式的 sysv 语法,如采用CentOS 7中支持的新式 systemd 语法,如下:
systemctl start docker.service
systemctl enable docker.service
使用Docker 中国加速器
vi /etc/docker/daemon.json
#添加后:
{
"registry-mirrors": ["https://registry.docker-cn.com"],
"live-restore": true
}
重新启动docker
systemctl restart docker
输入 docker version
返回版本信息则安装正常。
安装JDK
yum -y install java-1.8.0-openjdk*
配置环境变量
打开 vim /etc/profile
添加一下内容
export JAVA_HOME=/usr/lib/jvm/java-1.8.0-openjdk-1.8.0.161-0.b14.el7_4.x86_64
export PATH=$PATH:$JAVA_HOME/bin
修改完成之后,使其生效
source /etc/profile
输入java -version
返回版本信息则安装正常。
安装MAVEN
下载:http://mirrors.shu.edu.cn/apache/maven/maven-3/3.5.2/binaries/apache-maven-3.5.2-bin.tar.gz
## 解压
tar vxf apache-maven-3.5.2-bin.tar.gz
## 移动
mv apache-maven-3.5.2 /usr/local/maven3
修改环境变量, 在 /etc/profile
中添加以下几行
MAVEN_HOME=/usr/local/maven3
export MAVEN_HOME
export PATH=${PATH}:${MAVEN_HOME}/bin
记得执行 source /etc/profile
使环境变量生效。
输入 mvn -version
返回版本信息则安装正常。
这样整个构建环境就配置完成了。
使用 Docker 部署 Spring Boot 项目
将项目finane 拷贝服务器中,进入项目路径下进行打包测试,这里我们打的包为finane.jar 。
#打包
mvn package
#启动
java -jar target/finane.jar
看到 Spring Boot 的启动日志后表明环境配置没有问题,接下来我们使用 DockerFile 构建镜像。
# maven打包并构建镜像,跳过测试
mvn clean package -DskipTests=true docker:build
第一次构建可能有点慢,当看到以下内容的时候表明构建成功:
...
Step 1 : FROM openjdk:8-jdk-alpine
---> 224765a6bdbe
Step 2 : VOLUME /tmp
---> Using cache
---> b4e86cc8654e
Step 3 : ADD finane.jar finane.jar
---> a20fe75963ab
Removing intermediate container 593ee5e1ea51
Step 4 : ENTRYPOINT java -Djava.security.egd=file:/dev/./urandom -jar /finane.jar
---> Running in 85d558a10cd4
---> 7102f08b5e95
Removing intermediate container 85d558a10cd4
Successfully built 7102f08b5e95
[INFO] Built springboot/finane
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 54.346 s
[INFO] Finished at: 2018-03-13T16:20:15+08:00
[INFO] Final Memory: 42M/182M
[INFO] ------------------------------------------------------------------------
使用 docker images
命令查看构建好的镜像:
docker images
REPOSITORY TAG IMAGE ID CREATED SIZE
springboot/finane latest 99ce9468da74 6 seconds ago 117.5 MB
springboot/finane
就是我们构建好的镜像,下一步就是运行该镜像
docker run -p 8080:8080 -t springboot/finane
启动完成之后我们使用 docker ps
查看正在运行的镜像:
docker ps
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
049570da86a9 springboot/finane "java -Djava.security" 30 seconds ago Up 27 seconds 0.0.0.0:8080->8080/tcp determined_mahavira
可以看到我们构建的容器正在在运行,访问浏览器:http://localhost:8080/
,返回
Hello Docker!
说明使用 Docker 部署 Spring Boot 项目成功!