天天看點

Mybatis中接口和對應的mapper檔案位置配置詳解

中接口和對應的mapper檔案位置配置詳解

今天遇到一個問題是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檔案打包進去

Mybatis中接口和對應的mapper檔案位置配置詳解

在<code>src/main/java</code>和<code>src/main/resources</code>中相同的包名,相同的檔案名,預設打包後的結構如下:

Mybatis中接口和對應的mapper檔案位置配置詳解

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

而當你把接口和mapper檔案全部放到<code>src/main/java</code>中同一包時,如下:

Mybatis中接口和對應的mapper檔案位置配置詳解

打包之後的檔案如下:

Mybatis中接口和對應的mapper檔案位置配置詳解

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

如果不想将接口和mapper檔案分别放到<code>src/main/java</code>和<code>src/main/resources</code>中,而是全部放到<code>src/main/java</code>,那麼在建構的時候需要指定maven打包需要包括xml檔案,具體配置如下:

<b>[java]</b> view plain copy

&lt;span style="font-size:14px;"&gt;&lt;build&gt;

    &lt;resources&gt;

        &lt;resource&gt;

            &lt;directory&gt;src/main/java&lt;/directory&gt;

            &lt;includes&gt;

                &lt;include&gt;**/*.xml&lt;/include&gt;

            &lt;/includes&gt;

            &lt;filtering&gt;false&lt;/filtering&gt;

        &lt;/resource&gt;

    &lt;/resources&gt;

&lt;/build&gt;&lt;/span&gt;

這樣在打包的時候也會将mapper檔案打包到/target檔案夾中。

2:接口和檔案不在同一個包下

如果接口和mapper檔案不在同一個包下,就不能進行自動掃描解析了,需要對接口和檔案分别進行配置。

2.1 XML配置方式

2.1.1 不使用Spring

使用Mybatis的配置檔案如下:

&lt;span style="font-size:14px;"&gt;&lt;?xml version="1.0" encoding="UTF-8" ?&gt;

&lt;!DOCTYPE configuration

  PUBLIC "-//mybatis.org//DTD Config 3.0//EN"

  "http://mybatis.org/dtd/mybatis-3-config.dtd"&gt;

&lt;configuration&gt;

  &lt;mappers&gt;

    &lt;!-- 掃描路徑下的mapper映射檔案 --&gt;

    &lt;mapper resource="mappers/UserMapper.xml"/&gt;

    &lt;!-- 掃描包下的接口檔案 --&gt;

    &lt;package name="edu.zju.bme.data.manage.mapper" /&gt;

  &lt;/mappers&gt;

&lt;/configuration&gt;&lt;/span&gt;

2.1.2 使用Spring

使用spring的配置檔案如下:

&lt;span style="font-size:14px;"&gt;&lt;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"&gt;

  &lt;!-- 配置接口存儲的包,用來掃描mapper接口 --&gt;

  &lt;mybatis:scan base-package="edu.zju.bme.data.manage.mapper" /&gt;

  &lt;bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean"&gt;

    &lt;!-- 配置mapper檔案位置,掃描映射檔案,可以使用Ant風格的路徑格式 --&gt;

    &lt;property name="mapperLocations" value="classpath*:mappers/**/*.xml" /&gt;

    // ...

  &lt;/bean&gt;

&lt;/beans&gt;&lt;/span&gt;