SpringBoot中使用Maven插件自定义项目结构进行部署

1. 前言

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

  • 让项目本身打包成单独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}')
3.3 至此项目就配置完成，其中有以下细节需要留意：
  • 所有的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. 总结

  • 更多注释尽在源码
  • 主要是对maven的相关插件以及启动停止脚本学习
  • 这样部署对于单体项目方便了管理(个人感觉)
  • 以上是个人的学习记录，若有不对之处，请指出，谢谢阅读！
最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 216,470评论 6赞 501
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 92,393评论 3赞 392
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 162,577评论 0赞 353
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 58,176评论 1赞 292
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 67,189评论 6赞 388
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 51,155评论 1赞 299
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 40,041评论 3赞 418
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 38,903评论 0赞 274
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 45,319评论 1赞 310
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,539评论 2赞 332
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,703评论 1赞 348
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 35,417评论 5赞 343
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 41,013评论 3赞 325
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,664评论 0赞 22
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,818评论 1赞 269
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 47,711评论 2赞 368
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 44,601评论 2赞 353