SpringBoot 配置文件与依赖库分离打包配置

一、应用场景

一般情况下我们对springboot应用打包时使用springboot的maven插件spring-boot-maven-plugin的maven进行打包，打包完成得到一个fatjar，fatjar的优点是可以直接运行，缺点是体积太大，不利于传输，springboot应用打出来的fatjar体积少则几十M，多则上百M，在往服务器部署传输时十分便，可能只改了某个类文件，都需要重新将整个fatjar重新传输一次，特别是走公网传输的时候，可能上传速度只有几百甚至几十KB，而整个fatjar中真正我们项目的代码文件可能也就几百KB或几兆的大小，所以有必要将fatjar中的依赖库与我们项目的class进行分离打包，这样每次更换项目class就方便很多，而将配置文件也分离出来的原因在于我们可能经常需要更改配置文件的内容，如果放在fatjar中这样修改是非常不方便的，所以也需要将配置文件也分离出来。

  fatjar 即将项目需要的所有依赖库及配置文件等打进一个jar或war，该文件可直接运行

二、配置

2.1 POM配置

下面对pom.xml进行配置，来实现分离打包，配置如下

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion>

1<groupId>chenyb</groupId>
2<artifactId>demo</artifactId>
3<version>v1.2-release</version>
4
5<parent>
6    <groupId>org.springframework.boot</groupId>
7    <artifactId>spring-boot-starter-parent</artifactId>
8    <version>2.1.6.RELEASE</version>
9</parent>
10
11<dependencies>
12    <dependency>
13        <groupId>org.springframework.boot</groupId>
14        <artifactId>spring-boot-starter</artifactId>
15    </dependency>
16    <dependency>
17        <groupId>org.springframework.boot</groupId>
18        <artifactId>spring-boot-starter-web</artifactId>
19    </dependency>
20</dependencies>
21
22<build>
23    <plugins>
24        <!-- springboot 打包插件 -->
25        <!--
26        <plugin>
27            <groupId>org.springframework.boot</groupId>
28            <artifactId>spring-boot-maven-plugin</artifactId>
29            <configuration>
30                <mainClass>com.xx.xx</mainClass>
31            </configuration>
32            <executions>
33                <execution>
34                    <goals>
35                        <goal>repackage</goal>
36                    </goals>
37                </execution>
38            </executions>
39        </plugin>
40        -->
41
42        <!-- maven 打包插件 -->
43        <plugin>
44            <groupId>org.apache.maven.plugins</groupId>
45            <artifactId>maven-jar-plugin</artifactId>
46            <configuration>
47                <archive>
48                    <manifest>
49                        <addClasspath>true</addClasspath>
50                        <!-- MANIFEST.MF 中 Class-Path 加入前缀 -->
51                        <classpathPrefix>lib/</classpathPrefix>
52                        <!-- jar包不包含唯一版本标识 -->
53                        <useUniqueVersions>false</useUniqueVersions>
54                        <!-- 指定入口类 -->
55                        <mainClass>cn.test.DemoApplication</mainClass>
56                    </manifest>
57                </archive>
58                <outputDirectory>${project.build.directory}</outputDirectory>
59            </configuration>
60        </plugin>
61
62        <!-- 拷贝依赖 -->
63        <plugin>
64            <groupId>org.apache.maven.plugins</groupId>
65            <artifactId>maven-dependency-plugin</artifactId>
66            <executions>
67                <execution>
68                    <id>copy-dependencies</id>
69                    <phase>package</phase>
70                    <goals>
71                        <goal>copy-dependencies</goal>
72                    </goals>
73                    <configuration>
74                        <outputDirectory>${project.build.directory}/lib</outputDirectory>
75                        <overWriteReleases>true</overWriteReleases>
76                        <overWriteSnapshots>true</overWriteSnapshots>
77                        <overWriteIfNewer>true</overWriteIfNewer>
78                    </configuration>
79                </execution>
80            </executions>
81        </plugin>
82
83    </plugins>
84</build>

关键配置说明：

(1) 去掉了spring-boot-maven-plugin打包插件

(2) 添加 maven-jar-plugin （maven标准打包插件）

(3) maven-dependency-plugin（依赖拷贝插件，主要用于将maven依赖库拷贝出来）

插件具体的配置，pom.xml中已添加备注说明

2.2 打包

执行maven package 命令进行打包，得到的结果如下

 将 lib目录 及 项目jar 文件拷贝到同一目录下，我为了测试方便，先全部拷贝到桌面上，（放置服务器上时也需保证在同一目录下）

 打开demo-v1.2-release可以看到，并没有将依赖jar打进来，大小只有不到4KB

2.3 config目录创建

以上做完还还需要将项目配置文件拷贝出来，在与jar包平级目录建立config目录，将项目中的application.properties或yaml文件拷贝进来

  config 下的文件

经过以上步骤，全部配置完毕，下面进行一下简单的测试

三、测试

 为了保证加载的是外部config目录的配置文件，我将application-test.yaml中的server.port改为8085， 打开命令行输入

C:\Users\Administrator\Desktop>java -jar -Dspring.profiles.active=dev -Dspring.location.config=config/ C:\Users\Administrator\Desktop\demo-v1.2-release.jar

回车运行，能正常启动说明外部依赖可以正常加载进来

 可以看到启动完成后tomcat监听端口为8085，说明外部配置加载成功。

PS : 如果外部配置文件加载失败，会使用项目jar中的配置文件，如下图，也就是启动后会是8080端口

application-dev.yaml中配置的端口是8080

而我已将外部config目录下application-dev.yaml中端口做了修改，使用外部配置文件启动后会是8085端口

四、一点小坑

默认情况下window命令行打开后，是在当前用户目录下，像这样

 而我的config、lib、项目jar拷贝在桌面上，实际路径是

一开始我在  C:\Users\Administrator> 直接执行下方命令，一直加载不到配置文件

java -jar -Dspring.profiles.active=de'v -Dspring.location.config=config/ C:\Users\Administrator\Desktop\demo-v1.2-release.jar

原因就在于程序与配置文件不在同一目录下，我在C:\Users\Administrator>运行启动命令，而程序实际目录在 C:\Users\Administrator\Desktop> 下，因为程序使用了绝对路径，可以找到文件，所以程序的实际运行路径为C:\Users\Administrator\Desktop，而我使用的配置 spring.location.config=config/ 使用的是相对路径，，这个相对路径又是相对 C:\Users\Administrator> 目录，所以就会出现找不到配置文件的情况。

解决办法一：

命令行切换到 C:\Users\Administrator\Desktop 目录，即项目jar所在目录，运行 java -jar 命令

解决办法二：

将config拷贝到C:/Users/Administrator下，保证C:/Users/Administrator相对路径下存在config目录及配置文件（该方法可解决问题，但是不建议）

解决方法三：

spring.location.config=config/ 处使用绝对路径，即C:/Users/Administrator/Desktop/config/ 

所以很重要一点，一定保证 执行命令 的目录 与项目jar、lib、config都在同一目录下。

五、完整demo地址

https://github.com/yuboon/java-examples/tree/master/springboot-package-segment