在使用assembly來打包springboot微服務項目前,我想說一說,目前springboot項目的幾種常見的部署方式。
使用docker容器去部署,將springboot的應用構建成一個docker image,然後通過容器去啟動鏡像,這種方式在需要部署大規模的應用和應用擴展時是非常方便的,屬於目前工業級的部署方案,但是需要掌握docker的生態圈技術。
使用fatjar直接部署啟動,這是很多初學者或者極小規模情況下的一個簡單應用部署方式。
本文主要針對第二種部署方式提供一種更加友好的打包方案,是部署管理更加輕鬆,第一種方式可能未來我會在自己博客中寫。
一、為什麼要將springboot服務化打包?
最近我看到一個項目團隊,他們在採用springboot開發完項目構建交互給運維團隊就是一個spring boot 的fatjar。而且這種原始打出的包在傳統型項目開發公司,對於運維人員來說無疑是很致命的,項目交付後整個配置文件都被隱藏到打成的jar中,針對不同的環境修改配置文件就變成了一件很困難的事情。因此,我們在公司引入任何新技術時,一定要考慮怎麼去做服務化和工程化,如果僅僅引用技術框架,很多時候可能只需要加入幾個依賴,看下api寫幾行代碼就能跑起來。
針對上面的這種問題,要去做服務化和工程化,大致要解決兩點問題:
讓springboot能夠加載jar外的配置文件。
提供一個服務化的啟動腳本,這個腳本一般是shell或者windows下的bat ,有了springboot的應用服務腳本後,就可以容器的去啟動和停止springboot的應用了。
二、打包後的springboot應用結構圖
這裡先來看下使用assembly將springboot服務化打包後的效果圖。
三、服務化打包重要步驟
下面是打包springboot的詳細步驟。
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>
從上面代碼看出了我把assembly的配置放在main目錄下,這個是習慣,可以不放這裡也可以,下面就是一個assembly在項目中的大致結構圖:
3.2 assembly.xml配置
assembly的配置不同的應用和下面配置也差不多,無非就是打包服務腳本、jar、配置文件等。從下面的代碼中config配置就會發現, 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 編寫服務腳本
現在寫linux環境的腳本。
第一個:start.sh啟動腳本
#!/bin/bashSERVER_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'`# 獲取應用的端口號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 fifiif [ -n "$PIDS" ]; then echo "ERROR: The $SERVER_NAME already started!" echo "PID: $PIDS" exit 1fiif [ -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 fifiLOGS_DIR=$DEPLOY_DIR/logsif [ ! -d $LOGS_DIR ]; then mkdir $LOGS_DIRfiSTDOUT_FILE=$LOGS_DIR/stdout.logJAVA_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 "fiJAVA_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 "fiJAVA_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 "fiCONFIG_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=0while [ $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 fidoneecho "OK!"PIDS=`ps -f | grep java | grep "$DEPLOY_DIR" | awk '{print $2}'`echo "PID: $PIDS"echo "STDOUT: $STDOUT_FILE" 腳本用例:# 啟動應用./start.sh# 以debug方式啟動./start debug# 啟動任務並開啟jmx監控./start jmx# 獲取當前的運行狀態./start status停止腳本:stop.sh#!/bin/bashcd `dirname $0`BIN_DIR=`pwd`cd ..DEPLOY_DIR=`pwd`CONF_DIR=$DEPLOY_DIR/configSERVER_NAME=$DEPLOY_DIRPIDS=`ps -ef | grep java | grep "$CONF_DIR" |awk '{print $2}'`if [ -z "$PIDS" ]; then echo "ERROR: The $SERVER_NAME does not started!" exit 1fiif [ "$1" != "skip" ]; then $BIN_DIR/dump.shfiecho -e "Stopping the $SERVER_NAME .../c"for PID in $PIDS ; do kill $PID > /dev/null 2>&1doneCOUNT=0while [ $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 donedoneecho "OK!"echo "PID: $PIDS"windows環境的啟動腳本:
echo offset APP_NAME=springboot-vue.jarset 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:debugecho "debug"java -Xms512m -Xmx512m -server %DEBUG_OPTS% %CONFIG% -jar ../lib/%APP_NAME%goto end:jmxjava -Xms512m -Xmx512m -server %JMX_OPTS% %CONFIG% -jar ../lib/%APP_NAME%goto end:endpause
對於不同的springboot項目,只需要適當修改一下腳本就可以了,為了節約篇幅這裡就不列出其他的腳本了,可以參考我提交的demo:https://github.com/Shalousun/springboot-vue.git
注意:以上腳本參考自dubbo官方。其實對於dubbo項目的輕量化構建也是類似的。
四、打包後應用的日誌路徑處理
在第二節的圖中可以看到打包的應用日誌一般統一輸出到logs目錄中,但是對於不同的系統平台,雖然配置的日誌輸出路徑是一樣的,但是最後不一定輸出到logs中。經過測試在windows平台中使用相對的日誌路徑../logs是沒有問題的,但是對於linux系統下使用相對路徑就不能輸出到logs下,因此建議在linux平台下就寫絕對路徑吧。不過在我提供的腳本中設置輸出日誌的路徑
-Dlogging.path=../logs
因此結合log4j2的強大解析能力完全可以設置log42的日誌路徑:
<property name="LOG_HOME">${sys:logging.path}</property>但是對於springboot應用的訪問日誌在linux下似乎只能使用絕對路徑了。
# server configserver: port: 8080 undertow: accesslog: enabled: true dir: /usr/xxx/logslogging: path: /usr/xxx/logs
當然後面有使用配置解決的同學可以提醒糾正下。
總結:
這個方案本身並沒有帶來什麼新東西,甚至腳本大多數是參考了dubbo官方的腳本,只是在上面做了些完善。但是重要的一點是怎麼去根據實際的技術應用場景,思考使用這項技術需要做的服務化和工程化。
以上所述是小編給大家介紹的Springboot基於assembly的服務化打包方案,希望對大家有所幫助,如果大家有任何疑問請給我留言,小編會及時回復大家的。在此也非常感謝大家對武林網網站的支持!