1500字范文 > 我司Spring Boot 项目打包 + Shell 脚本部署详细总结太有用了!

我司Spring Boot 项目打包 + Shell 脚本部署详细总结太有用了!

时间：2020-06-14 07:36:06

欢迎关注方志朋的博客，回复”666“获面试宝典

本篇和大家分享的是 Spring Boot 打包并结合 Shell 脚本命令部署，重点在分享一个shell 程序启动工具，希望能便利工作；

profiles指定不同环境的配置

maven-assembly-plugin打发布压缩包

分享shenniu_publish.sh程序启动工具

linux上使用shenniu_publish.sh启动程序

profiles指定不同环境的配置

通常一套程序分为了很多个部署环境：开发，测试，uat，线上等，我们要想对这些环境区分配置文件，可以通过两种方式：

通过application.yml中编码指定 profile.active=uat 方式指定

通过mvn中profiles来区分不同环境对应的配置文件夹，人工可以手动在idea勾选生成不同环境的包(推荐)

这里我们要讲的是第二种，首先在mvn中配置如下内容：

1<profiles>2<profile>3<id>node</id>4<properties>56<activeProfile>node</activeProfile>7<package-name>${scripts_packageName}</package-name>8<boot-main>${scripts_bootMain}</boot-main>9</properties>10<activation>11<activeByDefault>true</activeByDefault>12</activation>13</profile>14<profile>15<id>node1</id>16<properties>17<activeProfile>node1</activeProfile>18<package-name>${scripts_packageName}</package-name>19<boot-main>${scripts_bootMain}</boot-main>20</properties>21</profile>22<profile>23<id>node2</id>24<properties>25<activeProfile>node2</activeProfile>26<package-name>${scripts_packageName}</package-name>27<boot-main>${scripts_bootMain}</boot-main>28</properties>29</profile>30</profiles>

节点粗解：

id：用来指定不同环境配置文件所在的目录，如下我这里：

img

properties：该节点中的节点是可作为参数传递给其他配置文件，如我这里的package-name节点值就可以在另外的assembly.xml或者shell脚本文件中通过${package-name}获取到，如下：

img

activeByDefault：指定默认环境配置文件夹

maven-assembly-plugin打发布压缩包

对于springboot程序打包，可以分为jar和war，这里是jar包；有场景是咋们配置文件或者第三方等依赖包不想放到工程jar中，并且把这些文件压缩成一个zip包，方便上传到linux；此时通过maven-assembly-plugin和maven-jar-plugin就可以做到，mvn的配置如：

1<plugin>2<groupId>org.apache.maven.plugins</groupId>3<artifactId>maven-jar-plugin</artifactId>4<version>2.6</version>5<configuration>6<archive>7<addMavenDescriptor>false</addMavenDescriptor>8<manifest>9<addClasspath>true</addClasspath>10<classpathPrefix>lib/</classpathPrefix>11<mainClass>${scripts_bootMain}</mainClass>12</manifest>13</archive>1415<excludes>16<exclude>**/*.yml</exclude>17<exclude>**/*.properties</exclude>18<exclude>**/*.xml</exclude>19<exclude>**/*.sh</exclude>20</excludes>21</configuration>22<executions>23<execution>24<id>make-a-jar</id>25<phase>compile</phase>26<goals>27<goal>jar</goal>28</goals>29</execution>30</executions>31</plugin>3233<plugin>34<groupId>org.apache.maven.plugins</groupId>35<artifactId>maven-assembly-plugin</artifactId>36<version>2.4</version>3738<configuration>3940<descriptors>41<descriptor>${project.basedir}/src/main/assembly/assembly.xml</descriptor>42</descriptors>43</configuration>44<executions>45<execution>46<id>make-assembly</id>47<phase>package</phase>48<goals>49<goal>single</goal>50</goals>51</execution>52</executions>53</plugin>

值得注意的地方如下几点：

mainClass节点：用来指定启动main函数入口类路径，如这里的：com.sm.EurekaServerApplication

excludes节点：排除主jar包中配置等一些列后缀文件，因为我们要包这些配置文件放到主包外面

descriptor节点：用来指定assembly插件对应的assembly.xml配置文件

有了上面mvn配置，我们还需要assembly.xml的配置，这里提取了结合shell脚本发布程序的配置：

<assemblyxmlns="/ASSEMBLY/2.0.0"xmlns:xsi="/2001/XMLSchema-instance"xsi:schemaLocation="/ASSEMBLY/2.0.0/xsd/assembly-2.0.0.xsd/ASSEMBLY/2.0.0"><id>${activeProfile}</id><formats><format>zip</format></formats><includeBaseDirectory>false</includeBaseDirectory><dependencySets><dependencySet><useProjectArtifact>false</useProjectArtifact><outputDirectory>${package-name}-${activeProfile}/lib</outputDirectory><unpack>false</unpack></dependencySet></dependencySets><fileSets><fileSet><directory>${project.basedir}/src/main/profiles/${activeProfile}</directory><outputDirectory>${package-name}-${activeProfile}/conf</outputDirectory><includes><include>**/*</include></includes></fileSet><fileSet><directory>${project.basedir}/src/main/scripts</directory><outputDirectory></outputDirectory><includes><include>**/*</include></includes><fileMode>777</fileMode><directoryMode>777</directoryMode><filtered>true</filtered></fileSet><fileSet><directory>${project.build.directory}</directory><outputDirectory>${package-name}-${activeProfile}/</outputDirectory><includes><include>*.jar</include></includes></fileSet></fileSets></assembly>

重点节点介绍：

formats节点：把配置文件和jar包等压缩成什么文件格式，这里可以有：zip，tar等

fileMode节点：指定scripts目录下脚本文件(这里是：shenniu_publish.sh)在linux上文件权限为777

filtered节点：脚本中参数变量为pom的profiles中properties的值(该配置，是把mvn中属性值映射生成到sh文件中，如：${package-name})

完成上面配置后，此时我们可以通过idea上勾选切换不同环境来打zip包，如图：

img

分享shenniu_publish.sh程序启动工具

上面步骤完成了zip格式的发布包，我们再分享下启动程序的shell脚本，该脚本具有的功能如：

解压zip+启动jar包

启动jar包

停止对应jar运行

重启jar程序

目前该shell中封装了两种启动jar命令的方式：

java -cp

java -jar

如图命令格式：

img

来看全部的shell代码：

#!/usr/bin/envbash#可变参数变量languageType="javac"#支持java,javac,netcore发布#参数值由pom文件传递baseZipName="${package-name}-${activeProfile}"#压缩包名称publish-test.zip的publishpackageName="${package-name}"#命令启动包名xx.jar的xxmainclass="${boot-main}"#java -cp启动时，指定main入口类;命令：java -cp conf;lib\*.jar;${packageName}.jar ${mainclass}#例子#baseZipName="publish-test"#压缩包名称publish-test.zip的publish#packageName="publish"#命令启动包名publish.jar的xx#固定变量basePath=$(cd`dirname$0`/;pwd)baseZipPath="${basePath}/${baseZipName}.zip"#压缩包路径baseDirPath="${basePath}"#解压部署磁盘路径pid=#进程pid#解压functionshenniu_unzip(){echo"解压---------------------------------------------"echo"压缩包路径：${baseZipPath}"if[!`find${baseZipPath}`]thenecho"不存在压缩包：${baseZipPath}"elseecho"解压磁盘路径：${baseDirPath}/${baseZipName}"echo"开始解压..."#解压命令unzip-od${baseDirPath}/${baseZipName}${baseZipPath}#设置执行权限chmod+x${baseDirPath}/${baseZipName}/${packageName}echo"解压完成。"fi}#检测pidfunctiongetPid(){echo"检测状态---------------------------------------------"pid=`ps-ef|grep-n${packageName}|grep-vgrep|awk'{print$2}'`if[${pid}]thenecho"运行pid：${pid}"elseecho"未运行"fi}#启动程序functionstart(){#启动前，先停止之前的stopif[${pid}]thenecho"停止程序失败，无法启动"elseecho"启动程序---------------------------------------------"#选择语言类型read-p"输入程序类型(java,javac,netcore)，下一步按回车键(默认：${languageType})："read_languageTypeif[${read_languageType}]thenlanguageType=${read_languageType}fiecho"选择程序类型：${languageType}"#进入运行包目录cd${baseDirPath}/${baseZipName}#分类启动if["${languageType}"=="javac"]thenif[${mainclass}]thennohupjava-cpconf:lib\*.jar:${packageName}.jar${mainclass}>${baseDirPath}/${packageName}.out2>&1&#nohupjava-cpconf:lib\*.jar:${packageName}.jar${mainclass}>/dev/null2>&1&fielif["${languageType}"=="java"]thennohupjava-jar${baseDirPath}/${baseZipName}/${packageName}.jar>/dev/null2>&1&#java-jar${baseDirPath}/${baseZipName}/${packageName}.jarelif["${languageType}"=="netcore"]then#nohupdotnetrun${baseDirPath}/${baseZipName}/${packageName}>/dev/null2>&1&nohup${baseDirPath}/${baseZipName}/${packageName}>/dev/null2>&1&fi#查询是否有启动进程getPidif[${pid}]thenecho"已启动"#nohup日志tail-n50-f${baseDirPath}/${packageName}.outelseecho"启动失败"fifi}#停止程序functionstop(){getPidif[${pid}]thenecho"停止程序---------------------------------------------"kill-9${pid}getPidif[${pid}]then#stopecho"停止失败"elseecho"停止成功"fifi}#启动时带参数，根据参数执行if[${#}-ge1]thencase${1}in"start")start;;"restart")start;;"stop")stop;;"unzip")#执行解压shenniu_unzip#执行启动start;;*)echo"${1}无任何操作";;esacelseecho"command如下命令：unzip：解压并启动start：启动stop：停止进程restart：重启示例命令如：./shenniu_publish start"fi

正如上面小节说的，shell中的参数 package-name，activeProfile，boot-main 都是由mvn中profiles的properties中提供，是可变的参数，脚本代码本身不需要人工去修改，只需要变的是mvn的参数即可；其实在我们生成zip包的时候，shell中的参数就被替换了，可以看zip中shell文件内容如：

img

把生成的zip上传到linux上，通过命令解压：

1unzip-odeureka-server-0.0.1-nodeeureka-server-0.0.1-node.zip

其实shell脚本中包含有解压命令，但是我在打包时放在了zip中，所以只能通过手动解压了，当然可以调整；此时进入加压目录如此：

img

注：这里第一次执行./shenniu_publish.sh脚本时候，提示了错误信息；是由于我是在windows上编辑的这个脚本，其空格等和linux上不一样，所以运行会有问题，要解决可以使用vim命令在linux把该文件转成linux格式，如下命令：

1vimshenniu_publish.sh2setff=unix3:wq

执行完后，再来运行脚本./shenniu_publish.sh，此时有如下提示:

img

此刻我们文件是解压状态，因此只需要start命令启动程序即可：

img

到这里shenniu_publish.sh脚本使用就完成了，只要脚本没有提示错误，基本都能启动jar服务；其他restart和stop命令也如此执行就行：