SpringBoot项目打包(IDEA中操作)-SpringBoot打包不同环境配置与shell脚本部署-《Java笔记》

admin 2025-10-19 05:43:39 编程 来源:ZONE.CI 全球网 0 阅读模式

Java SpringBoot Shell

1、前言

SpringBoot打包并结合shell脚本命令部署:

  • profiles指定不同环境的配置
  • maven-assembly-plugin打发布压缩包
  • shenniu_publish.sh程序启动工具
  • Linux上使用shenniu_publish.sh启动程序

    2、profiles指定不同环境的配置

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

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

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

这里要说的是第二种,首先在mvn中配置如下内容:

  1. <profiles>
  2. <profile>
  3. <id>node</id>
  4. <properties>
  5. <!--传递给脚本的参数值-->
  6. <activeProfile>dev</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>uat</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>prod</activeProfile>
  26. <package-name>${scripts_packageName}</package-name>
  27. <boot-main>${scripts_bootMain}</boot-main>
  28. </properties>
  29. </profile>
  30. </profiles>

节点说明:

  • id:用来指定不同环境配置文件所在的目录,如下这里:

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

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

    3、maven-assembly-plugin打发布压缩包

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

    <plugin>
  • <groupId>org.apache.maven.plugins</groupId><artifactId>maven-jar-plugin</artifactId><version>2.6</version><configuration>%20%20<archive>%20%20%20%20<addMavenDescriptor>false</addMavenDescriptor>%20%20%20%20<manifest>%20%20%20%20%20%20<addClasspath>true</addClasspath>%20%20%20%20%20%20<classpathPrefix>lib/</classpathPrefix>%20%20%20%20%20%20<mainClass>${scripts_bootMain}</mainClass>%20%20%20%20</manifest>%20%20</archive>%20%20<!--打包排除项-->%20%20<excludes>%20%20%20%20<exclude>**/*.yml</exclude>%20%20%20%20<exclude>**/*.properties</exclude>%20%20%20%20<exclude>**/*.xml</exclude>%20%20%20%20<exclude>**/*.sh</exclude>%20%20</excludes></configuration><executions>%20%20<execution>%20%20%20%20<id>make-a-jar</id>%20%20%20%20<phase>compile</phase>%20%20%20%20<goals>%20%20%20%20%20%20<goal>jar</goal>%20%20%20%20</goals>%20%20</execution></executions></plugin> <plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-assembly-plugin</artifactId><version>2.4</version><!--%20The%20configuration%20of%20the%20plugin%20--><configuration>%20%20<!--%20Specifies%20the%20configuration%20file%20of%20the%20assembly%20plugin%20-->%20%20<descriptors>%20%20%20%20<descriptor>${project.basedir}/src/main/assembly/assembly.xml</descriptor>%20%20</descriptors></configuration><executions>%20%20<execution>%20%20%20%20<id>make-assembly</id>%20%20%20%20<phase>package</phase>%20%20%20%20<goals>%20%20%20%20%20%20<goal>single</goal>%20%20%20%20</goals>%20%20</execution></executions></plugin>

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

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

  • excludes节点:排除主jar包中配置等一些列后缀文件,因为要包这些配置文件放到主包外面
  • descriptor节点:用来指定assembly插件对应的assembly.xml配置文件

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

<assembly%20xmlns="http://maven.apache.org/ASSEMBLY/2.0.0"%20xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"%20%20%20%20%20%20%20%20%20%20xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/2.0.0%20http://maven.apache.org/xsd/assembly-2.0.0.xsdhttp://maven.apache.org/ASSEMBLY/2.0.0%20">%20%20%20%20<id>${activeProfile}</id>%20%20%20%20<!--打包成一个用于发布的zip文件-->%20%20%20%20<formats>%20%20%20%20%20%20%20%20<format>zip</format>%20%20%20%20</formats>%20%20%20%20<!--true:zip中生成一级目录(此处屏蔽,配合脚本需要profiles后缀)-->%20%20%20%20<includeBaseDirectory>false</includeBaseDirectory>%20%20%20%20<dependencySets>%20%20%20%20%20%20%20%20<dependencySet>%20%20%20%20%20%20%20%20%20%20%20%20<!--打包进zip文件的lib目录-->%20%20%20%20%20%20%20%20%20%20%20%20<useProjectArtifact>false</useProjectArtifact>%20%20%20%20%20%20%20%20%20%20%20%20<outputDirectory>${package-name}-${activeProfile}/lib</outputDirectory>%20%20%20%20%20%20%20%20%20%20%20%20<unpack>false</unpack>%20%20%20%20%20%20%20%20</dependencySet>%20%20%20%20</dependencySets>%20%20%20%20<fileSets>%20%20%20%20%20%20%20%20<!--%20配置文件打包进zip文件的conf目录%20-->%20%20%20%20%20%20%20%20<fileSet>%20%20%20%20%20%20%20%20%20%20%20%20<directory>${project.basedir}/src/main/profiles/${activeProfile}</directory>%20%20%20%20%20%20%20%20%20%20%20%20<outputDirectory>${package-name}-${activeProfile}/conf</outputDirectory>%20%20%20%20%20%20%20%20%20%20%20%20<includes>%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20<include>**/*</include>%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20<!--<include>*.xml</include>-->%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20<!--<include>*.properties</include>-->%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20<!--<include>*.yml</include>-->%20%20%20%20%20%20%20%20%20%20%20%20</includes>%20%20%20%20%20%20%20%20</fileSet>%20%20%20%20%20%20%20%20<!--启动脚本打包进zip文件-->%20%20%20%20%20%20%20%20<fileSet>%20%20%20%20%20%20%20%20%20%20%20%20<directory>${project.basedir}/src/main/scripts</directory>%20%20%20%20%20%20%20%20%20%20%20%20<outputDirectory></outputDirectory>%20%20%20%20%20%20%20%20%20%20%20%20<includes>%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20<include>**/*</include>%20%20%20%20%20%20%20%20%20%20%20%20</includes>%20%20%20%20%20%20%20%20%20%20%20%20<!--%20文件文件权限为777%20-->%20%20%20%20%20%20%20%20%20%20%20%20<fileMode>777</fileMode>%20%20%20%20%20%20%20%20%20%20%20%20<!--%20目录权限为777%20%20-->%20%20%20%20%20%20%20%20%20%20%20%20<directoryMode>777</directoryMode>%20%20%20%20%20%20%20%20%20%20%20%20<!--脚本中参数变量为pom中的值%20关键-->%20%20%20%20%20%20%20%20%20%20%20%20<filtered>true</filtered>%20%20%20%20%20%20%20%20</fileSet>%20%20%20%20%20%20%20%20<!--%20项目编译出来的jar打包进zip文件%20-->%20%20%20%20%20%20%20%20<fileSet>%20%20%20%20%20%20%20%20%20%20%20%20<directory>${project.build.directory}</directory>%20%20%20%20%20%20%20%20%20%20%20%20<outputDirectory>${package-name}-${activeProfile}/</outputDirectory>%20%20%20%20%20%20%20%20%20%20%20%20<includes>%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20<include>*.jar</include>%20%20%20%20%20%20%20%20%20%20%20%20</includes>%20%20%20%20%20%20%20%20</fileSet>%20%20%20%20</fileSets></assembly>

重点节点介绍:

  • formats节点:把配置文件和jar包等压缩成什么文件格式,这里可以有:zip,tar等
  • fileMode节点:指定scripts目录下脚本文件(这里是:shenniu_publish.sh)在linux上文件权限为777
  • filtered节点:脚本中参数变量为pom的profiles中properties的值(该配置,是把mvn中属性值映射生成到sh文件中,如:${package-name})

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

4、shenniu_publish.sh程序启动工具

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

  • 解压zip+启动jar包
  • 启动jar包
  • 停止对应jar运行
  • 重启jar程序

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

  • java -cp
  • java -jar

如图命令格式:image.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文件内容如:SpringBoot打包不同环境配置与shell脚本部署 - 图5

5、Linux上使用shenniu_publish.sh启动程序

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

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

其实shell脚本中包含有解压命令,但是在打包时放在了zip中,所以只能通过手动解压了,当然可以调整;此时进入加压目录如此:SpringBoot打包不同环境配置与shell脚本部署 - 图6注:这里第一次执行./shenniu_publish.sh脚本时候,提示了错误信息;是由于是在windows上编辑的这个脚本,其空格等和linux上不一样,所以运行会有问题,要解决可以使用vim命令在linux把该文件转成linux格式,如下命令:

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

执行完后,再来运行脚本./shenniu_publish.sh,此时有如下提示:SpringBoot打包不同环境配置与shell脚本部署 - 图7此刻文件是解压状态,因此只需要start命令启动程序即可:SpringBoot打包不同环境配置与shell脚本部署 - 图8到这里shenniu_publish.sh脚本使用就完成了,只要脚本没有提示错误,基本都能启动jar服务;其他restart和stop命令也如此执行就行:SpringBoot打包不同环境配置与shell脚本部署 - 图9

以太坊cppgolang区别 编程

以太坊cppgolang区别

以太坊是一种去中心化的开源平台,它采用智能合约技术,旨在构建和运行不受干扰的分布式应用程序。作为目前最受欢迎的区块链平台之一,以太坊提供了多种编程语言的支持,其
progolang 编程

progolang

Go语言(Golang)是由Google开发的一门静态类型编程语言。作为一名专业的Golang开发者,我深知这门语言的优势和特点。在本文中,我将介绍Golang
golangn个发送者 编程

golangn个发送者

Golang是一种开源的编程语言,由Google团队开发,旨在提高程序的并发性和简化软件开发过程。在Go语言中,有时需要向多个接收者发送信息。本文将介绍如何在G
golang技能图谱 编程

golang技能图谱

从互联网行业的快速发展到人工智能技术的日益成熟,各种编程语言也应运而生。而在这众多的编程语言中,Golang(即Go)作为一门强大且高效的开发语言备受关注。Go
评论:0   参与:  9