springboot打包不同環境配置與shell腳本部署

本篇和大家分享的是springboot打包並結合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 node
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 node1
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 node2
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:用來指定不同環境配置文件所在的目錄,如下我這裡:
springboot打包不同環境配置與shell腳本部署


  • properties:該節點中的節點是可作為參數傳遞給其他配置文件,如我這裡的package-name節點值就可以在另外的assembly.xml或者shell腳本文件中通過${package-name}獲取到,如下:
springboot打包不同環境配置與shell腳本部署


  • 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
make-a-jar
25 <phase>compile/<phase>
26 <goals>
27 <goal>jar/<goal>
28 /<goals>
29 /<execution>
30 /<executions>
31 /<plugin>
32
33 <plugin>
34 <groupid>org.apache.maven.plugins/<groupid>
35 <artifactid>maven-assembly-plugin/<artifactid>
36 <version>2.4/<version>
37
38 <configuration>
39
40 <descriptors>
41 <descriptor>${project.basedir}/src/main/assembly/assembly.xml/<descriptor>
42 /<descriptors>
43 /<configuration>
44 <executions>
45 <execution>
46 make-assembly
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腳本發佈程序的配置:

 1 <assembly> 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 ${activeProfile}
5
6 <formats>
7 <format>zip/<format>
8 /<formats>
9
10 <includebasedirectory>false/<includebasedirectory>
11 <dependencysets>
12 <dependencyset>
13
14 <useprojectartifact>false/<useprojectartifact>
15 <outputdirectory>${package-name}-${activeProfile}/lib/<outputdirectory>
16 <unpack>false/<unpack>
17 /<dependencyset>
18 /<dependencysets>
19
20 <filesets>
21
22 <fileset>
23 <directory>${project.basedir}/src/main/profiles/${activeProfile}/<directory>
24 <outputdirectory>${package-name}-${activeProfile}/conf/<outputdirectory>
25 <includes>
26 <include>**/*/<include>
27
28

29
30 /<includes>
31 /<fileset>
32
33
34 <fileset>
35 <directory>${project.basedir}/src/main/scripts/<directory>
36 <outputdirectory>
37 <includes>
38 <include>**/*/<include>
39 /<includes>
40
41 <filemode>777/<filemode>
42
43 <directorymode>777/<directorymode>
44
45 <filtered>true/<filtered>
46 /<fileset>
47
48
49 <fileset>
50 <directory>${project.build.directory}/<directory>
51 <outputdirectory>${package-name}-${activeProfile}//<outputdirectory>
52 <includes>
53 <include>*.jar/<include>
54 /<includes>
55 /<fileset>
56 /<filesets>
57 /<assembly>

重點節點介紹:

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

完成上面配置後,此時我們可以通過idea上勾選切換不同環境來打zip包,如圖:

springboot打包不同環境配置與shell腳本部署

分享shenniu_publish.sh程序啟動工具

上面步驟完成了zip格式的發佈包,我們再分享下啟動程序的shell腳本,該腳本具有的功能如:

  • 解壓zip+啟動jar包
  • 啟動jar包
  • 停止對應jar運行
  • 重啟jar程序

目前該shell中封裝了兩種啟動jar命令的方式:

  • java -cp
  • java -jar

如圖命令格式:

springboot打包不同環境配置與shell腳本部署

來看全部的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 #例子
10 # baseZipName="publish-test" #壓縮包名稱 publish-test.zip的publish
11 # packageName="publish" #命令啟動包名 publish.jar的xx
12
13 #固定變量
14 basePath=$(cd `dirname $0`/; pwd)
15 baseZipPath="${basePath}/${baseZipName}.zip" #壓縮包路徑
16 baseDirPath="${basePath}" #解壓部署磁盤路徑
17 pid= #進程pid
18
19 #解壓
20 function shenniu_unzip()
21 {
22 echo "解壓---------------------------------------------"
23 echo "壓縮包路徑:${baseZipPath}"
24 if [ ! `find ${baseZipPath}` ]
25 then
26 echo "不存在壓縮包:${baseZipPath}"
27 else
28 echo "解壓磁盤路徑:${baseDirPath}/${baseZipName}"
29 echo "開始解壓..."
30
31 #解壓命令
32 unzip -od ${baseDirPath}/${baseZipName} ${baseZipPath}
33
34 #設置執行權限

35 chmod +x ${baseDirPath}/${baseZipName}/${packageName}
36
37 echo "解壓完成。"
38 fi
39 }
40
41 #檢測pid
42 function getPid()
43 {
44 echo "檢測狀態---------------------------------------------"
45 pid=`ps -ef | grep -n ${packageName} | grep -v grep | awk '{print $2}'`
46 if [ ${pid} ]
47 then
48 echo "運行pid:${pid}"
49 else
50 echo "未運行"
51 fi
52 }
53
54 #啟動程序
55 function start()
56 {
57 #啟動前,先停止之前的
58 stop
59 if [ ${pid} ]
60 then
61 echo "停止程序失敗,無法啟動"
62 else
63 echo "啟動程序---------------------------------------------"
64
65 #選擇語言類型
66 read -p "輸入程序類型(java,javac,netcore),下一步按回車鍵(默認:${languageType}):" read_languageType
67 if [ ${read_languageType} ]
68 then
69 languageType=${read_languageType}
70 fi
71 echo "選擇程序類型:${languageType}"
72
73 #進入運行包目錄
74 cd ${baseDirPath}/${baseZipName}
75
76 #分類啟動

77 if [ "${languageType}" == "javac" ]
78 then
79 if [ ${mainclass} ]
80 then
81 nohup java -cp conf:lib\*.jar:${packageName}.jar ${mainclass} >${baseDirPath}/${packageName}.out 2>&1 &
82 #nohup java -cp conf:lib\*.jar:${packageName}.jar ${mainclass} >/dev/null 2>&1 &
83 fi
84 elif [ "${languageType}" == "java" ]
85 then
86 nohup java -jar ${baseDirPath}/${baseZipName}/${packageName}.jar >/dev/null 2>&1 &
87 # java -jar ${baseDirPath}/${baseZipName}/${packageName}.jar
88 elif [ "${languageType}" == "netcore" ]
89 then
90 #nohup dotnet run ${baseDirPath}/${baseZipName}/${packageName} >/dev/null 2>&1 &
91 nohup ${baseDirPath}/${baseZipName}/${packageName} >/dev/null 2>&1 &
92 fi
93
94 #查詢是否有啟動進程
95 getPid
96 if [ ${pid} ]
97 then
98 echo "已啟動"
99 #nohup日誌
100 tail -n 50 -f ${baseDirPath}/${packageName}.out
101 else
102 echo "啟動失敗"
103 fi
104 fi
105 }
106
107 #停止程序
108 function stop()
109 {
110 getPid
111 if [ ${pid} ]
112 then
113 echo "停止程序---------------------------------------------"
114 kill -9 ${pid}
115
116 getPid
117 if [ ${pid} ]
118 then
119 #stop
120 echo "停止失敗"
121 else
122 echo "停止成功"
123 fi

124 fi
125 }
126
127 #啟動時帶參數,根據參數執行
128 if [ ${#} -ge 1 ]
129 then
130 case ${1} in
131 "start")
132 start
133 ;;
134 "restart")
135 start
136 ;;
137 "stop")
138 stop
139 ;;
140 "unzip")
141 #執行解壓
142 shenniu_unzip
143 #執行啟動
144 start
145 ;;
146 *)
147 echo "${1}無任何操作"
148 ;;
149 esac
150 else
151 echo "
152 command如下命令:
153 unzip:解壓並啟動
154 start:啟動
155 stop:停止進程
156 restart:重啟
157
158 示例命令如:./shenniu_publish start
159 "
160 fi

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

springboot打包不同環境配置與shell腳本部署

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腳本部署

注:這裡第一次執行./shenniu_publish.sh腳本時候,提示了錯誤信息;是由於我是在windows上編輯的這個腳本,其空格等和linux上不一樣,所以運行會有問題,要解決可以使用vim命令在linux把該文件轉成linux格式,如下命令:

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

執行完後,再來運行腳本./shenniu_publish.sh,此時有如下提示:

springboot打包不同環境配置與shell腳本部署

此刻我們文件是解壓狀態,因此只需要start命令啟動程序即可:

springboot打包不同環境配置與shell腳本部署

到這裡shenniu_publish.sh腳本使用就完成了,只要腳本沒有提示錯誤,基本都能啟動jar服務;其他restart和stop命令也如此執行就行:

springboot打包不同環境配置與shell腳本部署

歡迎工作一到五年的Java工程師朋友們加入Java程序員開發: 854393687

群內提供免費的Java架構學習資料(裡面有高可用、高併發、高性能及分佈式、Jvm性能調優、Spring源碼,MyBatis,Netty,Redis,Kafka,Mysql,Zookeeper,Tomcat,Docker,Dubbo,Nginx等多個知識點的架構資料)合理利用自己每一分每一秒的時間來學習提升自己,不要再用"沒有時間“來掩飾自己思想上的懶惰!趁年輕,使勁拼,給未來的自己一個交代!


分享到:


相關文章: