关于maven打包时, 资源文件没有被打包进来的问题

川长思鸟来 2022-11-12 08:29 1288阅读 0赞

### 文章目录 ###

*   *   *  问题起因
         *  问题出现
         *  初步结论
         *  问题回溯
         *  谜团解开

### 问题起因 ###

在之前的一篇文章[mybatis看这一篇就够了][mybatis]当中，提到过，在使用mybatis时，有时候需要把编写了SQL语句的XML文件，和Java文件放在同一个目录下，如

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3ZjajEwMDk3ODQ4MTQ_size_16_color_FFFFFF_t_70][]

如果不加配置，用maven进行打包时，默认不会将`src/main/java`目录下的XML文件打包进去。因为`src/main/java`被设定为了**源码目录**，默认只会将其中的Java文件进行编译打包。

即，默认打包得到的结果如下

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3ZjajEwMDk3ODQ4MTQ_size_16_color_FFFFFF_t_70 1][]

可以看到`com.example.mp.mappers`包下没有XML文件

我们可以配置`pom.xml`中的`resources`标签，指定打包时，加入`src/main/java`下面的XML文件，`pom.xml`如下

这样配置后，再次打包，`src/main/java`目录下的XML文件就会被打包进来了

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3ZjajEwMDk3ODQ4MTQ_size_16_color_FFFFFF_t_70 2][]

### 问题出现 ###

然而，今天在一个SpringBoot项目中测试mybatis-plus的demo时，发现，若`pom.xml`中增加了这一个自定义的`resources`标签配置，会覆盖掉默认的`resources`打包配置，**使得`src/main/resources`目录下的文件无法打包进来，从而运行时因为缺少`application.yml`等资源文件而报错。**

假设我们有一个SpringBoot的项目，目录结构如下

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3ZjajEwMDk3ODQ4MTQ_size_16_color_FFFFFF_t_70 3][]

我们的`pom.xml`按照上面所说，配置了扫描`src/main/java`下面的XML文件。我们执行`mvn clean package -DskipTests=true`进行打包。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3ZjajEwMDk3ODQ4MTQ_size_16_color_FFFFFF_t_70 4][]

根据maven的执行日志，看到maven的resources插件只打包了一个资源文件

我们查看打包后的`target`目录

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3ZjajEwMDk3ODQ4MTQ_size_16_color_FFFFFF_t_70 5][]

可以看到，`src/main/java`下的XML文件被成功打包了进来。

但`src/main/resources`下的资源文件全都没有被打包进来

此时运行该SpringBoot项目，因为缺失`application.yml`，找不到配置的数据源，而报错

而如果我们在`pom.xml`中去掉`resources`标签的配置，即删掉

其他部分不变，再次打包

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3ZjajEwMDk3ODQ4MTQ_size_16_color_FFFFFF_t_70 6][]

maven执行的日志显示，maven资源插件打包了3个资源文件

查看打包后的`target`目录

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3ZjajEwMDk3ODQ4MTQ_size_16_color_FFFFFF_t_70 7][]

`src/main/resources`目录下的资源文件被成功打包进来了。而由于没有配置，`src/main/java`下的XML文件就没有被打包。

由此可知，**默认情况下，maven打包会将资源目录（一般是`src/main/resources`）中的资源文件打包进去。**

如何查看项目的资源目录呢？

IDEA左上角 File — Project Structure — Modules — 选中你的项目

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3ZjajEwMDk3ODQ4MTQ_size_16_color_FFFFFF_t_70 8][]

可以看到，蓝色的文件夹就是源代码目录，右下角带着像金币一样图标的文件夹，就是资源目录，而绿色的是测试代码目录。

若要将某个目录设为资源目录，鼠标选中那个目录，在上方的`Mark as`那一行，点击`Resources` 即可。

### 初步结论 ###

上面说到，**maven默认会将资源目录下的资源文件进行打包，而如果在`pom.xml`中配置了`resources`标签，则默认的资源打包策略就被覆盖掉了，只会打包`resources`标签中配置的资源文件**，所以，如果`pom.xml`中配置了

则只会打包该配置指定的目录，不会打包`src/main/resources`目录，即使它是项目的资源目录。

**这一点需要特别注意！！！需要特别注意！！！特别注意！！！**

解决方案呢？当然有，**手动将`src/main/resources`也添加到配置就可以了**。按如下的`pom.xml`配置，maven打包时，既能包含`src/main/java`下的XML文件，也能包含**资源目录**（`src/main/resources`）下面的资源文件

<build>
        <resources>
                <resource>
                    <directory>src/main/java</directory>
                    <includes>
                        <include>**/*.xml</include>
                    </includes>
                </resource>
    
                <resource>
                    <directory>src/main/resources</directory>
                    <includes>
                        <include>**/*</include>
                    </includes>
                </resource>
            </resources>
    </build>

或者，**把全部的资源文件，统一放在`src/main/resources`目录下**，这样无需额外配置`pom.xml`。

### 问题回溯 ###

然而，在一年前的这篇文章 -> [mybatis看这一篇就够了][mybatis] 当中，提到过当把XML文件和java类放在一起时，可以通过增加`pom.xml`的配置解决XML文件没有被打包的问题，当时增加了`pom.xml`中的`resources`配置，仅配置了扫描`src/main/java`目录，但是`src/main/resources`下的文件也被打包了进来。好像并没有出现这次遇到的这种问题。  
我起初怀疑跟SpringBoot有关，但是，经过反复的测试，发现maven项目都会出现这种问题，并且我把[mybatis看这一篇就够了][mybatis]这篇文章中当时使用的demo代码找到了，重新用maven进行打包测试，发现问题仍然出现。这时我就很困惑了，当时为什么没有问题？当时为什么就把`src/main/resources`下的文件打包进来了？会不会和maven的版本，maven的插件版本等有关？

…（A FEW YEARS LATER）…

经过反反复复，反反复复的测试，**我！终于复现了当时的情景！！** 首先，运行`mvn clean`将maven构建的文件全部删除，然后在`pom.xml`中配置`resources`标签仅扫描`src/main/java`。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3ZjajEwMDk3ODQ4MTQ_size_16_color_FFFFFF_t_70 9]

随后，我们不运行maven命令进行打包，而直接选中一个测试类，直接点击运行一个测试用例

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3ZjajEwMDk3ODQ4MTQ_size_16_color_FFFFFF_t_70 10]

由于项目还未编译打包，此时会触发IDEA的自动构建

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3ZjajEwMDk3ODQ4MTQ_size_16_color_FFFFFF_t_70 11]

构建完毕后，我们查看`target`目录

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3ZjajEwMDk3ODQ4MTQ_size_16_color_FFFFFF_t_70 12]  
发现`src/main/java`中的XML文件没有被打包进来，而`src/main/resources`下的资源文件倒是被打包了进来。根据我合理的猜测，IDEA的自动构建没有使用`pom.xml`中`build`标签下的配置，默认只是编译了**源码目录**下的java文件，并打包了**资源目录**下的资源文件。而此时我如果仅仅运行`mvn package`命令，而不是`mvn clean package`。由于没有运行`mvn clean`，所以先前已经构建好的文件不会被删掉。于是`mvn package`执行完毕后，`src/main/java`下的XML文件也被添加了进来。

### 谜团解开 ###

至此，谜团解开。使用maven进行打包，若`pom.xml`中没有配置`resources`标签，则会采用默认策略，打包**资源目录**（`src/main/resources`）下的资源文件。若`pom.xml`中配置了`resources`标签，则完全以配置的为准。即，如果`pom.xml`中的`resources`标签只配置了扫描`src/main/java`，则只会扫描`src/main/java`，不会扫描`src/main/resources`，即使后者已经被标记为项目的资源目录。

先前的，仅仅配置`pom.xml`扫描`src/main/java`下的XML文件，而`src/main/resources`下的文件也打包了进来，这种情况，是因为一开始就进行过构建，`src/main/resources`目录下的文件已经被打包了进来，而后续的打包并没有执行`mvn clean`清除已有的文件。

所以，在使用mybatis的时候，mapper.xml文件，最好就统一放在`src/main/resources`资源目录下，这样就无需额外配置`pom.xml`。（其他资源文件也一样）。若实在需要把XML文件放在`src/main/java`源码目录下，那么配置`pom.xml`中的`resources`标签时，一定要记得加上`src/main/resources`，如下

<build>
            <resources>
                <resource>
                    <directory>src/main/java</directory>
                    <includes>
                        <include>**/*.xml</include>
                    </includes>
                </resource>
    
                <resource>
                    <directory>src/main/resources</directory>
                    <includes>
                        <include>**/*</include>
                    </includes>
                </resource>
            </resources>
    </build>

（完）

都看到这了，一定是个小可爱，这么可爱的你，会给我一个赞的对吧？☺️

[mybatis]: https://blog.csdn.net/vcj1009784814/article/details/106391982?spm=1001.2014.3001.5501
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3ZjajEwMDk3ODQ4MTQ_size_16_color_FFFFFF_t_70]: /images/20221022/6c836dabfd3f470ea2aa87abc9a45944.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3ZjajEwMDk3ODQ4MTQ_size_16_color_FFFFFF_t_70 1]: /images/20221022/14ac99e7790c45b9be2bdd7ae9896dd9.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3ZjajEwMDk3ODQ4MTQ_size_16_color_FFFFFF_t_70 2]: /images/20221022/bf69490c0bb84632ae2b4a6426766885.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3ZjajEwMDk3ODQ4MTQ_size_16_color_FFFFFF_t_70 3]: /images/20221022/aa25d8540260443294b68f2d1ce5a0c4.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3ZjajEwMDk3ODQ4MTQ_size_16_color_FFFFFF_t_70 4]: /images/20221022/f11f83d6396641aa88bdf1b635ab76fe.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3ZjajEwMDk3ODQ4MTQ_size_16_color_FFFFFF_t_70 5]: /images/20221022/8c1220ca54704745b1d2f9e5e1dfedc5.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3ZjajEwMDk3ODQ4MTQ_size_16_color_FFFFFF_t_70 6]: /images/20221022/a5e976d219984f14970b902af0d4e5ff.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3ZjajEwMDk3ODQ4MTQ_size_16_color_FFFFFF_t_70 7]: /images/20221022/7d64a2d6664f4f028a8e04014cbc367d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3ZjajEwMDk3ODQ4MTQ_size_16_color_FFFFFF_t_70 8]: /images/20221022/876bcd2e7abf4fedad4113622ebbfece.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3ZjajEwMDk3ODQ4MTQ_size_16_color_FFFFFF_t_70 9]: /images/20221022/3c0a8f17aa1249c4b19928f9fd2323e8.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3ZjajEwMDk3ODQ4MTQ_size_16_color_FFFFFF_t_70 10]: /images/20221022/62eb8be49e254803ad6dd2a3551c66e3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3ZjajEwMDk3ODQ4MTQ_size_16_color_FFFFFF_t_70 11]: /images/20221022/73166873c3e94d9eb707d76b3f7481a4.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3ZjajEwMDk3ODQ4MTQ_size_16_color_FFFFFF_t_70 12]: /images/20221022/6c6068030b464fac94bd4ce15bd4f732.png