我们公司使用了 6 年的项目部署方案!打包 + Shell 脚本部署详解,稳的一批!

举报
民工哥 发表于 2022/05/20 22:27:29 2022/05/20
【摘要】 点关注公众号,回复“1024”获取2TB学习资源! 本篇和大家分享的是 Spring Boot 打包并结合 Shell 脚本命令部署,重点在分享一个shell 程序启动工具,希望能便利工作; profiles指定不同环境的配置maven-assembly-plugin打发布压缩包分享shenniu_publish.sh程序启动...

7a4246b4e9a50bd36a433f7788945720.gif关注公众号,回复“1024”获取2TB学习资源!

本篇和大家分享的是 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>
  5.                 <!--传递给脚本的参数值-->
  6.                 <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:用来指定不同环境配置文件所在的目录,如下我这里:

037f6775aef0dabd46f2bba19956a95c.png

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

de1d4b26af8a28cfc4f7127682e9c73d.png

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>
  14.         <!--打包排除项-->
  15.         <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>
  32. <plugin>
  33.     <groupId>org.apache.maven.plugins</groupId>
  34.     <artifactId>maven-assembly-plugin</artifactId>
  35.     <version>2.4</version>
  36.     <!-- The configuration of the plugin -->
  37.     <configuration>
  38.         <!-- Specifies the configuration file of the assembly plugin -->
  39.         <descriptors>
  40.             <descriptor>${project.basedir}/src/main/assembly/assembly.xml</descriptor>
  41.         </descriptors>
  42.     </configuration>
  43.     <executions>
  44.         <execution>
  45.             <id>make-assembly</id>
  46.             <phase>package</phase>
  47.             <goals>
  48.                 <goal>single</goal>
  49.             </goals>
  50.         </execution>
  51.     </executions>
  52. </plugin>

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

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

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

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

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


   
  1. <assembly xmlns="http://maven.apache.org/ASSEMBLY/2.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  2.           xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/2.0.0 http://maven.apache.org/xsd/assembly-2.0.0.xsd
  3. http://maven.apache.org/ASSEMBLY/2.0.0 ">
  4.     <id>${activeProfile}</id>
  5.     <!--打包成一个用于发布的zip文件-->
  6.     <formats>
  7.         <format>zip</format>
  8.     </formats>
  9.     <!--true:zip中生成一级目录(此处屏蔽,配合脚本需要profiles后缀)-->
  10.     <includeBaseDirectory>false</includeBaseDirectory>
  11.     <dependencySets>
  12.         <dependencySet>
  13.             <!--打包进zip文件的lib目录-->
  14.             <useProjectArtifact>false</useProjectArtifact>
  15.             <outputDirectory>${package-name}-${activeProfile}/lib</outputDirectory>
  16.             <unpack>false</unpack>
  17.         </dependencySet>
  18.     </dependencySets>
  19.     <fileSets>
  20.         <!-- 配置文件打包进zip文件的conf目录 -->
  21.         <fileSet>
  22.             <directory>${project.basedir}/src/main/profiles/${activeProfile}</directory>
  23.             <outputDirectory>${package-name}-${activeProfile}/conf</outputDirectory>
  24.             <includes>
  25.                 <include>**/*</include>
  26.                 <!--<include>*.xml</include>-->
  27.                 <!--<include>*.properties</include>-->
  28.                 <!--<include>*.yml</include>-->
  29.             </includes>
  30.         </fileSet>
  31.         <!--启动脚本打包进zip文件-->
  32.         <fileSet>
  33.             <directory>${project.basedir}/src/main/scripts</directory>
  34.             <outputDirectory></outputDirectory>
  35.             <includes>
  36.                 <include>**/*</include>
  37.             </includes>
  38.             <!-- 文件文件权限为777 -->
  39.             <fileMode>777</fileMode>
  40.             <!-- 目录权限为777 -->
  41.             <directoryMode>777</directoryMode>
  42.             <!--脚本中参数变量为pom中的值 关键-->
  43.             <filtered>true</filtered>
  44.         </fileSet>
  45.         <!-- 项目编译出来的jar打包进zip文件 -->
  46.         <fileSet>
  47.             <directory>${project.build.directory}</directory>
  48.             <outputDirectory>${package-name}-${activeProfile}/</outputDirectory>
  49.             <includes>
  50.                 <include>*.jar</include>
  51.             </includes>
  52.         </fileSet>
  53.     </fileSets>
  54. </assembly>

重点节点介绍:

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

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

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

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

651b877eee4280122097ce782660515e.png

分享shenniu_publish.sh程序启动工具

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

  • 解压zip+启动jar包

  • 启动jar包

  • 停止对应jar运行

  • 重启jar程序

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


   
  1. java -cp
  2. java -jar

如图命令格式:

8560fadefe6be4f1dfa279e86dc173c1.png

来看全部的shell代码:


   
  1. #!/usr/bin/env bash
  2. #可变参数变量
  3. languageType="javac" #支持 java,javac,netcore 发布
  4. #参数值由pom文件传递
  5. baseZipName="${package-name}-${activeProfile}" #压缩包名称 publish-test.zip的publish
  6. packageName="${package-name}" #命令启动包名 xx.jar的xx
  7. mainclass="${boot-main}" #java -cp启动时,指定main入口类;命令:java -cp conf;lib\*.jar;${packageName}.jar ${mainclass}
  8. #例子
  9. # baseZipName="publish-test" #压缩包名称 publish-test.zip的publish
  10. # packageName="publish" #命令启动包名 publish.jar的xx
  11. #固定变量
  12. basePath=$(cd `dirname $0`/; pwd)
  13. baseZipPath="${basePath}/${baseZipName}.zip"  #压缩包路径
  14. baseDirPath="${basePath}" #解压部署磁盘路径
  15. pid= #进程pid
  16. #解压
  17. function shenniu_unzip()
  18. {
  19.     echo "解压---------------------------------------------"
  20.     echo "压缩包路径:${baseZipPath}"
  21.     if [ ! `find ${baseZipPath}` ]
  22.     then
  23.         echo "不存在压缩包:${baseZipPath}"
  24.     else
  25.         echo "解压磁盘路径:${baseDirPath}/${baseZipName}"
  26.         echo "开始解压..."
  27.         #解压命令
  28.         unzip -od ${baseDirPath}/${baseZipName} ${baseZipPath}
  29.         #设置执行权限
  30.         chmod +x ${baseDirPath}/${baseZipName}/${packageName}
  31.         echo "解压完成。"
  32.     fi
  33. }
  34. #检测pid
  35. function getPid()
  36. {
  37.     echo "检测状态---------------------------------------------"
  38.     pid=`ps -ef | grep -n ${packageName} | grep -v grep | awk '{print $2}'`
  39.     if [ ${pid} ]
  40.     then
  41.         echo "运行pid:${pid}"
  42.     else
  43.         echo "未运行"
  44.     fi
  45. }
  46. #启动程序
  47. function start()
  48. {
  49.     #启动前,先停止之前的
  50.     stop
  51.     if [ ${pid} ]
  52.     then
  53.         echo "停止程序失败,无法启动"
  54.     else
  55.         echo "启动程序---------------------------------------------"
  56.         #选择语言类型
  57.         read -p "输入程序类型(java,javac,netcore),下一步按回车键(默认:${languageType}):" read_languageType
  58.         if [ ${read_languageType} ]
  59.         then
  60.             languageType=${read_languageType}
  61.         fi
  62.         echo "选择程序类型:${languageType}"
  63.         #进入运行包目录
  64.         cd ${baseDirPath}/${baseZipName}
  65.         #分类启动
  66.         if [ "${languageType}" == "javac" ]
  67.         then
  68.             if [ ${mainclass} ]
  69.             then
  70.                 nohup java -cp conf:lib\*.jar:${packageName}.jar ${mainclass} >${baseDirPath}/${packageName}.out 2>&1 &
  71.                #nohup java -cp conf:lib\*.jar:${packageName}.jar ${mainclass} >/dev/null 2>&1 &
  72.             fi
  73.         elif [ "${languageType}" == "java" ]
  74.         then
  75.             nohup java -jar ${baseDirPath}/${baseZipName}/${packageName}.jar >/dev/null 2>&1 &
  76.             # java -jar ${baseDirPath}/${baseZipName}/${packageName}.jar
  77.         elif [ "${languageType}" == "netcore" ]
  78.         then
  79.             #nohup dotnet run ${baseDirPath}/${baseZipName}/${packageName} >/dev/null 2>&1 &
  80.             nohup ${baseDirPath}/${baseZipName}/${packageName} >/dev/null 2>&1 &
  81.         fi
  82.         #查询是否有启动进程
  83.         getPid
  84.         if [ ${pid} ]
  85.         then
  86.             echo "已启动"
  87.             #nohup日志
  88.             tail -n 50 -f ${baseDirPath}/${packageName}.out
  89.         else
  90.             echo "启动失败"
  91.         fi
  92.     fi
  93. }
  94. #停止程序
  95. function stop()
  96. {
  97.     getPid
  98.     if [ ${pid} ]
  99.     then
  100.         echo "停止程序---------------------------------------------"
  101.         kill -9 ${pid}
  102.         getPid
  103.         if [ ${pid} ]
  104.         then
  105.             #stop
  106.             echo "停止失败"
  107.         else
  108.             echo "停止成功"
  109.         fi
  110.     fi
  111. }
  112. #启动时带参数,根据参数执行
  113. if [ ${#} -ge 1 ]
  114. then
  115.     case ${1} in
  116.         "start")
  117.             start
  118.         ;;
  119.         "restart")
  120.             start
  121.         ;;
  122.         "stop")
  123.             stop
  124.         ;;
  125.         "unzip")
  126.             #执行解压
  127.             shenniu_unzip
  128.             #执行启动
  129.             start
  130.         ;;
  131.         *)
  132.             echo "${1}无任何操作"
  133.         ;;
  134.     esac
  135. else
  136.     echo "
  137.     command如下命令:
  138.     unzip:解压并启动
  139.     start:启动
  140.     stop:停止进程
  141.     restart:重启
  142.     示例命令如:./shenniu_publish start
  143.     "
  144. fi

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

33818ae32fdbf97afe73d85e76f2d0b4.png

把生成的zip上传到linux上,通过命令解压:

unzip -od eureka-server-0.0.1-node eureka-server-0.0.1-node.zip
  

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

215ae270df6ad4797c2a27cab5826978.png

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


   
  1. vim shenniu_publish.sh
  2. set ff=unix
  3. :wq

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

e407cb73765af2ce6942a6599233a886.png

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

40856ec6352d49518296acfef09d5b07.png

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

3a3d824b6a418a25f872eb90ccaedb10.png

可以去研究下shell代码,希望该脚本能给你带来效率和好的学习思路,下面是测试用例git地址,脚本在eureka-server项目中:https://github.com/shenniubuxing3/springcloud-Finchley.SR2

来源:神牛003

cnblogs.com/wangrudong003/p/10502043.html

edb74015e7428f7e78b169a423a4567e.png

5eea9e10a36498bfa8ef91b1f0bd2136.png

推荐阅读 点击标题可跳转

Red Hat Enterprise Linux 9 正式发布!真学不动了

那个“快播”,彻底没了。。。

Ubuntu 最新版震撼发布 !手里的系统瞬间不香了

终身免费!微软数据恢复工具,界面版体验

MySQL 暴跌!!!

再复杂的架构图,也能轻松搞定!附教程+工具

044f02ebc33055e751ce7bdc2417cafc.png

转发 关注

点亮下方“在看”图标

更多人看到

文章来源: mingongge.blog.csdn.net,作者:民工哥,版权归原作者所有,如需转载,请联系作者。

原文链接:mingongge.blog.csdn.net/article/details/124874966

【版权声明】本文为华为云社区用户转载文章,如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱: cloudbbs@huaweicloud.com
  • 点赞
  • 收藏
  • 关注作者

评论(0

0/1000
抱歉,系统识别当前为高风险访问,暂不支持该操作

全部回复

上滑加载中

设置昵称

在此一键设置昵称,即可参与社区互动!

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。