在使用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打包插件

1<plugin>
2	<artifactId>maven-assembly-plugin</artifactId>
3	<version>3.0.0</version>
4	<configuration>
5	    <descriptors>
6		<descriptor>src/main/assembly/assembly.xml</descriptor>
7	    </descriptors>
8	</configuration>
9	<executions>
10	    <execution>
11		<id>make-assembly</id>
12		<phase>package</phase>
13		<goals>
14		    <goal>single</goal>
15		</goals>
16	    </execution>
17	</executions>
18</plugin>

从上面代码看出了我把assembly的配置放在main目录下，这个是习惯，可以不放这里也可以，下面就是一个assembly在项目中的大致结构图：

3.2 assembly.xml配置

assembly的配置不同的应用和下面配置也差不多，无非就是打包服务脚本、jar、配置文件等。从下面的代码中config配置就会发现， assembly将配置文件打到了config下。

1<assembly>
2    <id>1.0</id>
3    <formats>
4        <format>tar.gz</format>
5    </formats>
6    <fileSets>
7        <fileSet>
8            <directory>src/main/assembly/bin</directory>
9            <outputDirectory>bin</outputDirectory>
10            <fileMode>0755</fileMode>
11        </fileSet>
12        <fileSet>
13            <directory>src/main/assembly/config</directory>
14            <outputDirectory>config</outputDirectory>
15            <fileMode>0644</fileMode>
16        </fileSet>
17        <fileSet>
18            <directory>target</directory>
19            <outputDirectory>lib</outputDirectory>
20            <includes>
21                <include>*.jar</include>
22            </includes>
23        </fileSet>
24        <fileSet>
25            <directory>src/main/resources</directory>
26            <outputDirectory>logs</outputDirectory>
27            <fileMode>0755</fileMode>
28            <excludes>
29                <exclude>**/*</exclude>
30            </excludes>
31        </fileSet>
32    </fileSets>
33</assembly>

3.3 编写服务脚本

现在写linux环境的脚本。

第一个：start.sh启动脚本

1#!/bin/bash
2
3SERVER_NAME='spring-vue'
4# jar名称
5JAR_NAME='springboot-vue.jar'
6cd `dirname $0`
7BIN_DIR=`pwd`
8cd ..
9DEPLOY_DIR=`pwd`
10CONF_DIR=$DEPLOY_DIR/config
11# SERVER_PORT=`sed '/server.port/!d;s/.*=//' config/application.properties | tr -d '\r'`
12# 获取应用的端口号
13SERVER_PORT=`sed -nr '/port: [0-9]+/ s/.*port: +([0-9]+).*/\1/p' config/application.yml`
14
15PIDS=`ps -f | grep java | grep "$CONF_DIR" |awk '{print $2}'`
16if [ "$1" = "status" ]; then	  
17    if [ -n "$PIDS" ]; then
18        echo "The $SERVER_NAME is running...!"
19        echo "PID: $PIDS"
20        exit 0
21    else
22        echo "The $SERVER_NAME is stopped"
23        exit 0
24    fi
25fi
26
27if [ -n "$PIDS" ]; then
28    echo "ERROR: The $SERVER_NAME already started!"
29    echo "PID: $PIDS"
30    exit 1
31fi
32
33if [ -n "$SERVER_PORT" ]; then
34    SERVER_PORT_COUNT=`netstat -tln | grep $SERVER_PORT | wc -l`
35    if [ $SERVER_PORT_COUNT -gt 0 ]; then
36        echo "ERROR: The $SERVER_NAME port $SERVER_PORT already used!"
37        exit 1
38    fi
39fi
40
41LOGS_DIR=$DEPLOY_DIR/logs
42if [ ! -d $LOGS_DIR ]; then
43    mkdir $LOGS_DIR
44fi
45STDOUT_FILE=$LOGS_DIR/stdout.log
46
47JAVA_OPTS=" -Djava.awt.headless=true -Djava.net.preferIPv4Stack=true "
48JAVA_DEBUG_OPTS=""
49if [ "$1" = "debug" ]; then
50    JAVA_DEBUG_OPTS=" -Xdebug -Xnoagent -Djava.compiler=NONE -Xrunjdwp:transport=dt_socket,address=8000,server=y,suspend=n "
51fi
52
53JAVA_JMX_OPTS=""
54if [ "$1" = "jmx" ]; then
55    JAVA_JMX_OPTS=" -Dcom.sun.management.jmxremote.port=1099 -Dcom.sun.management.jmxremote.ssl=false -Dcom.sun.management.jmxremote.authenticate=false "
56fi
57
58JAVA_MEM_OPTS=""
59BITS=`java -version 2>&1 | grep -i 64-bit`
60if [ -n "$BITS" ]; then
61    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 "
62else
63    JAVA_MEM_OPTS=" -server -Xms512m -Xmx512m -XX:PermSize=128m -XX:SurvivorRatio=2 -XX:+UseParallelGC "
64fi
65
66CONFIG_FILES=" -Dlogging.path=$LOGS_DIR -Dlogging.config=$CONF_DIR/log4j2.xml -Dspring.config.location=$CONF_DIR/application.properties "
67echo -e "Starting the $SERVER_NAME ..."
68nohup java $JAVA_OPTS $JAVA_MEM_OPTS $JAVA_DEBUG_OPTS $JAVA_JMX_OPTS $CONFIG_FILES -jar $DEPLOY_DIR/lib/$JAR_NAME > $STDOUT_FILE 2>&1 &
69
70COUNT=0
71while [ $COUNT -lt 1 ]; do
72    echo -e ".\c"
73    sleep 1
74    if [ -n "$SERVER_PORT" ]; then
75        COUNT=`netstat -an | grep $SERVER_PORT | wc -l`
76    else
77    	COUNT=`ps -f | grep java | grep "$DEPLOY_DIR" | awk '{print $2}' | wc -l`
78    fi
79    if [ $COUNT -gt 0 ]; then
80        break
81    fi
82done
83
84
85echo "OK!"
86PIDS=`ps -f | grep java | grep "$DEPLOY_DIR" | awk '{print $2}'`
87echo "PID: $PIDS"
88echo "STDOUT: $STDOUT_FILE"

脚本用例：

1# 启动应用
2
3./start.sh
4
5# 以debug方式启动
6./start debug
7
8# 启动任务并开启jmx监控
9
10./start jmx
11# 获取当前的运行状态
12./start status

停止脚本：stop.sh

1#!/bin/bash
2cd `dirname $0`
3BIN_DIR=`pwd`
4cd ..
5DEPLOY_DIR=`pwd`
6CONF_DIR=$DEPLOY_DIR/config
7
8SERVER_NAME=$DEPLOY_DIR
9
10PIDS=`ps -ef | grep java | grep "$CONF_DIR" |awk '{print $2}'`
11if [ -z "$PIDS" ]; then
12    echo "ERROR: The $SERVER_NAME does not started!"
13    exit 1
14fi
15
16if [ "$1" != "skip" ]; then
17    $BIN_DIR/dump.sh
18fi
19
20echo -e "Stopping the $SERVER_NAME ...\c"
21for PID in $PIDS ; do
22    kill $PID > /dev/null 2>&1
23done
24
25COUNT=0
26while [ $COUNT -lt 1 ]; do
27    echo -e ".\c"
28    sleep 1
29    COUNT=1
30    for PID in $PIDS ; do
31        PID_EXIST=`ps -f -p $PID | grep java`
32        if [ -n "$PID_EXIST" ]; then
33            COUNT=0
34            break
35        fi
36    done
37done
38
39echo "OK!"
40echo "PID: $PIDS"

windows环境的启动脚本：

1echo off
2
3set APP_NAME=springboot-vue.jar
4set CONFIG= -Dlogging.path=../logs -Dlogging.config=../config/log4j2.xml -Dspring.config.location=../config/application.yml 
5
6set DEBUG_OPTS=
7if ""%1"" == ""debug"" (
8   set DEBUG_OPTS= -Xloggc:../logs/gc.log -verbose:gc -XX:+PrintGCDetails -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=../logs 
9   goto debug
10)
11
12set JMX_OPTS=
13if ""%1"" == ""jmx"" (
14   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 
15   goto jmx
16)
17
18echo "Starting the %APP_NAME%"
19java -Xms512m -Xmx512m -server %DEBUG_OPTS% %JMX_OPTS% %CONFIG% -jar ../lib/%APP_NAME%
20goto end
21
22:debug
23echo "debug"
24java -Xms512m -Xmx512m -server %DEBUG_OPTS% %CONFIG% -jar ../lib/%APP_NAME%
25goto end
26
27:jmx
28java -Xms512m -Xmx512m -server %JMX_OPTS% %CONFIG% -jar ../lib/%APP_NAME%
29goto end
30
31:end
32pause

对于不同的springboot项目，只需要适当修改一下脚本就可以了，为了节约篇幅这里就不列出其他的脚本了，可以参考我提交的demo:https://github.com/Shalousun/springboot-vue.git，对于demo如有疑问可添加该群：170651381

ps:以上脚本参考自dubbo官方。其实对于dubbo项目的轻量化构建也是类似的

重点：上面讲了这么多脚本，其实每次创建项目添加一堆assembly的配置也是比较麻烦的，而且需要去修改脚本中的jar名称，修改的不一致还可能出错，因此可以采用本人开源的项目框架搭建脚手架https://gitee.com/sunyurepository/ApplicationPower来自动创建这些配置然后复制到您的项目中，您就只需要安安心心写写业务代码。

四、打包后应用的日志路径处理

在第二节的图中可以看到打包的应用日志一般统一输出到logs目录中，但是对于不同的系统平台，虽然配置的日志输出路径是一样的，但是最后不一定输出到logs中。经过测试在windows平台中使用相对的日志路径../logs是没有问题的，但是对于linux系统下使用相对路径就不能输出到logs下，因此建议在linux平台下就写绝对路径吧。不过在我提供的脚本中设置输出日志的路径

-Dlogging.path=../logs

因此结合log4j2的强大解析能力完全可以设置log42的日志路径（开发时则手动指定路径）：

<property name="LOG_HOME">${sys:logging.path}</property>

但是对于springboot应用的访问日志在linux下似乎只能使用绝对路径了。

1# server config
2server:
3  port: 8080
4  undertow:
5   accesslog:
6    enabled: true
7    dir: /usr/xxx/logs
8logging:
9  path: /usr/xxx/logs

当然后面有使用配置解决的同学可以提醒纠正下。

**总结：**这个方案本身并没有带来什么新东西，甚至脚本大多数是参考了dubbo官方的脚本，只是在上面做了些完善。但是重要的一点是怎么去根据实际的技术应用场景，思考使用这项技术需要做的服务化和工程化。

Springboot基于assembly的服务化打包方案