Maven 的配置文件路径读取方法

在使用 XML 的配置方式来构建 Mybatis 的核心类 SqlSessionFactory 时，遇到了配置文件路径总是写不对的问题。事后看其实就是没有好好看文档，一直在盲人摸象。

下面时读取 XML 配置文件的代码：

var inputSteam = Resources.getResourceAsStream("config/mybatis.xml");
var sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputSteam);

一开始我是将配置文件放在 src/main/java/com/imxfly/config/mybatis.xml 中，然后读取路径写成：com/imxfly/config/mybatis.xml ，但是提示 java.io.IOException: Could not find resource com/imxfly/config/mybatis.xml。

所以关键是这里的配置文件路径如何填写，我们知道读取的路径并不是按照当前开发时候的目录结构来的，而是编译后在项目 target 目录下以 classes 目录为 classpath（即类的根目录）去读取的。

假设我们把配置文件放在 src/main/java/com/imxfly/config 目录下，那么使用 maven compile 编译后去查看 target 目录你会发现找不到这个配置文件，这是因为 Maven 编译的时候默认只读取 src/main/java 目录下的 .java 文件然后编译成 .class 文件，所以你在 target 目录下是找不到我们的配置文件的，怎么解决呢？

推荐的做法是把这些 XML 配置文件放在 src/main/resources 目录下。

在官方文档（点击查看）中清楚的描述了这一行为，其中有一句话：

Within artifact producing source directories (ie. main and test), there is one directory for the language java (under which the normal package hierarchy exists), and one for resources (the structure which is copied to the target classpath given the default resource definition).

对于 resources 目录，其目录结构会完整的直接拷贝到 target classpath 中，假如我们有如下 src 的目录结构：

.
├── main
│  ├── java
│  │  └── com
│  │    └── imxfly
│  │      └── App.java
│  └── resources
│    └── config
│      └── mybatis.xml
└── test
  └── java
    └── com
      └── imxfly
        └── AppTest.java

那么编译完后的 target 目录结构就是：

.
├── classes
  ├── com
  │  └── imxfly
  │    └── App.class
  └── config
    └── mybatis.xml

所以我们在代码中读取配置文件的路径就是：

var inputSteam = Resources.getResourceAsStream("config/mybatis.xml");

因为默认情况下，Maven 会在 src/main/resources 去寻找项目的资源文件。

但是如果我们的项目结构不好修改，配置文件就在 src/main/java/com/imxfly/config/mybatis.xml 怎么办？

此时我们就需要在 Maven 配置文件 pom.xml 中去告诉 Maven 我们的资源文件放在了哪里：

<project>
 ...
 <build>
  ...
  <resources>
   <resource>
    <directory>src/main/java/com/imxfly/config</directory>
   </resource>
   <resource>
    <directory>src/main/java/com/imxfly/config2</directory>
   </resource>
   <resource>
    <directory>src/main/java/com/imxfly/config3</directory>
   </resource>
  </resources>
  ...
 </build>
 ...
</project>

编译时 Maven 就会把这些目录下的文件结构完整的拷贝到 target 目录下（就像上面完整拷贝 resources 目录一样），所以此时我们的读取路径为：

var inputSteam = Resources.getResourceAsStream("mybatis.xml");

参考资料：

https://maven.apache.org/plugins/maven-resources-plugin/examples/resource-directory.html
https://maven.apache.org/guides/introduction/introduction-to-the-standard-directory-layout.html