springboot- 使用assembly进行项目打包
一、基本介绍
1、部署方式介绍
目前来说，SpringBoot 项目有如下两种常见的部署方式：一种是使用 docker 容器去部署。将 Spring Boot 的应用构建成一个 docker image，然后通过容器去启动镜像，这种方式在需要部署大规模的应用、以及应用扩展时是非常方便的，属于目前工业级的部署方案，但是需要掌握 docker 的生态圈技术。 另一种则是使用 FatJar 直接部署启动（将一个 jar 及其依赖的三方 jar 全部打到一个包中，这个包即为 FatJar），这是很多初学者或者极小规模情况下的一个简单应用部署方式。
2、使用 assembly 的优势
（1）上面介绍的 Fatjar 部署方案存在一些缺陷。因为我们如果直接构建一个 Spring Boot 的 FatJar 交由运维人员部署的话，整个配置文件都被隐藏到 jar 中，想要针对不同的环境修改配置文件就变成了一件很困难的事情。如果存在环境不确定，或者需要启动脚本启动项目的时候，这种直接通过 jar 的方式后续会需要处理很多工作。
（2）而通过 assembly 将 Spring Boot 服务化打包，便能解决上面提到的两个问题：
- 使得 Spring Boot 能够加载 jar 外的配置文件。
- 提供一个服务化的启动脚本，这个脚本一般是 shell 或者 windows 下的 bat ，有了 Spring Boot 的应用服务脚本后，就可以很容易的去启动和停止 Spring Boot 的应用了。
二、项目配置
1、添加插件
1）编辑项目的 pom.xml 文件，加入 assembly 打包插件：
<plugin> <artifactId>maven-assembly-plugin</artifactId> <version>3.1.0</version> <executions> <execution> <id>maven-assembly</id> <!--绑定到maven操作类型上--> <phase>package</phase> <!--运行一次--> <goals> <goal>single</goal> </goals> <configuration> <!-- zip包文件名 --> <finalName>${project.artifactId}</finalName> <!-- zip包文件名不加上assembly.xml中配置的id属性值 --> <appendAssemblyId>false</appendAssemblyId> <descriptors> <!--具体的配置文件--> <descriptor>src/main/assembly/assembly.xml</descriptor> </descriptors> </configuration> </execution> </executions> </plugin>
2）从上面代码可以看出，我把 assembly 的配置放在 main/assembly 目录下。大家可以根据习惯使用其他目录，只要对上面配置做相应修改即可。
3）编写assembly文件
<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"> <id>bin</id> <!-- 打包的类型，如果有N个，将会打N个类型的包 --> <formats> <!--<format>tar.gz</format>--> <format>zip</format> </formats> <!--是否包装一层--> <includeBaseDirectory>true</includeBaseDirectory> <!--文件设置--> <fileSets> <!-- 0755->即用户具有读/写/执行权限，组用户和其它用户具有读写权限； 0644->即用户具有读写权限，组用户和其它用户具有只读权限； --> <!-- 将src/main/bin目录下的所有文件输出到打包后的bin目录中 --> <fileSet> <directory>src/main/bin</directory> <outputDirectory>bin</outputDirectory> <fileMode>0755</fileMode> <!--如果是脚本，一定要改为unix.如果是在windows上面编码，会出现dos编写问题--> <lineEnding>unix</lineEnding> <filtered>true</filtered><!-- 是否进行属性替换 --> </fileSet> <!-- 将src/main/assembly/config目录下的所有文件输出到打包后的config目录中 --> <!--<fileSet> <directory>src/main/assembly/config</directory> <outputDirectory>config</outputDirectory> <fileMode>0644</fileMode> </fileSet>--> <!-- 将src/main/resources下配置文件打包到config目录 --> <fileSet> <directory>src/main/resources</directory> <outputDirectory>config</outputDirectory> <includes> <include>**/*.xml</include> <include>**/*.properties</include> <include>**/*.yml</include> </includes> <filtered>true</filtered><!-- 是否进行属性替换 --> </fileSet> <!-- 将项目启动jar打包到lib目录中 --> <fileSet> <directory>target</directory> <outputDirectory>lib</outputDirectory> <includes> <include>*.jar</include> </includes> </fileSet> <!-- 将项目说明文档打包到docs目录中 --> <!--<fileSet> <directory>.</directory> <outputDirectory>docs</outputDirectory> <includes> <include>*.md</include> </includes> <fileMode>0644</fileMode> </fileSet> <fileSet> <directory>docs</directory> <outputDirectory>docs</outputDirectory> <fileMode>0644</fileMode> </fileSet> <fileSet> <directory>src/main/assembly/docs</directory> <outputDirectory>docs</outputDirectory> <fileMode>0644</fileMode> </fileSet>--> </fileSets> </assembly>
到这一步，执行maven package打包后效果如下：
但是bin文件夹下是空的，因为shell命令的批处理文件还没写，下面我们编写脚本；编写完成后重新打包即可
2、编写服务“启动/停止”脚本
1）首先在 main 目录下创建一个 bin 文件夹，然后在该文件夹下创建一个 start.sh 文件，这个是 linux 环境下的启动脚本，具体内容如下：
注意：开头的项目名称、jar 包名称不用我们手动设置，这里使用参数变量，在项目打包后这些参数自动会替换为 pom 的 profiles 中 properties 的值（assembly 配置文件需要开启属性替换功能），下面另外两个配置文件也同理。
#!/bin/bash # 项目名称 SERVER_NAME="${project.artifactId}" echo "The $SERVER_NAME : " # jar名称 JAR_NAME="${project.build.finalName}.jar" echo "The $JAR_NAME : " # 进入bin目录 cd `dirname $0` # bin目录绝对路径 BIN_DIR=`pwd` # 返回到上一级项目根目录路径 cd .. # 打印项目根目录绝对路径 # `pwd` 执行系统命令并获得结果 DEPLOY_DIR=`pwd` # 外部配置文件绝对目录,如果是目录需要/结尾，也可以直接指定文件 # 如果指定的是目录,spring则会读取目录中的所有配置文件 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 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 # 如果logs文件夹不存在,则创建文件夹 if [ ! -d $LOGS_DIR ]; then mkdir $LOGS_DIR fi STDOUT_FILE=$LOGS_DIR/catalina.log # JVM Configuration 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 # 加载外部log4j2文件的配置 LOG_IMPL_FILE=log4j2.xml LOGGING_CONFIG="" if [ -f "$CONF_DIR/$LOG_IMPL_FILE" ] then LOGGING_CONFIG="-Dlogging.config=$CONF_DIR/$LOG_IMPL_FILE" fi CONFIG_FILES=" -Dlogging.path=$LOGS_DIR $LOGGING_CONFIG -Dspring.config.location=$CONF_DIR/ " 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"
2）接着创建一个 stop.sh 文件，这个是 linux 环境下的停止脚本，具体内容如下：
#!/bin/bash # 项目名称 APPLICATION="${project.artifactId}" # 项目启动jar包名称 APPLICATION_JAR="${project.build.finalName}.jar" # 通过项目名称查找到PI，然后kill -9 pid PID=$(ps -ef | grep "${APPLICATION_JAR}" | grep -v grep | awk '{ print $2 }') if [[ -z "$PID" ]] then echo ${APPLICATION} is already stopped else echo kill ${PID} kill -9 ${PID} echo ${APPLICATION} stopped successfully fi
3）最后创建一个 start.bat 文件，这个是 Windows 环境下的启动脚本，具体内容如下：
echo off set APP_NAME=${project.build.finalName}.jar set LOG_IMPL_FILE=log4j2.xml set LOGGING_CONFIG= if exist ../config/%LOG_IMPL_FILE% ( set LOGGING_CONFIG=-Dlogging.config=../config/%LOGGING_CONFIG% ) set CONFIG= -Dlogging.path=../logs %LOGGING_CONFIG% -Dspring.config.location=../config/ 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% echo "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
三、打包测试
1、打包项目
1）我们使用 mvn package 命令对项目进行打包：
2）打包后在 target 下便会生成一个名为 xxx.zip 的压缩文件：
3）将这个压缩包解压后可以看到内部包含的目录如下：
2、启动服务
1）其中 bin 目录有如下几个启动文件：
Linux、macOS 系统：执行 start.sh 启动服务，执行 stop.sh 停止服务。
Windows 系统：双击 start.bat 即可启动服务
2）服务启动后，相应的日志文件会生成到 logs 目录下（logs 目录会自动创建）：
学无止境...
