注意: 这并非一个通用解决方案,它需要你的总体架构以及项目管理等等进行配合。
架构规范与背景
我们项目的管理模式是让生产环境时刻保持master的最新版本。所有需求线都从master拉取分支。需求开发完成后直接分支提测,我们提供一整套的分支路由功能。使用一套环境解决了所有分支共享环境,测试人员能够精准进行按分支测试。上线时将代码合并到master中。
项目的分包决策,还记得一个说了好几次得问题,服务得接口层该由开发者编写还是由调用者编写,这个问题,我们选择了折中的方案,全部接口层抽取到一个项目中进行分包管理,这样既不会带来过多项目的强耦合问题,也方便接口的引用提高开发效率,减少沟通成本。
我们的项目的包版本管理全部使用snapshot,相对于开源项目按版本推进而言发布release而言,snapshot无疑更适合企业级的管理,当然除非你作为产品外卖型企业另当别论,作为企业自己的应用,自始至终不存在多release版本的情况,所以使用snapshot管理包是最佳选择。但是使用了snapshot无疑带来了一些问题,包的覆盖问题。
比如AB两个项目同时依赖了C如果他们同时打包,就有很大可能出现A引用了B打出来的C的包,而发生打包错误或者运行期间的出现错误。
我们基于gitlab-runner。并且将项目打成docker包的形式进行发布。
在这样一套架构运维体系的规范下,我们在打包时,可以不用将jar包发布到maven中央库,或者本地仓库,我们只需要使用 package 命令即可。因为打出来的jar包只是中间产品。
打包流程
所以我们定制了如下打包流程:
我们在gitlab ci中配置variable变量,指定每个项目所依赖的项目,打包时将这些项目合并到一个项目中进行打包,此时它所依赖的包就不需要去仓库取,而是优先取本地源码。为此构建脚本如下:
- 1、创建一个工作空间,用于容纳每个项目分支,工作空间使用分支名称加项目名称命名,保证不会重复。
- 2、进入工作空间拉取该项目所对应的所有项目,并判断项目存不存在当前分支。
- 3、创建一个pom.xml将所有包含当前分支的依赖,作为子模块添加到pom.xml中。
- 4、执行 mvn clean package 命令构建项目。
- 5、构建完成后,将jar包拷贝到下一个stage中,进行docker打包。并将docker包上传到hardbor。
maven打包脚本
关于maven分仓打包的脚本如下。
#!/usr/bin/env bash
set -e
CUR_DIR=$(cd "$(dirname "$0")";pwd)
# 获取参数
WORKSPACE="${CUR_DIR:-}/${CI_COMMIT_REF_NAME}_${CI_PROJECT_NAME}"
function init(){
mkdir "${WORKSPACE}"
cd "${WORKSPACE}"
clone_all
modules=$(ls -d */ | sed 's@//@@g')
create_pom "$modules"
cat pom.xml
build
cd "${WORKSPACE:-}/${CI_PROJECT_NAME}"
#mv target "${CUR_DIR:-}"
}
function create_pom(){
echo "create_pom"
# 创建 pom.xml 文件
cat <<EOF > 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
http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.example</groupId>
<artifactId>build_project</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>pom</packaging>
<modules>
EOF
# 添加 modules
for module_name in $1 ;do
echo " <module>$module_name</module>" >> pom.xml
done
# 关闭 pom.xml 文件
echo " </modules>" >> pom.xml
echo "</project>" >> pom.xml
}
function clone(){
GIT_URL="http://${GITLAB_USER:-user001}:${GITLAB_AT}@gitlab.xxxx.cn/xxx-xxx-xxx/$1.git"
git clone "${GIT_URL}" -v
cd "${WORKSPACE:-}/$1"
count=$(git branch -a|grep "${CI_COMMIT_REF_NAME}"|wc -l)
echo "$count"
if [ "$count" != 0 ];then
git checkout "${CI_COMMIT_REF_NAME}"
else
rm -rf "${WORKSPACE:-}/$1"
fi
cd ..
}
function clone_all(){
clone "${CI_PROJECT_NAME}"
if [[ -n ${DEPENDENCY_LIST} ]];then
for DEP in $DEPENDENCY_LIST ;do
clone "${DEP}"
done
fi
}
function build(){
pwd
mvn clean package -Dmaven.test.failure.ignore=true -DskipTests=true -U
}
init "$*";
问题与局限性
如果你的项目的背景跟我不一样,你可能不适用,比如你一个项目依赖了很多的其它项目。如果你按这种方式进行分支分仓,那你可能每次打包都会拉取很多的其它项目代码。所这个方式只有按我们的这个管理流程才适用。