本文用实例介绍,如何通过 GitLab CI/CD 实现自动化打包Spring Boot项目。每次提交代码后,GitLab CI/CD都会编译代码并生成 JAR 包,然后在发布阶段将 JAR 包发布到 Maven 仓库,同时构建 Docker 镜像并发布到 Docker 仓库。该步骤是项目自动自动化部署、测试的前提。
Spring Boot项目
使用 Spring Initializr 创建新的Spring Boot项目,可以参照网上的步骤,也可以直接去Spring Boot官网,本文不做太多的描述。以下进说明新建项目后修改的内容。
新增Rest接口
这里为了测试,增加根目录的请求响应结果,项目启动后访问根目录会在浏览器中显示“你好,我是代码转场工程师!”
package com.copier.springbootdemo;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@SpringBootApplication
@RestController
public class SpringbootdemoApplication {
@GetMapping("/")
public String home() {
return "你好,我是代码转场工程师!";
}
public static void main(String[] args) {
SpringApplication.run(SpringbootdemoApplication.class, args);
}
}
自动构建脚本
除非万不得已,我不会把脚本散落在.gitlab-ci.yml文件中,所以我在项目下的scripts目录中创建build.sh文件,文件脚本是打包的逻辑。
#!/bin/bash
# 获取当前目录路径,用于后续挂载到 Docker 容器中
APP_ROOT=$(pwd)
# 从 pom.xml 文件中提取版本号,如果version节点顺序不对可能取得不对
# 这里仅为演示
VERSION=$(grep -m1 '<version>' "pom.xml" | sed -e 's/\s*<[^>]*>//g')
# 打印构建的应用版本号
echo "build app version: $VERSION"
# 使用 Maven Docker 镜像构建项目并部署
# /home/copier/.m2/:/root/.m2/将本地 Maven 仓库挂载到 Docker 容器中
# $APP_ROOT:/app 将当前应用目录挂载到 Docker容器中。runner配置不对可能映射不了
# -w /app 设置工作目录为应用目录
在 Maven Docker 容器中运行 Maven 命令
docker run --rm \
-v /home/copier/.m2/:/root/.m2/ \
-v $APP_ROOT:/app \
-w /app \
maven:3.8.5-openjdk-17 mvn package deploy
# 使用 Dockerfile 构建 Docker 镜像
docker build -t docker.mvcode.cn:8083/springdemo:$VERSION .
# 推送构建好的 Docker 镜像到指定的 Docker 仓库
docker push docker.mvcode.cn:8083/springdemo:$VERSION
.gitlab-ci.yml
文件
为了演示.gitlab-ci.yml
文件的配置很简单,每次提交代码的时候都会执行build的job。
stages:
- build
build:
stage: build
script:
- sh ./scripts/build.sh
修改config.toml
使用下面的命令修改config.toml配置文件。基于Docker构建CI/CD工具链(三)Gitlab Runner搭建起步介绍了/srv/gitlab-runner/config/
为映射到gitlab-runner中的宿主机的目录。
sudo vi /srv/gitlab-runner/config/config.toml
您也可以进入到gitlab-runner的bash修改。
具体内容如下:
concurrent = 1
check_interval = 0
shutdown_timeout = 0
[session_server]
session_timeout = 1800
[[runners]]
name = "docker"
url = "http://192.168.3.37:9080"
id = 6
token = "你的Token"
token_obtained_at = 2024-04-06T23:46:19Z
token_expires_at = 0001-01-01T00:00:00Z
executor = "docker"
[runners.cache]
MaxUploadedArchiveSize = 0
[runners.docker]
tls_verify = false
image = "docker:latest"
privileged = true
disable_entrypoint_overwrite = false
oom_kill_disable = false
disable_cache = false
volumes = ["/cache","/var/run/docker.sock:/var/run/docker.sock","/builds:/builds","/home/copier/.docker/:/root/.docker/"]
shm_size = 0
network_mtu = 0
volumes
参数指定了容器和宿主机之间的挂载点。具体来说:
-
"/cache"
: 将容器内的/cache
目录挂载到宿主机的相同路径上。这可以用于在容器中共享数据或持久化数据,以便后续的操作可以访问到这些数据。 -
"/var/run/docker.sock:/var/run/docker.sock"
: 将宿主机的 Docker 守护进程的 Unix 套接字(Docker 的 API 接口)挂载到容器内的相同路径上。这使得容器内的进程可以与宿主机上的 Docker 守护进程进行通信,从而执行 Docker 相关的操作,如构建镜像、运行容器等。 -
"/builds:/builds"
: 将宿主机上的/builds
目录挂载到容器内的/builds
目录。这可能用于将构建产物或其他文件从容器内部复制到宿主机上,或者从宿主机复制文件到容器内部进行处理。如如果不映射这个目录,子容器可能无法应声工程目录。 -
"/home/copier/.docker/:/root/.docker/"
: 将宿主机上的/home/copier/.docker/
目录挂载到容器内的/root/.docker/
目录。这可能用于在容器中使用 Docker 客户端时,使用宿主机上的 Docker 配置文件(如config.json
)来进行身份验证、镜像拉取等操作。
自动构建
以上配置和修改完毕后,每次提交代码都会自动执行build.sh进行打包。
查看Nexus Maven库
查看Nexus Docker库
运行Docker镜像
找台机器运行以下的命令,便可运行构建结果
docker run -d -p 9999:8080 docker.mvcode.cn:8083/springdemo:1.0.0-SNAPSHOT
在浏览器输入地址http://192.168.3.52:9999/
可以看到如下内容,说明发布成功。