Maven插件wagon-maven-plugin自动化部署Java项目到Linux远程服务器

我就是我 2022-05-26 07:45 311阅读 0赞

通常情况下，程序开发完成后部署到线上Linux服务器，可能需要经历打包、将包文件传到服务器、SSH连上服务器、敲命令启动程序等一系列繁琐的步骤。实际上这些步骤都可以通过Maven的一个插件[wagon-maven-plugin][]来自动完成

## 文件上传到服务器 ##

Maven项目可使用`mvn package`指令打包，打包完成后包位于target目录下，要想在远程服务器上部署，首先要将包上传到服务器。

在项目的pom.xml中配置wagon-maven-plugin插件：

`<fromFile>target/test.jar</fromFile>`是要上传到服务器的文件，一般来说是jar或者war包，`<url>scp://user:password@192.168.20.128/home/xxg/Desktop</url>`配置服务器的用户、密码、地址以及文件上传的目录。

配置完成后，运行命令：

`package`、`wagon:upload-single`分别对项目进行打包和上传操作。命令运行结束后，文件就会成功上传到Linux服务器。

## 在服务器上执行Linux命令 ##

部署项目不仅要把包传上服务器，而且还需要执行一些指令来启动程序。在程序启动之前，可能还需要将原来的程序关闭。

### 运行jar文件 ###

启动jar包通常会使用`java -jar test.jar`命令，可以将命令配置在pom.xml中：

<table style="margin:0px;padding:0px;border:0px;font-weight:inherit;font-style:inherit;font-family:inherit;font-size:14.4px;vertical-align:middle;border-spacing:0px;max-width:100%;width:auto;"> 
 <tbody style="margin:0px;padding:0px;font-weight:inherit;font-style:inherit;font-family:inherit;font-size:14.4px;vertical-align:baseline;"> 
 <tr style="margin:0px;padding:0px;border-top:0px;font-weight:inherit;font-style:inherit;font-family:inherit;font-size:14.4px;vertical-align:baseline;"> 
 <td style="margin:0px;padding:0px;border-style:none;font-style:inherit;font-family:inherit;font-size:14.4px;vertical-align:middle;line-height:1.3em;"><pre style="margin-bottom:0px;padding-right:1.5em;padding-left:0px;border:none;font-weight:inherit;font-style:inherit;font-family:Monaco, Menlo, Consolas, 'Courier New', monospace;font-size:.9em;vertical-align:baseline;background:rgb(238,238,238);color:rgb(153,153,153);line-height:1.5;text-align:right;">1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
</pre></td> 
 <td style="margin:0px;padding:0px;border-style:none;font-style:inherit;font-family:inherit;font-size:14.4px;vertical-align:middle;line-height:1.3em;"><pre style="margin-bottom:0px;padding-right:0px;padding-left:0px;border:none;font-weight:inherit;font-style:inherit;font-family:Monaco, Menlo, Consolas, 'Courier New', monospace;font-size:.9em;vertical-align:baseline;background:rgb(238,238,238);color:rgb(77,77,76);line-height:1.5;">&lt;build&gt;
	&lt;extensions&gt;
		&lt;extension&gt;
			&lt;groupId&gt;org.apache.maven.wagon&lt;/groupId&gt;
			&lt;artifactId&gt;wagon-ssh&lt;/artifactId&gt;
			&lt;version&gt;2.8&lt;/version&gt;
		&lt;/extension&gt;
	&lt;/extensions&gt;
	&lt;plugins&gt;
		&lt;plugin&gt;
			&lt;groupId&gt;org.codehaus.mojo&lt;/groupId&gt;
			&lt;artifactId&gt;wagon-maven-plugin&lt;/artifactId&gt;
			&lt;version&gt;1.0&lt;/version&gt;
			&lt;configuration&gt;
				&lt;fromFile&gt;target/test.jar&lt;/fromFile&gt;
				&lt;url&gt;scp://user:password@192.168.20.128/home/xxg/Desktop&lt;/url&gt;
				&lt;commands&gt;
					&lt;!-- 杀死原来的进程 --&gt;
					&lt;command&gt;pkill -f test.jar&lt;/command&gt;
					&lt;!-- 重新启动test.jar，程序的输出结果写到nohup.out文件中 --&gt;
					&lt;command&gt;nohup java -jar /home/xxg/Desktop/test.jar &gt; /home/xxg/Desktop/nohup.out 2&gt;&amp;amp;1 &amp;amp;&lt;/command&gt;
				&lt;/commands&gt;
				&lt;!-- 显示运行命令的输出结果 --&gt;
				&lt;displayCommandOutputs&gt;true&lt;/displayCommandOutputs&gt;
			&lt;/configuration&gt;
		&lt;/plugin&gt;
	&lt;/plugins&gt;
&lt;/build&gt;
</pre></td> 
 </tr> 
 </tbody> 
</table>

配置完成后，运行命令：

`package`、`wagon:upload-single`、`wagon:sshexec`分别对项目进行打包、上传、运行command命令的操作。命令运行结束后，在服务器上查看进程`ps -ef|grep test.jar`，或者查看nohup.out文件，就可以看到Java程序在服务器上已经启动。

### 上传war包并启动Tomcat ###

如果是Web应用，可使用服务器上的Tomcat来部署。

<table style="margin:0px;padding:0px;border:0px;font-weight:inherit;font-style:inherit;font-family:inherit;font-size:14.4px;vertical-align:middle;border-spacing:0px;max-width:100%;width:auto;"> 
 <tbody style="margin:0px;padding:0px;font-weight:inherit;font-style:inherit;font-family:inherit;font-size:14.4px;vertical-align:baseline;"> 
 <tr style="margin:0px;padding:0px;border-top:0px;font-weight:inherit;font-style:inherit;font-family:inherit;font-size:14.4px;vertical-align:baseline;"> 
 <td style="margin:0px;padding:0px;border-style:none;font-style:inherit;font-family:inherit;font-size:14.4px;vertical-align:middle;line-height:1.3em;"><pre style="margin-bottom:0px;padding-right:1.5em;padding-left:0px;border:none;font-weight:inherit;font-style:inherit;font-family:Monaco, Menlo, Consolas, 'Courier New', monospace;font-size:.9em;vertical-align:baseline;background:rgb(238,238,238);color:rgb(153,153,153);line-height:1.5;text-align:right;">1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
</pre></td> 
 <td style="margin:0px;padding:0px;border-style:none;font-style:inherit;font-family:inherit;font-size:14.4px;vertical-align:middle;line-height:1.3em;"><pre style="margin-bottom:0px;padding-right:0px;padding-left:0px;border:none;font-weight:inherit;font-style:inherit;font-family:Monaco, Menlo, Consolas, 'Courier New', monospace;font-size:.9em;vertical-align:baseline;background:rgb(238,238,238);color:rgb(77,77,76);line-height:1.5;">&lt;build&gt;
	&lt;extensions&gt;
		&lt;extension&gt;
			&lt;groupId&gt;org.apache.maven.wagon&lt;/groupId&gt;
			&lt;artifactId&gt;wagon-ssh&lt;/artifactId&gt;
			&lt;version&gt;2.8&lt;/version&gt;
		&lt;/extension&gt;
	&lt;/extensions&gt;
	&lt;plugins&gt;
		&lt;plugin&gt;
			&lt;groupId&gt;org.codehaus.mojo&lt;/groupId&gt;
			&lt;artifactId&gt;wagon-maven-plugin&lt;/artifactId&gt;
			&lt;version&gt;1.0&lt;/version&gt;
			&lt;configuration&gt;
				&lt;fromFile&gt;target/javawebdeploy.war&lt;/fromFile&gt;
				&lt;!-- 上传到Tomcat的webapps目录下 --&gt;
				&lt;url&gt;scp://user:password@192.168.20.128/coder/tomcat/apache-tomcat-7.0.55/webapps&lt;/url&gt;
				&lt;commands&gt;
					&lt;!-- 重启Tomcat --&gt;
					&lt;command&gt;sh /coder/tomcat/apache-tomcat-7.0.55/bin/shutdown.sh&lt;/command&gt;
					&lt;command&gt;rm -rf /coder/tomcat/apache-tomcat-7.0.55/webapps/javawebdeploy&lt;/command&gt;
					&lt;command&gt;sh /coder/tomcat/apache-tomcat-7.0.55/bin/startup.sh&lt;/command&gt;
				&lt;/commands&gt;
				&lt;displayCommandOutputs&gt;true&lt;/displayCommandOutputs&gt;
			&lt;/configuration&gt;
		&lt;/plugin&gt;
	&lt;/plugins&gt;
&lt;/build&gt;
</pre></td> 
 </tr> 
 </tbody> 
</table>

完成以上配置后，同样可通过`mvn clean package wagon:upload-single wagon:sshexec`命令自动部署。

## 配置execution ##

如果你觉得`mvn clean package wagon:upload-single wagon:sshexec`命令太长了不好记，那么可以配置execution，在运行package打包的同时运行upload-single和sshexec。

<table style="margin:0px;padding:0px;border:0px;font-weight:inherit;font-style:inherit;font-family:inherit;font-size:14.4px;vertical-align:middle;border-spacing:0px;max-width:100%;width:auto;"> 
 <tbody style="margin:0px;padding:0px;font-weight:inherit;font-style:inherit;font-family:inherit;font-size:14.4px;vertical-align:baseline;"> 
 <tr style="margin:0px;padding:0px;border-top:0px;font-weight:inherit;font-style:inherit;font-family:inherit;font-size:14.4px;vertical-align:baseline;"> 
 <td style="margin:0px;padding:0px;border-style:none;font-style:inherit;font-family:inherit;font-size:14.4px;vertical-align:middle;line-height:1.3em;"><pre style="margin-bottom:0px;padding-right:1.5em;padding-left:0px;border:none;font-weight:inherit;font-style:inherit;font-family:Monaco, Menlo, Consolas, 'Courier New', monospace;font-size:.9em;vertical-align:baseline;background:rgb(238,238,238);color:rgb(153,153,153);line-height:1.5;text-align:right;">1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
</pre></td> 
 <td style="margin:0px;padding:0px;border-style:none;font-style:inherit;font-family:inherit;font-size:14.4px;vertical-align:middle;line-height:1.3em;"><pre style="margin-bottom:0px;padding-right:0px;padding-left:0px;border:none;font-weight:inherit;font-style:inherit;font-family:Monaco, Menlo, Consolas, 'Courier New', monospace;font-size:.9em;vertical-align:baseline;background:rgb(238,238,238);color:rgb(77,77,76);line-height:1.5;">&lt;build&gt;
	&lt;extensions&gt;
		&lt;extension&gt;
			&lt;groupId&gt;org.apache.maven.wagon&lt;/groupId&gt;
			&lt;artifactId&gt;wagon-ssh&lt;/artifactId&gt;
			&lt;version&gt;2.8&lt;/version&gt;
		&lt;/extension&gt;
	&lt;/extensions&gt;
	&lt;plugins&gt;
		&lt;plugin&gt;
			&lt;groupId&gt;org.codehaus.mojo&lt;/groupId&gt;
			&lt;artifactId&gt;wagon-maven-plugin&lt;/artifactId&gt;
			&lt;version&gt;1.0&lt;/version&gt;
			&lt;executions&gt;
				&lt;execution&gt;
					&lt;id&gt;upload-deploy&lt;/id&gt;
					&lt;!-- 运行package打包的同时运行upload-single和sshexec --&gt;
					&lt;phase&gt;package&lt;/phase&gt;
					&lt;goals&gt;
						&lt;goal&gt;upload-single&lt;/goal&gt;
						&lt;goal&gt;sshexec&lt;/goal&gt;
					&lt;/goals&gt;
					&lt;configuration&gt;
						&lt;fromFile&gt;target/javawebdeploy.war&lt;/fromFile&gt;
						&lt;url&gt;scp://user:password@192.168.20.128/coder/tomcat/apache-tomcat-7.0.55/webapps&lt;/url&gt;
						&lt;commands&gt;
							&lt;command&gt;sh /coder/tomcat/apache-tomcat-7.0.55/bin/shutdown.sh&lt;/command&gt;
							&lt;command&gt;rm -rf /coder/tomcat/apache-tomcat-7.0.55/webapps/javawebdeploy&lt;/command&gt;
							&lt;command&gt;sh /coder/tomcat/apache-tomcat-7.0.55/bin/startup.sh&lt;/command&gt;
						&lt;/commands&gt;
						&lt;displayCommandOutputs&gt;true&lt;/displayCommandOutputs&gt;
					&lt;/configuration&gt;
				&lt;/execution&gt;
			&lt;/executions&gt;
		&lt;/plugin&gt;
	&lt;/plugins&gt;
&lt;/build&gt;
</pre></td> 
 </tr> 
 </tbody> 
</table>

配置完成后，即可使用`mvn clean package`来代替`mvn clean package wagon:upload-single wagon:sshexec`。

转载于：http://xxgblog.com/2015/10/23/wagon-maven-plugin/

[wagon-maven-plugin]: http://www.mojohaus.org/wagon-maven-plugin/index.html