SpringBoot分离打包：将jar包与lib依赖、配置文件分开

一、前言

昨天和项目组内一位经验丰富的老师傅探讨，围绕着SpringBoot打包后动不动就一百多兆，在现场远程维护部署时非常不方便的问题，进行了一番请教。问题的根本是：有时候仅仅改动了一点点东西，却要发给现场替换包含所有依赖的jar包，这非常的笨重不方便。

于是又学到了新知识。抽空浏览了网上的资料，结合工作中的实际使用场景，整理了本文的内容，方便后期随时取用。

二、正文

之前一直使用SpringBoot初始化建立项目默认的spring-boot-maven-plugin插件，进行项目打包，这个插件会将项目所有的依赖打入BOOT-INF/lib下，这就导致了jar包的体积非常臃肿，尤其涉及到几十个子项目时，整个项目的体积可想而知。但是，各项目之间有非常的公共依赖，因此，分离打包还是比较有意义的。

本文还是在上两篇的项目上进行测试，毕竟只改了pom文件中的build标签下的插件内容
如果有兴趣可翻阅：SpringBoot整合新版Mybatis-Plus代码生成器、SpringBoot整合Knife4j替代Swagger。

1.整个项目的目录结构

2.系统环境变量配置

3.pom文件配置——本文重点，其它部分甚至不用看

pom中几乎所有的配置项都有比较详细的注释，表明每个属性是做什么，以及如何配置，请根据项目实际进行配置。

• properties标签中定义依赖的输出目录、jar包的输出目录、resources中配置文件的输出目录。

   <properties>
        <!--依赖输出目录-->
        <output.dependence.file.path>lib/</output.dependence.file.path>
        <!--jar输出目录-->
        <output.jar.file.path>bin/</output.jar.file.path>
        <!--配置文件输出目录-->
        <output.resource.file.path>config/</output.resource.file.path>
    </properties>

• build标签：plugins标签中一共包含三个插件：maven-jar-plugin、maven-dependency-plugin和maven-resources-plugin。

啰嗦一句，在下方配置中会看到有…/这种相对路径的配置，其实非常简单，只要把握住一点，一切从最终的jar包出发，考虑如何让它能够找到它所依赖的lib和配置文件即可。

<build>
        <plugins>
            <!-- 打JAR包，不包含依赖文件；显式剔除配置文件 -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-jar-plugin</artifactId>
                <configuration>
                    <!--${env.LEARN_HOME}为项目配置的环境变量，下同-->
                    <outputDirectory>${env.LEARN_HOME}/${output.jar.file.path}</outputDirectory>
                    <!-- 将配置文件排除在jar包 -->
                    <excludes>
                        <exclude>*.properties</exclude>
                        <exclude>*.yml</exclude>
                        <exclude>*.xml</exclude>
                        <exclude>*.txt</exclude>
                    </excludes>
                    <archive>
                        <!-- 生成的jar中，包含pom.xml和pom.properties这两个文件 -->
                        <addMavenDescriptor>true</addMavenDescriptor>
                        <!-- 生成MANIFEST.MF的设置 -->
                        <manifest>
                            <!--这个属性特别关键，如果没有这个属性，有时候我们引用的包maven库 下面可能会有多个包，并且只有一个是正确的，
                            其余的可能是带时间戳的，此时会在classpath下面把那个带时间戳的给添加上去，然后我们 在依赖打包的时候，
                            打的是正确的，所以两头会对不上，报错。 -->
                            <useUniqueVersions>false</useUniqueVersions>
                            <!-- 为依赖包添加路径, 这些路径会写在MANIFEST文件的Class-Path下 -->
                            <addClasspath>true</addClasspath>
                            <!-- MANIFEST.MF 中 Class-Path 各个依赖加入前缀 -->
                            <!--这个jar所依赖的jar包添加classPath的时候的前缀，需要 下面maven-dependency-plugin插件补充-->
                            <!--一定要找对目录，否则jar找不到依赖lib，前边加../是因为jar在bin下，而bin与lib是平级目录-->
                            <classpathPrefix>../${output.dependence.file.path}</classpathPrefix>
                            <!--指定jar启动入口类 -->
                            <mainClass>com.ieslab.knife4j.demo.DemoApplication</mainClass>
                        </manifest>
                        <manifestEntries>
                            <!-- 假如这个项目可能要引入一些外部资源，但是你打包的时候并不想把 这些资源文件打进包里面，这个时候你必须在
                            这边额外指定一些这些资源文件的路径,假如你的pom文件里面配置了 <scope>system</scope>,就是你依赖是你本地的
                            资源，这个时候使用这个插件，classPath里面是不会添加，所以你得手动把这个依赖添加进这个地方 -->
                            <!--MANIFEST.MF 中 Class-Path 加入自定义路径，多个路径用空格隔开 -->
                            <!--此处resources文件夹的内容，需要maven-resources-plugin插件补充上-->
                            <Class-Path>../${output.resource.file.path}</Class-Path>
                        </manifestEntries>
                    </archive>
                </configuration>
            </plugin>

            <!-- 复制依赖的jar包到指定的文件夹里 -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-dependency-plugin</artifactId>
                <executions>
                    <execution>
                        <id>copy-dependencies</id>
                        <phase>package</phase>
                        <goals>
                            <goal>copy-dependencies</goal>
                        </goals>
                        <configuration>
                            <!-- 拷贝项目依赖包到指定目录下 -->
                            <outputDirectory>${env.LEARN_HOME}/${output.dependence.file.path}</outputDirectory>
                            <!-- 是否排除间接依赖，间接依赖也要拷贝 -->
                            <excludeTransitive>false</excludeTransitive>
                            <!-- 是否带上版本号 -->
                            <stripVersion>false</stripVersion>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
            <!-- 用于复制指定的文件 -->
            <plugin>
            	<groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-resources-plugin</artifactId>
                <executions>
                    <!-- 复制配置文件 -->
                    <execution>
                        <id>copy-resources</id>
                        <phase>package</phase>
                        <goals>
                            <goal>copy-resources</goal>
                        </goals>
                        <configuration>
                            <resources>
                                <resource>
                                    <directory>src/main/resources</directory>
                                    <includes>
                                    	<!--将如下格式配置文件拷贝-->
                                        <exclude>*.properties</exclude>
                                        <exclude>*.yml</exclude>
                                        <exclude>*.xml</exclude>
                                        <exclude>*.txt</exclude>
                                    </includes>
                                </resource>
                            </resources>
                            <!--输出路径-->
                            <outputDirectory>${env.LEARN_HOME}/${output.resource.file.path}</outputDirectory>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

4. 打包

首先，把右上角的闪电图标点上，可以在打包时“跳过测试模式”。然后分别双击执行clean和package命令，进行清理和打包。

打包成功：

打包完成后，我们去输出目录看一下：

5.测试，测试依赖于前两篇所构建的测试项目，当然这不重要

进入bin目录下：在地址栏输入cmd回车

启动项目：java -jar demo-1.0.0.jar

启动成功：

浏览器输入knife4j地址验证一下：

三、总结

本文关于SpringBoot分离打包的内容就这么多，有兴趣可以试一下。

当然还有很多不足需要继续探索的地方，比如，将所有的配置文件都输出到config目录下，项目很多怎么办？是不是应该考虑config目录下，每一个子项目一个独立目录？还有整个项目的公共配置如何处理？不可能每个项目都维护一份公共配置信息，万一修改需要修改很多处，那需要怎么解决？

下次见。