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
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>
2.2 Java 配置方式
2.2.1 不使用Spring
Configuration configuration = new Configuration();
configuration.setMapUnderscoreToCamelCase(true);
configuration.setLazyLoadingEnabled(true);
configuration.setCacheEnabled(false);
// 掃描該包下的介面和mapper檔案
configuration.addMappers("edu.zju.bme.data.manage.mapper");
使用這種方法,只能將介面和mapper檔案放到同一個包下,並且同名,相比其他方法具有侷限性。
2.2.2 使用Spring
// 配置類
@Configuration(value = "manageConfig")
@Import(value = {DataSourceConfig.class})
// 掃描介面類,這個配置只能掃描該包下的介面,不能掃描mapper檔案
@MapperScan("edu.zju.bme.data.manage.mapper")
public class ManageConfig {
@Autowired
private DataSourceConfig dataSourceConfig;
@Bean(name = "manageSessionBean")
public SqlSessionFactoryBean sqlSessionFactoryBean() throws IOException{
SqlSessionFactoryBean factoryBean = new SqlSessionFactoryBean();
factoryBean.setDataSource(dataSourceConfig.manageDataSource());
Configuration configuration = new Configuration();
// 掃描對應的mapper檔案
factoryBean.setMapperLocations(new Resource[]{new ClassPathResource("UserMapper.xml")});
factoryBean.setConfiguration(configuration);
return factoryBean;
}
}
上面總結了4種配置方式,包括使用Spring以及不使用Spring的環境下,但是要注意以上的配置方式並不是唯一的,還有其他方法,如配置org.mybatis.spring.mapper.MapperScannerConfigurer
,這裡只是選擇了相對來說較為簡單的方式。
相關文章: