--- # 主题列表：juejin, github, smartblue, cyanosis, channing-cyan, fancy, hydrogen, condensed-night-purple, greenwillow, v-green, vue-pro, healer-readable, mk-cute, jzman, geek-black, awesome-green, qklhk-chocolate # 贡献主题：https://github.com/xitu/juejin-markdown-themes theme: cyanosis highlight: --- ## Ref * [SpringBoot - 使用assembly进行项目打包教程1（启动脚本、读外部配置文件） | Blog](https://www.hangge.com/blog/cache/detail_2862.html) * [SpringBoot - 使用assembly进行项目打包教程2（将项目代码与依赖分开打包）](https://www.hangge.com/blog/cache/detail_2865.html) ## Spring Boot项目的2种部署方式目前来说，Spring Boot 项目有如下 2 种常见的部署方式 1. 一种是使用 docker 容器去部署。将 Spring Boot 的应用构建成一个 docker image，然后通过容器去启动镜像。这种方式在需要部署大规模的应用以及对应用进行扩展时，是非常方便的，属于目前工业级的部署方案，但是需要掌握 docker 的生态圈技术。 2. 另一种则是使用 `FatJar` 直接部署启动（将一个 jar 及其依赖的三方 jar 全部打到一个包中，这个包即为 FatJar）。这是很多初学者或者极小规模情况下的一个简单应用部署方式。 ## Assembly 的优势上面介绍的 `Fatjar` 部署方案存在一些缺陷。因为我们如果直接构建一个 Spring Boot 的 FatJar 交由运维人员部署的话，整个配置文件都被隐藏到 jar 中，想要针对不同的环境修改配置文件就变成了一件很困难的事情。如果存在环境不确定，或者需要启动脚本启动项目的时候，这种直接通过 jar 的方式后续会需要处理很多工作。而通过 `assembly` 将 Spring Boot 服务化打包，便能解决上面提到的 2 个问题 * 使得 Spring Boot 能够加载 jar 外的配置文件。 * 提供一个服务化的启动脚本，这个脚本一般是 shell 或者 windows 下的 bat ，有了 Spring Boot 的应用服务脚本后，就可以很容易的去启动和停止 Spring Boot 的应用了。 ## 项目配置 ### 1-添加插件 (1) 编辑项目的 `pom.xml` 文件，加入 `assembly` 打包插件。 ```xml org.springframework.boot spring-boot-maven-plugin maven-assembly-plugin 3.1.1 src/main/assembly/assembly.xml make-assembly package single ``` (2) 从上面代码可以看出，把 `assembly` 的配置都放在 `main/assembly` 目录下（具体目录里面的文件接下来会创建）。 ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/1015b8b665924cf6a2c2e496ffc673d5~tplv-k3u1fbpfcp-zoom-1.image) ### 编写服务启动/停止脚本首先在 `assembly` 目录下创建一个 `bin` 文件夹，然后在该文件夹下创建一个 `start.sh` 文件，这个是 linux 环境下的启动脚本，具体内容如下。 > Tip：开头的项目名称、jar 包名称不用我们手动设置，这里使用参数变量，在项目打包后这些参数自动会替换为 pom 的 `profiles` 中 `properties` 的值（assembly 配置文件需要开启属性替换功能），下面另外两个配置文件也同理。 ```s #!/bin/bash # 项目名称 SERVER_NAME="${project.artifactId}" # jar名称 JAR_NAME="${project.build.finalName}.jar" # 进入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" ``` 然后创建一个 stop.sh 文件，这个是 linux 环境下的停止脚本，具体内容如下。 ```s #!/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 ``` 最后创建一个 start.bat 文件，这个是 Windows 环境下的启动脚本，具体内容如下。 ```s 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 ``` ### 创建打包配置文件最后，我们在 assembly 文件夹下创建一个 `assembly.xml` 配置文件，具体内容如下。 ```xml bin tar.gz true src/main/assembly/bin bin 0755 unix true src/main/assembly/config config 0644 src/main/resources /config **/*.xml **/*.properties **/*.yml true target lib *.jar . docs *.md 0644 docs docs 0644 src/main/assembly/docs docs 0644 ``` ## 打包测试 ### 打包项目 1. 我们使用 mvn package 命令对项目进行打包。 ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/af423f0a9b9343438f8a18ae7bffddc4~tplv-k3u1fbpfcp-zoom-1.image) 2. 打包后在 target 下便会生成一个名为 `xxx.tar.gz` 的压缩文件。 ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/6f0c7bd3d40f483ea0c1f0a67ea398f0~tplv-k3u1fbpfcp-zoom-1.image) 3. 将这个压缩包解压后可以看到内部包含的目录如下。 ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/d8ceeb90291f41be80da0289bf63dca3~tplv-k3u1fbpfcp-zoom-1.image) ### 启动服务 1. 上述打包文件解压后，在 bin 目录有如下几个启动文件 * Linux、macOS 系统：执行 start.sh 启动服务，执行 stop.sh 停止服务。 * Windows 系统：双击 start.bat 即可启动服务 ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/56340a07777848dfa318745e57fd56dd~tplv-k3u1fbpfcp-zoom-1.image) 2. 服务启动后，相应的日志文件会生成到 logs 目录下（logs 目录会自动创建） ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/22bf847183db4055ba8403642fd4373a~tplv-k3u1fbpfcp-zoom-1.image) ### 修改配置 1. 修改 `config` 文件夹下面的配置文件，此处的配置文件是 `application.properties`。 ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/8c9c7b3ea07e4d09adcf45b40a8d9119~tplv-k3u1fbpfcp-zoom-1.image) 2. 这里我们将服务端口改成 9090。 ```s server.port=9090 ``` 3. 重启服务，可以看到端口确实发生了变化，说明外部配置文件加载成功。 ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/732ce36d40b844c296f5e16f76b23766~tplv-k3u1fbpfcp-zoom-1.image) ## 将项目与依赖分开打包至此，上文中介绍的使用 assembly 对项目打包时，项目代码和项目所有的依赖文件会一起打成一个可执行的 jar 包。如果项目的依赖包很多，那么这个文件就会非常大。每次发布版本如果都要上传这个整个的 jar 包，既浪费带宽也浪费时间。下面介绍如何将项目的外部依赖跟自己的代码包分开打包，这样当项目修改后，只需要上传覆盖修改后的包即可。 ### 修改配置 1. 首先我们编辑 `assembly.xml` 配置文件。在前文的基础上新增第三方依赖设置，实现将第三方的 jar 包添加到压缩包里的 lib 目录。 ```xml bin tar.gz true false lib false src/main/assembly/bin bin 0755 unix true src/main/assembly/config config 0644 src/main/resources /config **/*.xml **/*.properties **/*.yml true target lib *.jar . docs *.md 0644 docs docs 0644 src/main/assembly/docs docs 0644 ``` 2. 接着编辑项目的 `pom.xml` 文件，先前使用的是 `spring-boot-maven-plugin` 来打包，这个插件会将项目所有的依赖打入项目 jar 包里面。我们将其替换为 `maven-jar-plugin`，并进行相关设置。 ```xml org.apache.maven.plugins maven-jar-plugin false true ./ com.example.hanggetest.HanggeTestApplication maven-assembly-plugin 3.1.1 src/main/assembly/assembly.xml make-assembly package single ``` ### 打包测试上面两个配置修改完毕后，我们重新对项目进行打包。将生成的压缩包解压后可以发现，`lib` 文件夹下项目 `jar` 包以及第三方 `jar` 都分开了，并且项目 jar 体积也十分小巧。原文出自：www.hangge.com 转载请保留原文链接：https://www.hangge.com/blog/cache/detail_2865.html ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/335af94d66ba4162a51641e04cf1e44b~tplv-k3u1fbpfcp-zoom-1.image)