Maven自动化部署

12个月前 (04-27)

Maven 项目的部署通常包括以下步骤：

将项目代码提交到 SVN 或 Git 等版本控制系统中，并进行标记。

从 SVN 或 Git 上下载完整的项目代码。

构建应用。

将构建输出的 WAR 或 JAR 文件存放在指定的公共网络位置中。

从指定网络中获取文件，并部署到生产环境上。

更新项目文档以及版本号。

以上这些工作通常由多个不同的团队协作完成，例如，项目研发人员负责项目代码的提交，项目管理员负责项目的构建工作，运维人员负责将构建好的应用文件部署到生产环境上等等。任何一个环节出现问题，都由可能导致 bug 甚生产事故的发生，例如，新版本构建完成后，没有发布到指定的网络位置中，导致运维人员再次将旧版本构件部署到生产环境中。

自动化部署的实现方式

为了避免以上问题的发生，我们通常采用如下的架构来管理项目：

版本控制工具（本节以 Git 为例）：管理项目源代码

Maven：负责编译和发布项目

远程仓库管理工具（本节以 Nexus 为例）：管理构建生成的二进制文件

Maven 提供了一个名为 maven-release-plugin 的插件，它可以帮助我们实现 Maven 项目的自动化部署。

maven-release-plugin 提供了很多令，其中最常用的是以下 4 个：

令	执行的操作
mvn release:clean	如果上次发布过程不成功，则使用该令清理工作空间。
mvn release:rollback	若上一次发布过程不成功，回滚对代码和配置所做的更改。
mvn release:prepare	检查是否存在任何未提交的本地更改。检查是否存在 SNAPSHOT 版本的依赖项。修改 POM 中的配置，将应用程序的版本从快照版本（SNAPSHOT）修改为正式版本（RLEASE），例如从从 1.0-SNAPSHOT 到 1.0。针对修改后的 POM 进行测试，确保一切正常。提交修改后的 POM。将正式版本的代码提交到 Git，并进行标记。修改 POM 中的配置，将正式版本升级为更高的快照版本（例如从 1.0 升级到 1.1-SNAPSHOT），以便以后继续使用快照版本进行开发。将修改后的 POM 提交到 Git。
mvn release:perform	从 Git 中检出上面标记的正式版代码，并执行令 mvn deploy ，将正式版本的构件部署到 Nexus 中。

maven-release-plugin 插件的使用

使用 maven-release-plugin 插件实现项目的自动化部署需要以下步骤。

1. 执行以下 mvn 令，创建一个名为 mavenAutoDeployDemo 的 Maven 项目，请参考 Maven创建项目。

mvn archetype:generate -DgroupId=net.biancheng.www -DartifactId=mavenAutoDeployDemo -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false

2. 将 mavenAutoDeployDemo 上传到 Github 上，由 Git 管理该项目的代码，操作步骤请参考 Git 文档。

3. 修改该项目的 POM 文件，增加 Git 以及 Nexus 的相关配置，如下。

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache网站站点" rel="nofollow"  />              
mvn scm:checkin -Dmessage="代码提交日志" #代码提交

令执行结果如下图。

图1：提交代码

5. 执行以下 mvn 令。

mvn release:prepare

执行结果如下。

[INFO] Scanning for projects...
[INFO]
[INFO] ---------------< net.biancheng.www:mavenAutoDeployDemo >----------------
[INFO] Building mavenAutoDeployDemo 1.0-SNAPSHOT
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- maven-release-plugin:2.5.3:prepare (default-cli) @ mavenAutoDeployDemo ---
[INFO] Verifying that there are no local modifications...
[INFO]   ignoring changes on: **\pom.xml.next, **\release.properties, **\pom.xml.branch, **\pom.xml.tag, .idea, **\pom.xml.backup, **\pom.xml.releaseBackup
[INFO] Executing: cmd.exe /X /C "git rev-parse --show-toplevel"
[INFO] Working directory: D:\eclipse workSpace 3\mavenAutoDeployDemo
[INFO] Executing: cmd.exe /X /C "git status --porcelain ."
[INFO] Working directory: D:\eclipse workSpace 3\mavenAutoDeployDemo
[WARNING] Ignoring unrecognized line: ?? release.properties
[INFO] Checking dependencies and plugins for snapshots ...
What is the release version for "mavenAutoDeployDemo"? (net.biancheng.www:mavenAutoDeployDemo) 1.0: :
What is SCM release tag or label for "mavenAutoDeployDemo"? (net.biancheng.www:mavenAutoDeployDemo) mavenAutoDeployDemo-1.0: :
What is the new development version for "mavenAutoDeployDemo"? (net.biancheng.www:mavenAutoDeployDemo) 1.1-SNAPSHOT: :
[INFO] Transforming 'mavenAutoDeployDemo'...
[INFO] Not generating release POMs
[INFO] Executing goals 'clean verify'...
[WARNING] Maven will be executed in interactive mode, but no input stream has been configured for this MavenInvoker instance.
[INFO] [INFO] Scanning for projects...
[INFO] [INFO]
[INFO] [INFO] ---------------< net.biancheng.www:mavenAutoDeployDemo >----------------
[INFO] [INFO] Building mavenAutoDeployDemo 1.0
[INFO] [INFO] --------------------------------[ jar ]---------------------------------
[INFO] [INFO]
[INFO] [INFO] --- maven-clean-plugin:3.1.0:clean (default-clean) @ mavenAutoDeployDemo ---
[INFO] [INFO]
[INFO] [INFO] --- maven-resources-plugin:3.0.2:resources (default-resources) @ mavenAutoDeployDemo ---
[INFO] [INFO] Using 'UTF-8' encoding to copy filtered resources.
[INFO] [INFO] skip non existing resourceDirectory D:\eclipse workSpace 3\mavenAutoDeployDemo\src\main\resources
[INFO] [INFO]
[INFO] [INFO] --- maven-compiler-plugin:3.8.0:compile (default-compile) @ mavenAutoDeployDemo ---
[INFO] [INFO] Changes detected - recompiling the module!
[INFO] [INFO] Compiling 1 source file to D:\eclipse workSpace 3\mavenAutoDeployDemo\target\classes
[INFO] [INFO]
[INFO] [INFO] --- maven-resources-plugin:3.0.2:testResources (default-testResources) @ mavenAutoDeployDemo ---
[INFO] [INFO] Using 'UTF-8' encoding to copy filtered resources.
[INFO] [INFO] skip non existing resourceDirectory D:\eclipse workSpace 3\mavenAutoDeployDemo\src\test\resources
[INFO] [INFO]
[INFO] [INFO] --- maven-compiler-plugin:3.8.0:testCompile (default-testCompile) @ mavenAutoDeployDemo ---
[INFO] [INFO] Changes detected - recompiling the module!
[INFO] [INFO] Compiling 1 source file to D:\eclipse workSpace 3\mavenAutoDeployDemo\target\test-classes
[INFO] [INFO]
[INFO] [INFO] --- maven-surefire-plugin:2.22.1:test (default-test) @ mavenAutoDeployDemo ---
[INFO] [INFO]
[INFO] [INFO] -------------------------------------------------------
[INFO] [INFO]  T E S T S
[INFO] [INFO] -------------------------------------------------------
[INFO] [INFO] Running net.biancheng.www.AppTest
[INFO] [INFO] Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.023 s - in net.biancheng.www.AppTest
[INFO] [INFO]
[INFO] [INFO] Results:
[INFO] [INFO]
[INFO] [INFO] Tests run: 1, Failures: 0, Errors: 0, Skipped: 0
[INFO] [INFO]
[INFO] [INFO]
[INFO] [INFO] --- maven-jar-plugin:3.0.2:jar (default-jar) @ mavenAutoDeployDemo ---
[INFO] [INFO] Building jar: D:\eclipse workSpace 3\mavenAutoDeployDemo\target\mavenAutoDeployDemo-1.0.jar
[INFO] [INFO] ------------------------------------------------------------------------
[INFO] [INFO] BUILD SUCCESS
[INFO] [INFO] ------------------------------------------------------------------------
[INFO] [INFO] Total time:  3.531 s
[INFO] [INFO] Finished at: 2021-04-06T16:39:23+08:00
[INFO] [INFO] ------------------------------------------------------------------------
[INFO] Checking in modified POMs...
[INFO] Executing: cmd.exe /X /C "git add -- pom.xml"
[INFO] Working directory: D:\eclipse workSpace 3\mavenAutoDeployDemo
[INFO] Executing: cmd.exe /X /C "git rev-parse --show-toplevel"
[INFO] Working directory: D:\eclipse workSpace 3\mavenAutoDeployDemo
[INFO] Executing: cmd.exe /X /C "git status --porcelain ."
[INFO] Working directory: D:\eclipse workSpace 3\mavenAutoDeployDemo
[WARNING] Ignoring unrecognized line: ?? pom.xml.releaseBackup
[WARNING] Ignoring unrecognized line: ?? release.properties
[WARNING] Ignoring unrecognized line: ?? target/
[INFO] Executing: cmd.exe /X /C "git commit --verbose -F C:\Users\79330\AppData\Local\Temp\maven-scm-30287522网站站点" rel="nofollow"  />      
What is the release version for "mavenAutoDeployDemo"? (net.biancheng.www:mavenAutoDeployDemo) 1.0: :

询问 mavenAutoDeployDemo 项目的发布版本是什么？默认值是 1.0，此处我们直接回车使用默认值。

What is SCM release tag or label for "mavenAutoDeployDemo"? (net.biancheng.www:mavenAutoDeployDemo) mavenAutoDeployDemo-1.0: :

询问 mavenAutoDeployDemo 项目的 SCM 发布标签是什么？默认值是 mavenAutoDeployDemo-1.0，此处我们直接回车使用默认值。

What is the new development version for "mavenAutoDeployDemo"? (net.biancheng.www:mavenAutoDeployDemo) 1.1-SNAPSHOT: :

询问 mavenAutoDeployDemo 项目新的开发版本是什么？默认值是1.1-SNAPSHOT，此处我们直接回车使用默认值。

令执行完成后，查看该项目的 pom.xml，发现其版本号已经更新为 1.1-SNAPSHOT，如图 2 所示。

图2：更新版本号

6. 执行以下 mvn 令，将正式版本的构件发布到 Nexus 中。

mvn release:perform

执行结果如下。

[INFO] Scanning for projects...
[INFO]
[INFO] ---------------< net.biancheng.www:mavenAutoDeployDemo >----------------
[INFO] Building mavenAutoDeployDemo 1.1-SNAPSHOT
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- maven-release-plugin:2.5.3:perform (default-cli) @ mavenAutoDeployDemo ---
[INFO] Checking out the project to perform the release ...
[INFO] Executing: cmd.exe /X /C "git clone --branch mavenAutoDeployDemo-1.0 https://githu网站站点" rel="nofollow"  />   
图3：Nexus 仓库中查看构件

注意：
运行令前，一定要将所有代码都提交到 Git，不然会报错。
当发布完成后，项目的版本号会自动更新，并且将正式版发布到指定的 Release 库中。