1. 程式人生 > >Mybatis中接口和對應的mapper文件位置配置詳解

Mybatis中接口和對應的mapper文件位置配置詳解

文件名 存儲 prope ocl user enc directory CA https

Mybatis中接口和對應的mapper文件位置配置詳解

原鏈接為:https://blog.csdn.net/fanfanzk1314/article/details/71480954

今天遇到一個問題是mybatis中接口和對應的mapper文件位置不同,而引起的操作也會不同,在網上找了好久最終找到了方法,這裏就簡單的解析一下:

我們知道在典型的maven工程中,目錄結構有:src/main/java和src/main/resources,前者是用來存放java源代碼的,後者則是存放一些資源文件,比如配置文件等.
Mybatis中接口和對應的mapper文件不一定要放在同一個包下,如果放在一起
的目的是為了Mybatis進行自動掃描,並且要註意此時Java接口的名稱和mapper文件的名稱要相同,否則會報異常,由於此時Mybatis會自動解析對應的接口和相應的配置文件,所以就不需要配置mapper文件的位置了。
1:接口和文件放在同一個包中如下:
在默認的情況下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/javasrc/main/resources中相同的包名,相同的文件名,默認打包後的結構如下:

技術分享圖片

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

而當你把接口和mapper文件全部放到src/main/java中同一包時,如下:

技術分享圖片

打包之後的文件如下:

技術分享圖片

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

更改maven構建配置

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

[java] view plain copy
  1. <span style="font-size:14px;"><build>
  2. <resources>
  3. <resource>
  4. <directory>src/main/java</directory>
  5. <includes>
  6. <include>**/*.xml</include>
  7. </includes>
  8. <filtering>false</filtering>
  9. </resource>
  10. </resources>
  11. </build></span>
這樣在打包的時候也會將mapper文件打包到/target文件夾中。

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

如果接口和mapper文件不在同一個包下,就不能進行自動掃描解析了,需要對接口和文件分別進行配置。
2.1 XML配置方式
2.1.1 不使用Spring
使用Mybatis的配置文件如下:

[java] view plain copy
  1. <span style="font-size:14px;"><?xml version="1.0" encoding="UTF-8" ?>
  2. <!DOCTYPE configuration
  3. PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
  4. "http://mybatis.org/dtd/mybatis-3-config.dtd">
  5. <configuration>
  6. <mappers>
  7. <!-- 掃描路徑下的mapper映射文件 -->
  8. <mapper resource="mappers/UserMapper.xml"/>
  9. <!-- 掃描包下的接口文件 -->
  10. <package name="edu.zju.bme.data.manage.mapper" />
  11. </mappers>
  12. </configuration></span>
2.1.2 使用Spring
使用spring的配置文件如下:

[java] view plain copy
  1. <span style="font-size:14px;"><beans xmlns="http://www.springframework.org/schema/beans"
  2. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3. xmlns:mybatis="http://mybatis.org/schema/mybatis-spring"
  4. xsi:schemaLocation="
  5. http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
  6. http://mybatis.org/schema/mybatis-spring http://mybatis.org/schema/mybatis-spring.xsd">
  7. <!-- 配置接口存儲的包,用來掃描mapper接口 -->
  8. <mybatis:scan base-package="edu.zju.bme.data.manage.mapper" />
  9. <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
  10. <!-- 配置mapper文件位置,掃描映射文件,可以使用Ant風格的路徑格式 -->
  11. <property name="mapperLocations" value="classpath*:mappers/**/*.xml" />
  12. // ...
  13. </bean>
  14. </beans></span>

Mybatis中接口和對應的mapper文件位置配置詳解