springboot打包不同環(huán)境配置以及shell腳本部署的方法

發(fā)布時(shí)間：2020-08-29 19:00:32 來源：腳本之家閱讀：180 作者：神牛003 欄目：編程語(yǔ)言

前言

本篇和大家分享的是springboot打包并結(jié)合shell腳本命令部署，重點(diǎn)在分享一個(gè)shell程序啟動(dòng)工具，希望能便利工作；

profiles指定不同環(huán)境的配置
maven-assembly-plugin打發(fā)布?jí)嚎s包
分享shenniu_publish.sh程序啟動(dòng)工具
linux上使用shenniu_publish.sh啟動(dòng)程序

profiles指定不同環(huán)境的配置

通常一套程序分為了很多個(gè)部署環(huán)境：開發(fā)，測(cè)試，uat，線上等，我們要想對(duì)這些環(huán)境區(qū)分配置文件，可以通過兩種方式：

通過application.yml中編碼指定 profile.active=uat 方式指定
通過mvn中profiles來區(qū)分不同環(huán)境對(duì)應(yīng)的配置文件夾，人工可以手動(dòng)在idea勾選生成不同環(huán)境的包(推薦)

這里我們要講的是第二種，首先在mvn中配置如下內(nèi)容：

<profiles>
 <profile>
 <id>node</id>
 <properties>
 <!--傳遞給腳本的參數(shù)值-->
 <activeProfile>node</activeProfile>
 <package-name>${scripts_packageName}</package-name>
 <boot-main>${scripts_bootMain}</boot-main>
 </properties>
 <activation>
 <activeByDefault>true</activeByDefault>
 </activation>
 </profile>
 <profile>
 <id>node1</id>
 <properties>
 <activeProfile>node1</activeProfile>
 <package-name>${scripts_packageName}</package-name>
 <boot-main>${scripts_bootMain}</boot-main>
 </properties>
 </profile>
 <profile>
 <id>node2</id>
 <properties>
 <activeProfile>node2</activeProfile>
 <package-name>${scripts_packageName}</package-name>
 <boot-main>${scripts_bootMain}</boot-main>
 </properties>
 </profile>
 </profiles>

節(jié)點(diǎn)粗解：

id：用來指定不同環(huán)境配置文件所在的目錄，如下我這里：

springboot打包不同環(huán)境配置以及shell腳本部署的方法 properties：

該節(jié)點(diǎn)中的節(jié)點(diǎn)是可作為參數(shù)傳遞給其他配置文件，如我這里的package-name節(jié)點(diǎn)值就可以在另外的assembly.xml或者shell腳本文件中通過${package-name}獲取到，如下：

springboot打包不同環(huán)境配置以及shell腳本部署的方法 activeByDefault：

指定默認(rèn)環(huán)境配置文件夾

maven-assembly-plugin打發(fā)布?jí)嚎s包

對(duì)于springboot程序打包，可以分為jar和war，這里是jar包；有場(chǎng)景是咋們配置文件或者第三方等依賴包不想放到工程jar中，并且把這些文件壓縮成一個(gè)zip包，方便上傳到linux；此時(shí)通過maven-assembly-plugin和maven-jar-plugin就可以做到，mvn的配置如：

<plugin>
 <groupId>org.apache.maven.plugins</groupId>
 <artifactId>maven-jar-plugin</artifactId>
 <version>2.6</version>
 <configuration>
 <archive>
 <addMavenDescriptor>false</addMavenDescriptor>
 <manifest>
 <addClasspath>true</addClasspath>
 <classpathPrefix>lib/</classpathPrefix>
 <mainClass>${scripts_bootMain}</mainClass>
 </manifest>
 </archive>
 <!--打包排除項(xiàng)-->
 <excludes>
 <exclude>**/*.yml</exclude>
 <exclude>**/*.properties</exclude>
 <exclude>**/*.xml</exclude>
 <exclude>**/*.sh</exclude>
 </excludes>
 </configuration>
 <executions>
 <execution>
 <id>make-a-jar</id>
 <phase>compile</phase>
 <goals>
 <goal>jar</goal>
 </goals>
 </execution>
 </executions>
 </plugin>

 <plugin>
 <groupId>org.apache.maven.plugins</groupId>
 <artifactId>maven-assembly-plugin</artifactId>
 <version>2.4</version>
 <!-- The configuration of the plugin -->
 <configuration>
 <!-- Specifies the configuration file of the assembly plugin -->
 <descriptors>
 <descriptor>${project.basedir}/src/main/assembly/assembly.xml</descriptor>
 </descriptors>
 </configuration>
 <executions>
 <execution>
 <id>make-assembly</id>
 <phase>package</phase>
 <goals>
 <goal>single</goal>
 </goals>
 </execution>
 </executions>
 </plugin>

值得注意的地方如下幾點(diǎn)：

mainClass節(jié)點(diǎn)：用來指定啟動(dòng)main函數(shù)入口類路徑，如這里的：com.sm.EurekaServerApplication
excludes節(jié)點(diǎn)：排除主jar包中配置等一些列后綴文件，因?yàn)槲覀円@些配置文件放到主包外面
descriptor節(jié)點(diǎn)：用來指定assembly插件對(duì)應(yīng)的assembly.xml配置文件

有了上面mvn配置，我們還需要assembly.xml的配置，這里提取了結(jié)合shell腳本發(fā)布程序的配置：

<assembly xmlns="http://maven.apache.org/ASSEMBLY/2.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/2.0.0 http://maven.apache.org/xsd/assembly-2.0.0.xsd
http://maven.apache.org/ASSEMBLY/2.0.0 ">
 <id>${activeProfile}</id>
 <!--打包成一個(gè)用于發(fā)布的zip文件-->
 <formats>
 <format>zip</format>
 </formats>
 <!--true：zip中生成一級(jí)目錄(此處屏蔽，配合腳本需要profiles后綴)-->
 <includeBaseDirectory>false</includeBaseDirectory>
 <dependencySets>
 <dependencySet>
 <!--打包進(jìn)zip文件的lib目錄-->
 <useProjectArtifact>false</useProjectArtifact>
 <outputDirectory>${package-name}-${activeProfile}/lib</outputDirectory>
 <unpack>false</unpack>
 </dependencySet>
 </dependencySets>

 <fileSets>
 <!-- 配置文件打包進(jìn)zip文件的conf目錄 -->
 <fileSet>
 <directory>${project.basedir}/src/main/profiles/${activeProfile}</directory>
 <outputDirectory>${package-name}-${activeProfile}/conf</outputDirectory>
 <includes>
 <include>**/*</include>
 <!--<include>*.xml</include>-->
 <!--<include>*.properties</include>-->
 <!--<include>*.yml</include>-->
 </includes>
 </fileSet>

 <!--啟動(dòng)腳本打包進(jìn)zip文件-->
 <fileSet>
 <directory>${project.basedir}/src/main/scripts</directory>
 <outputDirectory></outputDirectory>
 <includes>
 <include>**/*</include>
 </includes>
 <!-- 文件文件權(quán)限為777 -->
 <fileMode>777</fileMode>
 <!-- 目錄權(quán)限為777 -->
 <directoryMode>777</directoryMode>
 <!--腳本中參數(shù)變量為pom中的值 關(guān)鍵-->
 <filtered>true</filtered>
 </fileSet>

 <!-- 項(xiàng)目編譯出來的jar打包進(jìn)zip文件 -->
 <fileSet>
 <directory>${project.build.directory}</directory>
 <outputDirectory>${package-name}-${activeProfile}/</outputDirectory>
 <includes>
 <include>*.jar</include>
 </includes>
 </fileSet>
 </fileSets>
</assembly>

重點(diǎn)節(jié)點(diǎn)介紹：

formats節(jié)點(diǎn)：把配置文件和jar包等壓縮成什么文件格式，這里可以有：zip，tar等
fileMode節(jié)點(diǎn)：指定scripts目錄下腳本文件(這里是：shenniu_publish.sh)在linux上文件權(quán)限為777
filtered節(jié)點(diǎn)：腳本中參數(shù)變量為pom的profiles中properties的值(該配置，是把mvn中屬性值映射生成到sh文件中，如：${package-name})

完成上面配置后，此時(shí)我們可以通過idea上勾選切換不同環(huán)境來打zip包，如圖：

springboot打包不同環(huán)境配置以及shell腳本部署的方法

分享shenniu_publish.sh程序啟動(dòng)工具

上面步驟完成了zip格式的發(fā)布包，我們?cè)俜窒硐聠?dòng)程序的shell腳本，該腳本具有的功能如：

解壓zip+啟動(dòng)jar包啟動(dòng)jar包停止對(duì)應(yīng)jar運(yùn)行重啟jar程序

目前該shell中封裝了兩種啟動(dòng)jar命令的方式：

java -cpjava -jar

如圖命令格式：

springboot打包不同環(huán)境配置以及shell腳本部署的方法

來看全部的shell代碼：

#!/usr/bin/env bash
#可變參數(shù)變量
languageType="javac" #支持 java,javac,netcore 發(fā)布
#參數(shù)值由pom文件傳遞
baseZipName="${package-name}-${activeProfile}" #壓縮包名稱 publish-test.zip的publish
packageName="${package-name}" #命令啟動(dòng)包名 xx.jar的xx
mainclass="${boot-main}" #java -cp啟動(dòng)時(shí)，指定main入口類;命令：java -cp conf;lib\*.jar;${packageName}.jar ${mainclass}

#例子
# baseZipName="publish-test" #壓縮包名稱 publish-test.zip的publish
# packageName="publish" #命令啟動(dòng)包名 publish.jar的xx

#固定變量
basePath=$(cd `dirname $0`/; pwd)
baseZipPath="${basePath}/${baseZipName}.zip" #壓縮包路徑
baseDirPath="${basePath}" #解壓部署磁盤路徑
pid= #進(jìn)程pid

#解壓
function shenniu_unzip()
{
 echo "解壓---------------------------------------------"
 echo "壓縮包路徑：${baseZipPath}"
 if [ ! `find ${baseZipPath}` ]
 then
 echo "不存在壓縮包：${baseZipPath}"
 else
 echo "解壓磁盤路徑：${baseDirPath}/${baseZipName}"
 echo "開始解壓..."

 #解壓命令
 unzip -od ${baseDirPath}/${baseZipName} ${baseZipPath}

 #設(shè)置執(zhí)行權(quán)限
 chmod +x ${baseDirPath}/${baseZipName}/${packageName}

 echo "解壓完成。" 
 fi
}

#檢測(cè)pid
function getPid()
{
 echo "檢測(cè)狀態(tài)---------------------------------------------"
 pid=`ps -ef | grep -n ${packageName} | grep -v grep | awk '{print $2}'`
 if [ ${pid} ] 
 then
 echo "運(yùn)行pid：${pid}"
 else
 echo "未運(yùn)行"
 fi
}

#啟動(dòng)程序
function start()
{
 #啟動(dòng)前，先停止之前的
 stop
 if [ ${pid} ]
 then
 echo "停止程序失敗，無法啟動(dòng)"
 else
 echo "啟動(dòng)程序---------------------------------------------"
 
 #選擇語(yǔ)言類型
 read -p "輸入程序類型(java,javac,netcore)，下一步按回車鍵(默認(rèn)：${languageType})：" read_languageType
 if [ ${read_languageType} ]
 then
 languageType=${read_languageType}
 fi
 echo "選擇程序類型：${languageType}"

 #進(jìn)入運(yùn)行包目錄
 cd ${baseDirPath}/${baseZipName}

 #分類啟動(dòng)
 if [ "${languageType}" == "javac" ] 
 then
 if [ ${mainclass} ] 
 then
 nohup java -cp conf:lib\*.jar:${packageName}.jar ${mainclass} >${baseDirPath}/${packageName}.out 2>&1 &
 #nohup java -cp conf:lib\*.jar:${packageName}.jar ${mainclass} >/dev/null 2>&1 &
 fi
 elif [ "${languageType}" == "java" ] 
 then
 nohup java -jar ${baseDirPath}/${baseZipName}/${packageName}.jar >/dev/null 2>&1 &
 # java -jar ${baseDirPath}/${baseZipName}/${packageName}.jar
 elif [ "${languageType}" == "netcore" ] 
 then
 #nohup dotnet run ${baseDirPath}/${baseZipName}/${packageName} >/dev/null 2>&1 &
 nohup ${baseDirPath}/${baseZipName}/${packageName} >/dev/null 2>&1 &
 fi

 #查詢是否有啟動(dòng)進(jìn)程
 getPid
 if [ ${pid} ]
 then
 echo "已啟動(dòng)"
 #nohup日志
 tail -n 50 -f ${baseDirPath}/${packageName}.out
 else
 echo "啟動(dòng)失敗"
 fi
 fi
}

#停止程序
function stop()
{
 getPid
 if [ ${pid} ] 
 then
 echo "停止程序---------------------------------------------"
 kill -9 ${pid}
 
 getPid
 if [ ${pid} ] 
 then
 #stop
 echo "停止失敗"
 else
 echo "停止成功"
 fi
 fi
}

#啟動(dòng)時(shí)帶參數(shù)，根據(jù)參數(shù)執(zhí)行
if [ ${#} -ge 1 ] 
then
 case ${1} in
 "start") 
 start
 ;;
 "restart") 
 start
 ;;
 "stop") 
 stop
 ;;
 "unzip") 
 #執(zhí)行解壓
 shenniu_unzip
 #執(zhí)行啟動(dòng)
 start
 ;;
 *) 
 echo "${1}無任何操作"
 ;;
 esac
else
 echo "
 command如下命令：
 unzip：解壓并啟動(dòng)
 start：?jiǎn)?dòng)
 stop：停止進(jìn)程
 restart：重啟

 示例命令如：./shenniu_publish start
 "
fi

正如上面小節(jié)說的，shell中的參數(shù) package-name，activeProfile，boot-main 都是由mvn中profiles的properties中提供，是可變的參數(shù)，腳本代碼本身不需要人工去修改，只需要變的是mvn的參數(shù)即可；其實(shí)在我們生成zip包的時(shí)候，shell中的參數(shù)就被替換了，可以看zip中shell文件內(nèi)容如：

springboot打包不同環(huán)境配置以及shell腳本部署的方法

linux上使用shenniu_publish.sh啟動(dòng)程序

把生成的zip上傳到linux上，通過命令解壓：

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

其實(shí)shell腳本中包含有解壓命令，但是我在打包時(shí)放在了zip中，所以只能通過手動(dòng)解壓了，當(dāng)然可以調(diào)整；此時(shí)進(jìn)入加壓目錄如此：

springboot打包不同環(huán)境配置以及shell腳本部署的方法

注：這里第一次執(zhí)行./shenniu_publish.sh腳本時(shí)候，提示了錯(cuò)誤信息；是由于我是在windows上編輯的這個(gè)腳本，其空格等和linux上不一樣，所以運(yùn)行會(huì)有問題，要解決可以使用vim命令在linux把該文件轉(zhuǎn)成linux格式，如下命令：

 vim shenniu_publish.sh
 set ff=unix
 :wq

執(zhí)行完后，再來運(yùn)行腳本./shenniu_publish.sh，此時(shí)有如下提示:

springboot打包不同環(huán)境配置以及shell腳本部署的方法

此刻我們文件是解壓狀態(tài)，因此只需要start命令啟動(dòng)程序即可：

springboot打包不同環(huán)境配置以及shell腳本部署的方法

到這里shenniu_publish.sh腳本使用就完成了，只要腳本沒有提示錯(cuò)誤，基本都能啟動(dòng)jar服務(wù)；其他restart和stop命令也如此執(zhí)行就行：

springboot打包不同環(huán)境配置以及shell腳本部署的方法

可以去研究下shell代碼，希望該腳本能給你帶來效率和好的學(xué)習(xí)思路，下面是測(cè)試用例git地址，腳本在eureka-server項(xiàng)目中：https://github.com/shenniubuxing3/springcloud-Finchley.SR2 （本地下載）

總結(jié)

以上就是這篇文章的全部?jī)?nèi)容了，希望本文的內(nèi)容對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，謝謝大家對(duì)億速云的支持。

向AI問一下細(xì)節(jié)

springboot打包不同環(huán)境配置以及shell腳本部署的方法

猜你喜歡

最新資訊

相關(guān)推薦

相關(guān)標(biāo)簽