如何构建一个基于Maven的Java项目

Posted 2021-04-30 云效

点击上方 “云效” 可以订阅哦！

导读：云效用户在对公司持续集成架构做系统调整过程中，得到了云效团队大量帮助，于是从php项目集成、JS项目集成、JAVA项目集成、Docker类项目集成等方面总结撰写了几篇文章，希望能让更多用户了解和用好云效产品。本文主要介绍云效如何构建一个基于Maven的Java项目。

以下为详情内容。

一、云效基础操作

在开始一切之前您需要熟悉云效的一些基础操作，创建一个项目，然后在这个项目中创建一个应用，然后让这个应用关联某个代码分支。这样基础工作就完成了，我这里不再赘述了，因为比较简单，只需要注册个阿里云账号，然后去 https://www.aliyun.com/product/yunxiao 创建/加入个企业就行了。

本文所有的体验均基于【自由模式】的应用。

在创建应用时，我们需要选择对应的配置，如下图：

创建完应用后，进入【项目】--》【流水线】，找到刚才创建应用的【同名流水线】

点击流水线名称可以看到具体的流水线运行情况和对应节点，如下图：

可以看到有4个面板：构建、日常、预发、正式。

分别对应的是：构建打包、发布到日常环境、发布到预发环境、发布到正式环境。

云效在创建应用时自动的为你生成了一个标准模板流水线，但是我们一般用不着，所以需要对流水线进行修改，去除无用的节点，添加我们自己的配置。点击界面上的【编辑流水线】按钮就可以进入修改界面。

我们先从构建开始，所以先暂时删除日常、预发、正式这3个部署节点，仅保留构建这一个节点即可。下面的配置暂时不进行调整。删除完毕后保存流水线即可，效果如下：

至此我们已经完成了基础的准备工作，下一步就开始进行代码的构建工作了。

在开始下一步工作之前，请重新git pull一下您的代码到本地，会看到一个由云效服务自动生成的配置文件：==xxx.release== 这个文件相当重要，请注意，下面将会说明如何通过此文件完成个性化构建。

二、基于Maven的Java项目构建

因为java类项目一般都通过maven来维护第三方库，并且一般会通过maven来进行构建，所以在云效构建时需要完成依赖下载及编译的相关工作。

这里需要找到我们上一章节中提到的：xxx.release 文件，xxx代表你的应用名，所以我这里看到的文件名是：ms-autotags.release

这个文件的配置规范可以参考：https://help.aliyun.com/document_detail/59293.html

打开这个文件可以看到，已经有一些预先定义好的配置：

# 构建源码语言类型

code.language=scripts

# 应用部署脚本

deploy.appctl.path=deploy.sh

docker.repo=registry.cn-hangzhou.aliyuncs.com/xxx/abced

上面的配置是不能用的，我们需要将其修改为如下内容：

# 语言类型，需要修改，否则无法调用对应的构建环境

code.language=java

# JDK版本

baseline.jdk=jdk-1.8

# 构建打包所用的maven版本

build.tools.maven=maven3.2.5

#产出物

build.output=target/ms-autotags-1.0-jar-with-dependencies.jar

# 应用部署脚本，先注释掉，暂时用不上

# deploy.appctl.path=deploy.sh

↓↓↓↓ 配置说明：

code.language=java

代表使用的是java作为代码语言类型。支持以下枚举（因为云效经常更新，请以官方为准）：

php5.6，php7.0，node6.x，node7.x，node8.x，oracle-jdk1.7，oracle-jdk1.8， oracle-jdk1.9，scripts

如果有使用过jenkins的同学，那么应该比较好理解，云效的构建是通过Docker容器技术实现的，类似于配置好环境的jenkins构建机，云效团队针对各种语言准备了不同的镜像作为构建宿主。

build.tools.maven=maven3.2.5

使用3.2.5版本的maven。

build.output=target/ms-autotags-1.0-jar-with-dependencies.jar

指明一个产出物，可以是目录也可以是具体的文件，比如jar包或者war包。如果执行完构建后此目录、文件不存在，则代表构建失败，无法进入工作流下一环。

简单maven项目不需要设置 build.command，除非你需要设置特别的maven打包参数或有多行打包命令。

我们已经完成了应用的创建+流水线的修改，那么我们运行一次构建试一下，只需要点击【运行流水线】按钮即可，运行后等几秒刷新一下页面，效果如下：

可以看到执行时间、版本号、日志、操作人等信息。

如果构建失败了，可以通过构建流程—-日志详情面板看到具体的错误原因，有日志排查起来不太难，但是云效的构建还是偏向黑盒，所以尽量熟练或在本地先把相关命令跑通后再上传到xxx.release文件里去进行云效构建。

可以看到初始的版本号是：v0.0.1-1，如果你的构建一直失败，版本号会变成v0.0.1-3、v0.0.1-8、v0.0.1-18、v0.0.1-N。

如果你的流水线全流程跑完了，则会自动叠加一个小版本号变为v0.0.2-1，所以这种构建方式清晰明了，还算好用。

三、如何输出为一个Docker镜像

我们已经完成了代码的打包编译工作，下一步我们需要把完整的代码封装成一个Docker镜像，我们需要对xxx.release文件做如下改动：

# 语言类型，需要修改，否则无法调用对应的构建环境

code.language=java

# JDK版本

baseline.jdk=jdk-1.8

# 构建打包所用的maven版本

build.tools.maven=maven3.2.5

#产出物

build.output=target/ms-autotags-1.0-jar-with-dependencies.jar

# Docker 构建配置

docker.file=Dockerfile

docker.repo=registry.cn-hangzhou.aliyuncs.com/xxx/abced

docker.tag=ci-${PACKAGE_LABEL} 

# 应用部署脚本，先注释掉，暂时用不上

# deploy.appctl.path=deploy.sh

相对于单纯的构建，如果需要生成Docker镜像则需要补充几个配置项，拆解说明如下：

docker.file=Dockerfile

指明dockerfile文件的位置和文件名，默认就是根目录下的Dockerfile文件。

docker.repo=registry.cn-hangzhou.aliyuncs.com/xxx/abced

docker.tag=ci-${PACKAGE_LABEL}-${TIMESTAMP}

这里指定你的docker镜像的tag名，使用了环境变量进行拼接。

${PACKAGE_LABEL}代表的是包名，这个参数在流水线配置里可以改，默认是default。

${TIMESTAMP}代表的是当前时间戳，格式是：20171008224350 这种样子。

有的项目一份代码可能产生多个docker镜像就需要通过这种方式来动态生成tag名，防止覆盖，也便于回滚。

关于构建传参，可以参考这个文章： https://help.aliyun.com/document_detail/59297.html

那么此处最终生成的tag名是这样的： ci-default-20171008224350

registry.cn-hangzhou.aliyuncs.com/xxx/abced:ci-default-20171008224350

四、后记

NodeJS构建 + Docker构建就说到这里，因为主要是为了介绍云效，所以Docker部分就挑重点讲了，如何编写Dockerfile文件请自行学习。

注：文章原文出处：qipangzi.com 个人博客

点击阅读原文，体验云效！

END

关于云效

云效，一站式企业协同研发云，源于阿里巴巴多年先进的管理理念和工程实践，提供从“需求->开发->测试->发布->运维->运营”端到端的协同服务和研发工具支撑。支持公有云、专有云和混合云的协同研发，助力企业产品快速创新迭代和研发效能升级。

微信ID：ali_yunxiao

一站式企业协同研发云

长按二维码关注