Springboot基于assembly的服務(wù)化打包方案及spring boot部署方式
在使用assembly來(lái)打包springboot微服務(wù)項(xiàng)目前,我想說(shuō)一說(shuō),目前springboot項(xiàng)目的幾種常見的部署方式。
使用docker容器去部署,將springboot的應(yīng)用構(gòu)建成一個(gè)docker image,然后通過(guò)容器去啟動(dòng)鏡像 ,這種方式在需要部署大規(guī)模的應(yīng)用和應(yīng)用擴(kuò)展時(shí)是非常方便的,屬于目前工業(yè)級(jí)的部署方案,但是需要掌握docker的生態(tài)圈技術(shù)。
使用fatjar直接部署啟動(dòng),這是很多初學(xué)者或者極小規(guī)模情況下的一個(gè)簡(jiǎn)單應(yīng)用部署方式。
本文主要針對(duì)第二種部署方式提供一種更加友好的打包方案,是部署管理更加輕松,第一種方式可能未來(lái)我會(huì)在自己博客中寫。
一、為什么要將springboot服務(wù)化打包 ?
最近我看到一個(gè)項(xiàng)目團(tuán)隊(duì),他們?cè)诓捎胹pringboot開發(fā)完項(xiàng)目構(gòu)建交互給運(yùn)維團(tuán)隊(duì)就是一個(gè)spring boot 的fatjar。而且這種原始打出的包在傳統(tǒng)型項(xiàng)目開發(fā)公司,對(duì)于運(yùn)維人員來(lái)說(shuō)無(wú)疑是很致命的,項(xiàng)目交付后整個(gè)配置文件都被隱藏到打成的jar中,針對(duì)不同的環(huán)境修改配置文件就變成了一件很困難的事情。因此,我們?cè)诠疽肴魏涡录夹g(shù)時(shí),一定要考慮怎么去做服務(wù)化和工程化,如果僅僅引用技術(shù)框架,很多時(shí)候可能只需要加入幾個(gè)依賴,看下api寫幾行代碼就能跑起來(lái)。
針對(duì)上面的這種問(wèn)題,要去做服務(wù)化和工程化,大致要解決兩點(diǎn)問(wèn)題:
讓springboot能夠加載jar外的配置文件。
提供一個(gè)服務(wù)化的啟動(dòng)腳本,這個(gè)腳本一般是shell或者windows下的bat ,有了springboot的應(yīng)用服務(wù)腳本后,就可以容器的去啟動(dòng)和停止springboot的應(yīng)用了。
二、打包后的springboot應(yīng)用結(jié)構(gòu)圖
這里先來(lái)看下使用assembly將springboot服務(wù)化打包后的效果圖。
三、服務(wù)化打包重要步驟
下面是打包springboot的詳細(xì)步驟。
3.1 加入assembly打包插件
<plugin> <artifactId>maven-assembly-plugin</artifactId> <version>3.0.0</version> <configuration> <descriptors> <descriptor>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>
從上面代碼看出了我把a(bǔ)ssembly的配置放在main目錄下,這個(gè)是習(xí)慣,可以不放這里也可以,下面就是一個(gè)assembly在項(xiàng)目中的大致結(jié)構(gòu)圖:
3.2 assembly.xml配置
assembly的配置不同的應(yīng)用和下面配置也差不多,無(wú)非就是打包服務(wù)腳本、jar、配置文件等。從下面的代碼中config配置就會(huì)發(fā)現(xiàn), assembly將配置文件打到了config下。
<assembly> <id>1.0</id> <formats> <format>tar.gz</format> </formats> <fileSets> <fileSet> <directory>src/main/assembly/bin</directory> <outputDirectory>bin</outputDirectory> <fileMode>0755</fileMode> </fileSet> <fileSet> <directory>src/main/assembly/config</directory> <outputDirectory>config</outputDirectory> <fileMode>0644</fileMode> </fileSet> <fileSet> <directory>target</directory> <outputDirectory>lib</outputDirectory> <includes> <include>*.jar</include> </includes> </fileSet> <fileSet> <directory>src/main/resources</directory> <outputDirectory>logs</outputDirectory> <fileMode>0755</fileMode> <excludes> <exclude>**/*</exclude> </excludes> </fileSet> </fileSets> </assembly>
3.3 編寫服務(wù)腳本
現(xiàn)在寫linux環(huán)境的腳本。
第一個(gè):start.sh啟動(dòng)腳本
#!/bin/bash SERVER_NAME='spring-vue' # jar名稱 JAR_NAME='springboot-vue.jar' cd `dirname $0` BIN_DIR=`pwd` cd .. DEPLOY_DIR=`pwd` CONF_DIR=$DEPLOY_DIR/config # SERVER_PORT=`sed '/server.port/!d;s/.*=//' config/application.properties | tr -d '\r'` # 獲取應(yīng)用的端口號(hào) SERVER_PORT=`sed -nr '/port: [0-9]+/ s/.*port: +([0-9]+).*/\1/p' config/application.yml` PIDS=`ps -f | grep java | grep "$CONF_DIR" |awk '{print $2}'` if [ "$1" = "status" ]; then if [ -n "$PIDS" ]; then echo "The $SERVER_NAME is running...!" echo "PID: $PIDS" exit 0 else echo "The $SERVER_NAME is stopped" exit 0 fi fi if [ -n "$PIDS" ]; then echo "ERROR: The $SERVER_NAME already started!" echo "PID: $PIDS" exit 1 fi if [ -n "$SERVER_PORT" ]; then SERVER_PORT_COUNT=`netstat -tln | grep $SERVER_PORT | wc -l` if [ $SERVER_PORT_COUNT -gt 0 ]; then echo "ERROR: The $SERVER_NAME port $SERVER_PORT already used!" exit 1 fi fi LOGS_DIR=$DEPLOY_DIR/logs if [ ! -d $LOGS_DIR ]; then mkdir $LOGS_DIR fi STDOUT_FILE=$LOGS_DIR/stdout.log JAVA_OPTS=" -Djava.awt.headless=true -Djava.net.preferIPv4Stack=true " JAVA_DEBUG_OPTS="" if [ "$1" = "debug" ]; then JAVA_DEBUG_OPTS=" -Xdebug -Xnoagent -Djava.compiler=NONE -Xrunjdwp:transport=dt_socket,address=8000,server=y,suspend=n " fi JAVA_JMX_OPTS="" if [ "$1" = "jmx" ]; then JAVA_JMX_OPTS=" -Dcom.sun.management.jmxremote.port=1099 -Dcom.sun.management.jmxremote.ssl=false -Dcom.sun.management.jmxremote.authenticate=false " fi JAVA_MEM_OPTS="" BITS=`java -version 2>&1 | grep -i 64-bit` if [ -n "$BITS" ]; then JAVA_MEM_OPTS=" -server -Xmx512m -Xms512m -Xmn256m -XX:PermSize=128m -Xss256k -XX:+DisableExplicitGC -XX:+UseConcMarkSweepGC -XX:+CMSParallelRemarkEnabled -XX:+UseCMSCompactAtFullCollection -XX:LargePageSizeInBytes=128m -XX:+UseFastAccessorMethods -XX:+UseCMSInitiatingOccupancyOnly -XX:CMSInitiatingOccupancyFraction=70 " else JAVA_MEM_OPTS=" -server -Xms512m -Xmx512m -XX:PermSize=128m -XX:SurvivorRatio=2 -XX:+UseParallelGC " fi CONFIG_FILES=" -Dlogging.path=$LOGS_DIR -Dlogging.config=$CONF_DIR/log4j2.xml -Dspring.config.location=$CONF_DIR/application.properties " echo -e "Starting the $SERVER_NAME ..." nohup java $JAVA_OPTS $JAVA_MEM_OPTS $JAVA_DEBUG_OPTS $JAVA_JMX_OPTS $CONFIG_FILES -jar $DEPLOY_DIR/lib/$JAR_NAME > $STDOUT_FILE 2>&1 & COUNT=0 while [ $COUNT -lt 1 ]; do echo -e ".\c" sleep 1 if [ -n "$SERVER_PORT" ]; then COUNT=`netstat -an | grep $SERVER_PORT | wc -l` else COUNT=`ps -f | grep java | grep "$DEPLOY_DIR" | awk '{print $2}' | wc -l` fi if [ $COUNT -gt 0 ]; then break fi done echo "OK!" PIDS=`ps -f | grep java | grep "$DEPLOY_DIR" | awk '{print $2}'` echo "PID: $PIDS" echo "STDOUT: $STDOUT_FILE" 腳本用例: # 啟動(dòng)應(yīng)用 ./start.sh # 以debug方式啟動(dòng) ./start debug # 啟動(dòng)任務(wù)并開啟jmx監(jiān)控 ./start jmx # 獲取當(dāng)前的運(yùn)行狀態(tài) ./start status 停止腳本:stop.sh #!/bin/bash cd `dirname $0` BIN_DIR=`pwd` cd .. DEPLOY_DIR=`pwd` CONF_DIR=$DEPLOY_DIR/config SERVER_NAME=$DEPLOY_DIR PIDS=`ps -ef | grep java | grep "$CONF_DIR" |awk '{print $2}'` if [ -z "$PIDS" ]; then echo "ERROR: The $SERVER_NAME does not started!" exit 1 fi if [ "$1" != "skip" ]; then $BIN_DIR/dump.sh fi echo -e "Stopping the $SERVER_NAME ...\c" for PID in $PIDS ; do kill $PID > /dev/null 2>&1 done COUNT=0 while [ $COUNT -lt 1 ]; do echo -e ".\c" sleep 1 COUNT=1 for PID in $PIDS ; do PID_EXIST=`ps -f -p $PID | grep java` if [ -n "$PID_EXIST" ]; then COUNT=0 break fi done done echo "OK!" echo "PID: $PIDS"
windows環(huán)境的啟動(dòng)腳本:
echo off set APP_NAME=springboot-vue.jar set CONFIG= -Dlogging.path=../logs -Dlogging.config=../config/log4j2.xml -Dspring.config.location=../config/application.yml set DEBUG_OPTS= if ""%1"" == ""debug"" ( set DEBUG_OPTS= -Xloggc:../logs/gc.log -verbose:gc -XX:+PrintGCDetails -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=../logs goto debug ) set JMX_OPTS= if ""%1"" == ""jmx"" ( set JMX_OPTS= -Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.port=9888 -Dcom.sun.management.jmxremote.ssl=FALSE -Dcom.sun.management.jmxremote.authenticate=FALSE goto jmx ) echo "Starting the %APP_NAME%" java -Xms512m -Xmx512m -server %DEBUG_OPTS% %JMX_OPTS% %CONFIG% -jar ../lib/%APP_NAME% goto end :debug echo "debug" java -Xms512m -Xmx512m -server %DEBUG_OPTS% %CONFIG% -jar ../lib/%APP_NAME% goto end :jmx java -Xms512m -Xmx512m -server %JMX_OPTS% %CONFIG% -jar ../lib/%APP_NAME% goto end :end pause
對(duì)于不同的springboot項(xiàng)目,只需要適當(dāng)修改一下腳本就可以了,為了節(jié)約篇幅這里就不列出其他的腳本了,可以參考我提交的demo:https://github.com/Shalousun/springboot-vue.git
注意:以上腳本參考自dubbo官方。其實(shí)對(duì)于dubbo項(xiàng)目的輕量化構(gòu)建也是類似的。
四、打包后應(yīng)用的日志路徑處理
在第二節(jié)的圖中可以看到打包的應(yīng)用日志一般統(tǒng)一輸出到logs目錄中,但是對(duì)于不同的系統(tǒng)平臺(tái),雖然配置的日志輸出路徑是一樣的,但是最后不一定輸出到logs中。經(jīng)過(guò)測(cè)試在windows平臺(tái)中使用相對(duì)的日志路徑../logs是沒(méi)有問(wèn)題的,但是對(duì)于linux系統(tǒng)下使用相對(duì)路徑就不能輸出到logs下,因此建議在linux平臺(tái)下就寫絕對(duì)路徑吧。不過(guò)在我提供的腳本中設(shè)置輸出日志的路徑
-Dlogging.path=../logs
因此結(jié)合log4j2的強(qiáng)大解析能力完全可以設(shè)置log42的日志路徑:
<property name="LOG_HOME">${sys:logging.path}</property>
但是對(duì)于springboot應(yīng)用的訪問(wèn)日志在linux下似乎只能使用絕對(duì)路徑了。
# server config server: port: 8080 undertow: accesslog: enabled: true dir: /usr/xxx/logs logging: path: /usr/xxx/logs
當(dāng)然后面有使用配置解決的同學(xué)可以提醒糾正下。
總結(jié):
這個(gè)方案本身并沒(méi)有帶來(lái)什么新東西,甚至腳本大多數(shù)是參考了dubbo官方的腳本,只是在上面做了些完善。但是重要的一點(diǎn)是怎么去根據(jù)實(shí)際的技術(shù)應(yīng)用場(chǎng)景,思考使用這項(xiàng)技術(shù)需要做的服務(wù)化和工程化。
以上所述是小編給大家介紹的Springboot基于assembly的服務(wù)化打包方案,希望對(duì)大家有所幫助,如果大家有任何疑問(wèn)請(qǐng)給我留言,小編會(huì)及時(shí)回復(fù)大家的。在此也非常感謝大家對(duì)腳本之家網(wǎng)站的支持!
相關(guān)文章
在Linux系統(tǒng)上升級(jí)Java版本的兩種方法步驟
由于項(xiàng)目升級(jí),需要將JDK7升級(jí)到JDK8,升級(jí)JDK的同時(shí)也要升級(jí)一些其他的版本,下面這篇文章主要給大家介紹了關(guān)于在Linux系統(tǒng)上升級(jí)Java版本的兩種方法步驟,需要的朋友可以參考下2024-09-09Java后臺(tái)開發(fā)之表單提交之前驗(yàn)證
這篇文章主要介紹了Java后臺(tái)開發(fā)之表單提交之前驗(yàn)證的實(shí)現(xiàn)代碼,非常不錯(cuò)具有參考借鑒價(jià)值,需要的朋友參考下吧2017-02-02java如何拷貝復(fù)制對(duì)象和集合問(wèn)題
這篇文章主要介紹了java如何拷貝復(fù)制對(duì)象和集合問(wèn)題,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2023-09-09Java 數(shù)據(jù)結(jié)構(gòu)算法Collection接口迭代器示例詳解
這篇文章主要為大家介紹了Java 數(shù)據(jù)結(jié)構(gòu)算法Collection接口迭代器示例詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2022-09-09WebFlux 服務(wù)編排使用優(yōu)勢(shì)詳解
這篇文章主要為大家介紹了WebFlux 服務(wù)編排使用優(yōu)勢(shì)示例詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-05-05java?jar包后臺(tái)運(yùn)行的兩種方式詳解
后臺(tái)運(yùn)行jar的方法有多種方法可以實(shí)現(xiàn)Java后臺(tái)運(yùn)行jar文件,下面介紹其中兩種常見的方法,下面這篇文章主要給大家介紹了關(guān)于java?jar包后臺(tái)運(yùn)行的兩種方式,文中通過(guò)代碼介紹的非常詳細(xì),需要的朋友可以參考下2024-07-07最全LocalDateTime、LocalDate、Date、String相互轉(zhuǎn)化的方法
大家在開發(fā)過(guò)程中必不可少的和日期打交道,對(duì)接別的系統(tǒng)時(shí),時(shí)間日期格式不一致,每次都要轉(zhuǎn)化,本文為大家準(zhǔn)備了最全的LocalDateTime、LocalDate、Date、String相互轉(zhuǎn)化方法,需要的可以參考一下2023-06-06Java深入講解AWT實(shí)現(xiàn)事件處理流程
AWT的事件處理是一種委派式事件處理方式:普通組件(事件源)將整個(gè)事件處理委托給特定的對(duì)象(事件監(jiān)聽器);當(dāng)該事件源發(fā)生指定的事件時(shí),就通知所委托的事件監(jiān)聽器,由事件監(jiān)聽器來(lái)處理這個(gè)事件2022-04-04解決idea打包成功但是resource下的文件沒(méi)有成功的問(wèn)題
這篇文章主要介紹了解決idea打包成功但是resource下的文件沒(méi)有成功的問(wèn)題,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧2020-08-08