MyBatis中Mapper的注入問題詳解
在 SpringBoot 體系中，MyBatis 對 Mapper 的注入常見的方式我知道的有 2 種：
1、@MapperScan
MapperScan 類是 mybatis-spring 包里面的。
通過在啟動類上使用 @MapperScan，然后通過 basePackages 屬性指定 Mapper 文件所在的目錄來進行掃描裝載，默認情況下指定目錄下的所有.java文件都會被當做 Mapper 來加載處理。
@MapperScan(basePackages = "com.test.springboot.mapper")
@ServletComponentScan(basePackages = "com.test.springboot.filters")
@SpringBootApplication
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
可以看到，在 MapperScan 注解上有使用了 @Import(MapperScannerRegistrar.class) ，也就是把MapperScannerRegistrar 當做配置類注入 Spring 容器。
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@Import(MapperScannerRegistrar.class)
@Repeatable(MapperScans.class)
public @interface MapperScan {}
MapperScannerRegistrar 類是一個 ImportBeanDefinitionRegistrar 的實現(xiàn)，會在創(chuàng)建注入 Spring 容器后，被 Spring 主動觸發(fā)。其重載的方法主要是創(chuàng)建并注冊了一個 MapperScannerConfigurer 類型的 registry，這個 registry 主要就是去指定的 basePackages目錄掃描指定的文件，并將其裝載成 BeanDefinition 注入 Spring 容器。
public class MapperScannerRegistrar implements ImportBeanDefinitionRegistrar, ResourceLoaderAware {}
@Override
public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
AnnotationAttributes mapperScanAttrs = AnnotationAttributes
.fromMap(importingClassMetadata.getAnnotationAttributes(MapperScan.class.getName()));
if (mapperScanAttrs != null) {
registerBeanDefinitions(importingClassMetadata, mapperScanAttrs, registry,
generateBaseBeanName(importingClassMetadata, 0));
}
}
void registerBeanDefinitions(AnnotationMetadata annoMeta, AnnotationAttributes annoAttrs,
BeanDefinitionRegistry registry, String beanName) {
BeanDefinitionBuilder builder = BeanDefinitionBuilder.genericBeanDefinition(MapperScannerConfigurer.class);
builder.addPropertyValue("processPropertyPlaceHolders", true);
Class<? extends Annotation> annotationClass = annoAttrs.getClass("annotationClass");
if (!Annotation.class.equals(annotationClass)) {
builder.addPropertyValue("annotationClass", annotationClass);
}
// ...
}
下面是MapperScannerConfigurer 的主要實現(xiàn)，其主要依賴于 ClassPathMapperScanner 來實現(xiàn)掃面，在 MapperScan 指定了 basePackages 的情況下，它只會掃描這個指定目錄，否則可能就是掃描整個 classpath 了（就類似 SpringBoot 的完整掃描）。
@Override
public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) {
if (this.processPropertyPlaceHolders) {
processPropertyPlaceHolders();
}
ClassPathMapperScanner scanner = new ClassPathMapperScanner(registry);
scanner.setAddToConfig(this.addToConfig);
scanner.setAnnotationClass(this.annotationClass);
scanner.setMarkerInterface(this.markerInterface);
scanner.setSqlSessionFactory(this.sqlSessionFactory);
scanner.setSqlSessionTemplate(this.sqlSessionTemplate);
scanner.setSqlSessionFactoryBeanName(this.sqlSessionFactoryBeanName);
scanner.setSqlSessionTemplateBeanName(this.sqlSessionTemplateBeanName);
scanner.setResourceLoader(this.applicationContext);
scanner.setBeanNameGenerator(this.nameGenerator);
scanner.setMapperFactoryBeanClass(this.mapperFactoryBeanClass);
if (StringUtils.hasText(lazyInitialization)) {
scanner.setLazyInitialization(Boolean.valueOf(lazyInitialization));
}
if (StringUtils.hasText(defaultScope)) {
scanner.setDefaultScope(defaultScope);
}
scanner.registerFilters();
scanner.scan(
StringUtils.tokenizeToStringArray(this.basePackage, ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS));
}
在 ClassPathMapperScanner 的實現(xiàn)中，我們可以看到他會把掃描到的目標類（比如用 @Mapper 注解的類 xxxMapper.java）的 BeanDefinition 的 beanClass 設置為 MapperFactoryBean，后續(xù)根據(jù) BeanDefinition 創(chuàng)建的 Bean 也就是 MapperFactoryBean 的類型了。因為MapperFactoryBean 是一個工廠類，那么在 SpringBoot 要對 xxxMapper 實例化的時候，它會判斷到 xxxMapper 對應的 Bean 是一個工廠類，然后會去調用 它的 getObject 方法創(chuàng)建 xxxMapper.java 的實例（當然這里肯定是個代理類）。
private Class<? extends MapperFactoryBean> mapperFactoryBeanClass = MapperFactoryBean.class;
public void setMapperFactoryBeanClass(Class<? extends MapperFactoryBean> mapperFactoryBeanClass) {
this.mapperFactoryBeanClass = mapperFactoryBeanClass == null ? MapperFactoryBean.class : mapperFactoryBeanClass;
}
/**
* Calls the parent search that will search and register all the candidates. Then the registered objects are post
* processed to set them as MapperFactoryBeans
*/
@Override
public Set<BeanDefinitionHolder> doScan(String... basePackages) {
Set<BeanDefinitionHolder> beanDefinitions = super.doScan(basePackages);
if (beanDefinitions.isEmpty()) {
LOGGER.warn(() -> "No MyBatis mapper was found in '" + Arrays.toString(basePackages)
+ "' package. Please check your configuration.");
} else {
processBeanDefinitions(beanDefinitions);
}
return beanDefinitions;
}
private void processBeanDefinitions(Set<BeanDefinitionHolder> beanDefinitions) {
AbstractBeanDefinition definition;
BeanDefinitionRegistry registry = getRegistry();
for (BeanDefinitionHolder holder : beanDefinitions) {
definition = (AbstractBeanDefinition) holder.getBeanDefinition();
// ... String beanClassName = definition.getBeanClassName();
definition.setBeanClass(this.mapperFactoryBeanClass);
definition.getPropertyValues().add("addToConfig", this.addToConfig);
// Attribute for MockitoPostProcessor
// https://github.com/mybatis/spring-boot-starter/issues/475
definition.setAttribute(FACTORY_BEAN_OBJECT_TYPE, beanClassName);
// ...if (ConfigurableBeanFactory.SCOPE_SINGLETON.equals(definition.getScope()) && defaultScope != null) {
definition.setScope(defaultScope);
}
if (!definition.isSingleton()) {
BeanDefinitionHolder proxyHolder = ScopedProxyUtils.createScopedProxy(holder, registry, true);
if (registry.containsBeanDefinition(proxyHolder.getBeanName())) {
registry.removeBeanDefinition(proxyHolder.getBeanName());
}
registry.registerBeanDefinition(proxyHolder.getBeanName(), proxyHolder.getBeanDefinition());
}
}
}
@Override
public T getObject() throws Exception {
return getSqlSession().getMapper(this.mapperInterface);
}
getObject 方法內部是先獲取它的 SqlSessionTemplate 實例，然后根據(jù) mapperInterface（這個是 xxxMapper.java 的全限定名）去獲取 xxxMapper 對應的 MapperProxy 實例，然后對 xxxMapper 類的方法調用都會因為代理而一步步轉到 MapperProxy -> SqlSessionTemplate -> sqlSessionProxy（一個 SqlSession 的代理實例）上去執(zhí)行。
2、@Mapper
Mapper 類是 mybatis 包里面的。
單純只在類上加 @Mapper 的注解肯定是沒用的，這里我們還需要另外一個官方項目mybatis-spring-boot-autoconfigure 的協(xié)助了（這是個自動配置的項目，因此需要 SpringBoot 的支持，換一句話說就是項目還要另外再加入 Spring 官方的 spring-boot-configuration-processor 依賴），這樣可以在只加了 @Mapper 注解的情況下讓 Mapper文件順利的被掃描和注入。
為了依賴使用的方便與統(tǒng)一，可以直接使用mybatis-spring-boot-starter依賴
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>${mybatis-spring.version}</version>
</dependency>
我們可以在mybatis-spring-boot-autoconfigure 依賴的 META-INF 目錄下找到 spring.factories 的文件，這個是 SpringBoot 主動來掃描需要進行自動配置注入的目標文件。這里面可以看到后面的主角 MybatisAutoConfiguration 類，這個類加載了 Mybatis 的配置文件，聲明依賴了一些 Bean等，然后也能找到它又通過 @Import 主動注入了一個叫AutoConfiguredMapperScannerRegistrar 的類。
# Auto Configure org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ org.mybatis.spring.boot.autoconfigure.MybatisLanguageDriverAutoConfiguration,\ org.mybatis.spring.boot.autoconfigure.MybatisAutoConfiguration
@org.springframework.context.annotation.Configuration
@ConditionalOnClass({ SqlSessionFactory.class, SqlSessionFactoryBean.class })
@ConditionalOnSingleCandidate(DataSource.class)
@EnableConfigurationProperties(MybatisProperties.class)
@AutoConfigureAfter({ DataSourceAutoConfiguration.class, MybatisLanguageDriverAutoConfiguration.class })
public class MybatisAutoConfiguration implements InitializingBean { // ...
@org.springframework.context.annotation.Configuration
@Import(AutoConfiguredMapperScannerRegistrar.class)
@ConditionalOnMissingBean({ MapperFactoryBean.class, MapperScannerConfigurer.class })
public static class MapperScannerRegistrarNotFoundConfiguration implements InitializingBean {
@Override
public void afterPropertiesSet() {
logger.debug(
"Not found configuration for registering mapper bean using @MapperScan, MapperFactoryBean and MapperScannerConfigurer.");
}
} // ...
}
注入的這個AutoConfiguredMapperScannerRegistrar 和前文的MapperScannerRegistrar有點類似，是一個掃描類的注冊器。它在這里注冊的也是MapperScannerConfigurer， 不同的是這里明確指定掃描的是帶 Mapper 注解的文件，然后這里掃描的的 basePackage 是它自動獲取的，實際就是啟動類所在目錄以及子目錄。后面的掃描過程也就和方法一的后面是一樣的了。
List<String> packages = AutoConfigurationPackages.get(this.beanFactory);
// ...BeanDefinitionBuilder builder = BeanDefinitionBuilder.genericBeanDefinition(MapperScannerConfigurer.class);
builder.addPropertyValue("processPropertyPlaceHolders", true);
builder.addPropertyValue("annotationClass", Mapper.class);
builder.addPropertyValue("basePackage", StringUtils.collectionToCommaDelimitedString(packages));
MyBtatis 團隊貌似更加推崇使用 @Mapper 的方式，因為他們在 AutoConfiguredMapperScannerRegistrar 的注釋里面這么寫道：這個方法會和 SpringBoot 一樣，掃描的是同一個基礎 pacakge。如果你想獲得更多能力，那么你可以顯式的使用 MapperScan 注解，但是 Mapper 注解的方式能使類型映射器正常的工作，開箱即用，就像是在使用 Spring Data JPA 庫一樣。
/**
* This will just scan the same base package as Spring Boot does. If you want more power, you can explicitly use
* {@link org.mybatis.spring.annotation.MapperScan} but this will get typed mappers working correctly, out-of-the-box,
* similar to using Spring Data JPA repositories.
*/
參考文章：
關于MyBatis的@Mapper和@MapperScan注解的一點思考
MapperFactoryBean和MapperScannerConfigurer的作用和區(qū)別
到此這篇關于MyBatis中Mapper的注入的文章就介紹到這了,更多相關MyBatis Mapper注入內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
相關文章
這篇文章主要給大家介紹了關于springboot默認的5種加載路徑,文中通過示例代碼介紹的非常詳細,對大家學習或者使用springboot具有一定的參考學習價值,需要的朋友可以參考下2022-05-05
MybatisX 是一款基于 IDEA 的快速開發(fā)插件，方便在使用mybatis以及mybatis-plus開始時簡化繁瑣的重復操作，提高開發(fā)速率。這篇文章主要介紹了MybatisX 快速開發(fā)插件,需要的朋友可以參考下2021-10-10
深入探究一下Java中不同的線程間數(shù)據(jù)通信方式
這篇文章主要來和大家一起深入探究一下Java中不同的線程間數(shù)據(jù)通信方式，文中的示例代碼講解詳細，具有一定的借鑒價值，需要的可以參考一下2023-04-04
這篇文章主要介紹了Java多線程之Park和Unpark原理,需文中有非常詳細的代碼示例,對正在學習java的小伙伴們有非常好的幫助,要的朋友可以參考下2021-04-04
Springboot實現(xiàn)郵箱驗證碼注冊與修改密碼及登錄功能詳解流程
驗證碼作為一種自然人的機器人的判別工具，被廣泛的用于各種防止程序做自動化的場景中。傳統(tǒng)的字符型驗證安全性已經名存實亡的情況下，各種新型的驗證碼如雨后春筍般涌現(xiàn)，今天給大家分享一篇SpringBoot實現(xiàn)滑塊驗證碼2022-11-11
SpringBoot各種事務操作實戰(zhàn)(自動回滾、手動回滾、部分回滾）
本文主要介紹了SpringBoot各種事務操作實戰(zhàn),包含自動回滾、手動回滾、部分回滾這三種,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧2024-05-05
在開發(fā)過程中,總會遇到idea運行內存不足,所以本文小編給大家介紹了修改idea運行內存大小的兩種方法,文中通過圖文給大家講解的非常詳細,需要的朋友可以參考下2023-12-12
java~springboot~ibatis數(shù)組in查詢的實現(xiàn)方法
這篇文章主要介紹了java~springboot~ibatis數(shù)組in查詢的實現(xiàn)方法,需要的朋友可以參考下2018-09-09
Java8的另一大亮點Stream,它與java.io包里的InputStream和OutputStream是完全不同的概念,下面這篇文章主要給大家介紹了關于Java8中Stream詳細使用方法的相關資料,需要的朋友可以參考下2022-06-06
Spring?Boot?集成并開發(fā)?Sa-token示例詳解
Sa-token是一款高可用的權限認證框架，他帶我們用最簡化的配置完成用?spring?security?需要進行大量配置的才能完成的工作，這篇文章主要介紹了Spring?Boot?集成并開發(fā)?Sa-token,需要的朋友可以參考下2023-06-06