SpringBoot中使用Maven插件拆分部署项目

1. 前言

本篇博客记录在工作中的学习心得！在SpringBoot项目中，一般使用默认的配置将项目打包成一个内嵌Tomcat的jar，在服务端之间java -jar 项目名.jar，这样就可以启动了。但是，当每修改一点点东西都要替换掉整个jar，而且后台运行jar的方式也比较复杂。本文只针对在使用SpringBoot做单体应用，而不是分布式部署，具体分布式是否适合还待研究。
所以接下来的重点来了：拆分部署

• 让项目本身打包成单独jar，使之与其他依赖独立开来
• 使资源文件与源代码jar分离，当我修改mapper对应的xml时，只需要更新对应的xml，其他资源文件也是类似
• 在启动方面是有脚本去启动与暂停服务

2. Maven插件介绍

2.1 主要使用到的maven依赖：

• maven-compiler-plugin: 指定Maven编译时的设置
• maven-source-plugin: 生成源代码包
• maven-assembly-plugin: 构建可执行jar(包括项目依赖的jar)
• maven-jar-plugin: 配置本项目jar信息

2.2 Maven插件一一介绍

maven-compiler-plugin:指定Maven编译时的设置

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-compiler-plugin</artifactId>
    <configuration>
        <source>${java.version}</source>
        <target>${java.version}</target>
        <encoding>${project.build.sourceEncoding}</encoding>
        <compilerArgs>
            <arg>-Xlint:deprecation</arg>
            <arg>-Xlint:unchecked</arg>
        </compilerArgs>
    </configuration>
</plugin>

标签	具体释义
<source>	源代码使用的JDK版本
<target>	生成的目标class文件的编译版本
<encoding>	字符集编码
<meminitial>	编译器使用的初始内存
<maxmem>	编译器使用的最大内存
<compilerArgs>	设置Java编译器的执行参数
<arg>-Xlint:deprecation</arg>	忽略代码中已过时API警告
<arg>-Xlint:unchecked</arg>	忽略代码中未经检查或不安全的操作

maven-source-plugin: 生成源代码包

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-source-plugin</artifactId>
    <configuration>
        <attach>true</attach>
    </configuration>
    <executions>
        <execution>
            <phase>package</phase>
            <goals>
                <goal>jar</goal>
            </goals>
        </execution>
    </executions>
</plugin>

标签	具体释义
<executions>	配置执行的参数
<phase>	绑定到package生命周期阶段上
<goal>	生成jar包

maven-jar-plugin: 配置本项目jar信息

plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-jar-plugin</artifactId>
    <configuration>
        <archive>
            <manifest>
                <mainClass>cn.jtcoding.packagedemo.SpringbootPackageDemoApplication</mainClass>
                <classpathPrefix>../lib/</classpathPrefix>
                <addClasspath>false</addClasspath>
            </manifest>
        </archive>
        <excludes>
            <exclude>*.java</exclude>
        </excludes>
    </configuration>
</plugin>

标签	具体释义
<mainClass>	指定本项目jar的main-class
<classpathPrefix>	指定依赖的jar以及本项目jar所在的路径
<addClasspath>	添加外部jar的classpath项

maven-assembly-plugin: 构建可执行jar(包括项目依赖的jar)

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-assembly-plugin</artifactId>
    <configuration>
        <appendAssemblyId>false</appendAssemblyId>
        <descriptors>
            <descriptor>src/main/resources/assembly.xml</descriptor>
        </descriptors>
        <outputDirectory>${project.build.directory}/application</outputDirectory>
    </configuration>
    <executions>
        <execution>
            <id>assembly_setting</id>
            <phase>package</phase>
            <goals>
                <goal>single</goal>
            </goals>
        </execution>
    </executions>
</plugin>

标签	具体释义
<descriptors>	指定打包的配置文件
<outputDirectory>	指定生成包依赖目录，该目录是相对于根目录
<executions>	配置执行的参数
<id>assembly_setting</id>	唯一标识，这里要与assembly.xml文件中id一致
<phase>package</phase>	绑定到package生命周期阶段上
<goal>single</goal>	打包只执行一次

assembly.xml配置

<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2 http://maven.apache.org/xsd/assembly-1.1.2.xsd">

    <!--添加到生成文件名称的后缀符-->
    <id>dist_app</id>

    <!--
        打包格式，支持多种：dir、zip、tar.gz.....
    -->
    <formats>
        <format>tar.gz</format>
    </formats>
    <includeBaseDirectory>false</includeBaseDirectory>

    <!--
        配置资源文件输出目录以及需要过滤的文件夹或文件
    -->
    <fileSets>
        <!--输出resource下所有资源文件-->
        <fileSet>
            <directory>src/main/resources</directory>
            <excludes>
                <exclude>assembly.xml</exclude>
                <exclude>db/**</exclude>
            </excludes>
            <outputDirectory>/</outputDirectory>
        </fileSet>

        <!--输出bin文件夹-->
        <fileSet>
            <directory>${project.basedir}/bin</directory>
            <outputDirectory>/bin</outputDirectory>
            <fileMode>0775</fileMode>
            <includes>
                <include>*.sh</include>
            </includes>
        </fileSet>
    </fileSets>

    <!--
        配置默认所有的jar输出目录(依赖jar + 项目jar)
    -->
    <dependencySets>
        <dependencySet>
            <outputDirectory>/lib</outputDirectory>
            <scope>runtime</scope>
        </dependencySet>
    </dependencySets>
</assembly>

• assembly.xml配置都在代码中加以注释，就不做过多介绍
• 到目前为止，项目的maven插件配置完了，接下来介绍启动与停止服务的脚本

3. 启动与停止服务的脚本

3.1 启动脚本:start.sh

#!/bin/bash
# 配置JDK安装路径
JAVA_HOME="/usr/local/java/jdk1.8.0_131"
JAVA_CMD=${JAVA_HOME}/bin/java
# JVM的相关配置
JAVA_OPTION="-Ddefault.client.encoding=UTF-8 -Dfile.encoding=UTF-8 -server -Xms128M -Xmx256M"
COLOR_RED="\\033[1;31m"
COLOR_GREEN="\\033[1;32m"
COLOR_DEFAULT="\\033[0m"

DT_NOW=`date '+%Y%m%d_%H%M%S'`

# 获取当前文件的路径
PATH_DIR=$(dirname $(which $0))
# 项目路径 
APP_HOME=${PATH_DIR%/*}
# jar所在路径
APP_LIB="${APP_HOME}/lib"

# 变量并执行所有jar
for libfile in ${APP_LIB}/*.zip ; do
   if [[ -f ${libfile} ]] ; then
       CLASSPATH=${libfile}:${CLASSPATH}
   fi
done
for libfile in ${APP_LIB}/*.jar ; do
   if [[ -f ${libfile} ]] ; then
       CLASSPATH=${libfile}:${CLASSPATH}
   fi
done
CLASSPATH=${APP_HOME}:${CLASSPATH}

# 记录日志
cd ${APP_HOME}
if [[ ! -d "log/" ]]; then
   mkdir log
fi
# 配置启动类
CMD="${JAVA_CMD} ${JAVA_OPTION} -classpath ${CLASSPATH}\ cn.jtcoding.packagedemo.SpringbootPackageDemoApplication"
`${CMD} >${APP_HOME}/log/stderr.txt 2>&1 &`

sleep 3
ps -eaf | grep "java" | grep "${APP_HOME}/"

3.2 停止脚本:stop.sh

#!/bin/bash
PATH_DIR=$(dirname $(which $0))
PROCESS_NAME=${PATH_DIR%/*}
kill -9 $(ps -eaf|grep -i "java .*-classpath .*${PROCESS_NAME}/"|grep -v 'grep'|awk '{print $2}')

至此项目就配置完成，其中有以下细节需要留意：

• 所有的jar都输出在lib文件夹下，assembly.xml文件不需要，所有过滤掉，其他资源正常输出不变化
• 现在的打包方式是tar.gz，因为后面是直接上传到linux上进行部署测试，所有打包成tar.gz，在实际开发会打包成dir，这样生成的就是文件以及文件夹，那么在修改资源文件直接将资源文件上传即可，修改代码直接将lib下的本项目jar替换掉即可
• 在start.sh中，请修改 JAVA_HOME 和 启动类
• 在Windows机子上，shell脚本格式会被编译dos，在linux上需要更改，后面会介绍
• maven-assembly-plugin的配置方式有两种：
  1. 现在的我是配置了<executions>信息，
     执行：mvn clean package -Dmaven.test.skip=true
  2. 如果没有配置<executions>信息，在命令中指定即可
     执行：mvn clean package assembly:single -Dmaven.test.skip=true

4. 实践

所有步骤已经完成，接下来打包部署实践环节

4.1 现项目结构：

项目结构

4.2 打包：

打包

4.3 打包完成：

打包完成

4.4 上传到Linux服务，这里使用的是CentOS

上传到Linux服务

上传成功

4.5 解压

解压命令

解压完成

4.6 执行启动脚本

报错了

在启动的时候报错了，原因是我本地是Windows系统，shell文件别编译测dos命令脚本格式了，使用vim修改即可：

vim修改

4.7 执行set ff查看脚本文件格式

set ff

format=dos

4.8 更改文件格式：set ff=unix，保存退出

set ff=unix

4.9 停止文件同上更改

.....

4.10 启动

启动

4.11 防火墙开放端口

firewall-cmd --zone=public --add-port=10027/tcp --permanent
firewall-cmd --reload

4.12 访问http://www.jtcoding.cn:10027/tests

访问

5. 总结

• 更多注释尽在源码

.....wait