Mybatis中接口和對應的mapper文件位置配置深入剖析

首先要說明的問題是，Mybatis中接口和對應的mapper文件不一定要放在同一個包下，放在一起的目的是為了Mybatis進行自動掃描，並且要注意此時java接口的名稱和mapper文件的名稱要相同，否則會報異常，由於此時Mybatis會自動解析對應的接口和相應的配置文件，所以就不需要配置mapper文件的位置了。

1. 接口和文件在同一個包中

1.1 默認maven構建

如果在工程中使用了maven構建工具，那么就會出現一個問題：我們知道在典型的maven工程中，目錄結構有：src/main/java和src/main/resources，前者是用來存放java源代碼的，后者則是存放一些資源文件，比如配置文件等，在默認的情況下maven打包的時候，對於src/main/java目錄只打包源代碼，而不會打包其他文件。所以此時如果把對應的mapper文件放到src/main/java目錄下時，不會打包到最終的jar文件夾中，也不會輸出到target文件夾中，由於在進行單元測試的時候執行的是/target目錄下/test-classes下的代碼，所以在測試的時候也不會成功。

為了實現在maven默認環境下打包時，Mybatis的接口和mapper文件在同一包中，可以通過將接口文件放在src/main/java某個包中，而在src/main/resources目錄中建立同樣的包，這是一種約定優於配置的方式，這樣在maven打包的時候就會將src/main/java和src/main/resources相同包下的文件合並到同一包中。

在默認maven打包的環境下，不要將接口文件和mapper文件全部放到src/main/java，這樣也不會把mapper文件打包進去

簡要的過程如下（與如下的例子無關）：

- src/main/java
    - edu.zju.mapper
        - UserMapper.java
- src/main/resources
    - config.xml
    - edu.zju.mapper
        - UserMapper.xml

如上這種方式在maven打包之后的目錄如下：

- src/main/java
    - config.xml
    - edu.zju.mapper
        - UserMapper.java
        - UserMapper.xml

具體的例子如下：

 

在src/main/java和src/main/resources中相同的包名，相同的文件名，默認打包后的結構如下：

 

發現打包之后已經到同一個包下了。

而當你把接口和mapper文件全部放到src/main/java中同一包時，返回結果如下：

 

 

發現編譯打包之后並沒有mapper文件，所以此時不管是測試還是正式執行都會出錯！！

2.1 更改maven構建配置

如果不想將接口和mapper文件分別放到src/main/java和src/main/resources中，而是全部放到src/main/java，那么在構建的時候需要指定maven打包需要包括xml文件，具體配置如下：

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

這樣在打包的時候也會將mapper文件打包到/target文件夾中。

2. 接口和文件不在同一個包下

如果接口和mapper文件不在同一個包下，就不能進行自動掃描解析了，需要對接口和文件分別進行配置。

2.1 XML配置方式

2.1.1 不使用Spring

使用Mybatis的配置文件如下：

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
  PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
  "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
  <mappers>
    <!-- 掃描路徑下的mapper映射文件 -->
    <mapper resource="mappers/UserMapper.xml"/>
    <!-- 掃描包下的接口文件 -->
    <package name="edu.zju.bme.data.manage.mapper" />
  </mappers>
</configuration>

2.1.2 使用Spring

使用Spring的配置文件如下：

<beans xmlns="http://www.springframework.org/schema/beans"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:mybatis="http://mybatis.org/schema/mybatis-spring"
  xsi:schemaLocation="
  http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
  http://mybatis.org/schema/mybatis-spring http://mybatis.org/schema/mybatis-spring.xsd">
  <!-- 配置接口存儲的包，用來掃描mapper接口 -->
  <mybatis:scan base-package="edu.zju.bme.data.manage.mapper" />
  <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
    <!-- 配置mapper文件位置，掃描映射文件，可以使用Ant風格的路徑格式 -->
    <property name="mapperLocations" value="classpath*:mappers/**/*.xml" />
    // ...
  </bean>
</beans>