Mybatis中如何使用MapperScannerConfigurer自動掃描Mapper接口生成代理注入到Spring

這篇文章將為大家詳細講解有關Mybatis中如何使用MapperScannerConfigurer自動掃描Mapper接口生成代理注入到Spring，小編覺得挺實用的，因此分享給大家做個參考，希望大家閱讀完這篇文章后可以有所收獲。

前言

Mybatis MapperScannerConfigurer 自動掃描 將Mapper接口生成代理注入到Spring Mybatis在與Spring集成的時候可以配置 MapperFactoryBean來生成Mapper接口的代理。

例如：

<bean id="userMapper" class="org.mybatis.spring.mapper.MapperFactoryBean">
 <property name="mapperInterface" value="com.bijian.study.dao" />
 <property name="sqlSessionFactory" ref="sqlSessionFactory" />
</bean>

MapperFactoryBean創建的代理類實現了 UserMapper 接口,并且注入到應用程序中。 因為代理創建在運行時環境中(Runtime,譯者注) ,那么指定的映射器必須是一個接口,而 不是一個具體的實現類。

上面的配置有一個很大的缺點，就是系統有很多的配置文件時 全部需要手動編寫，所以上述的方式已經很用了。

沒有必要在 Spring 的 XML 配置文件中注冊所有的映射器。相反,你可以使用一個 MapperScannerConfigurer，它 將 會 查 找 類 路 徑 下 的 映 射 器 并 自 動 將 它 們 創 建 成 MapperFactoryBean。

要創建 MapperScannerConfigurer，可以在 Spring 的配置中添加如下代碼：

<bean id="userMapper" class="org.mybatis.spring.mapper.MapperFactoryBean">
 <property name="mapperInterface" value="com.bijian.study.dao" />
 <property name="sqlSessionFactory" ref="sqlSessionFactory" />
</bean>

basePackage 屬性是讓你為映射器接口文件設置基本的包路徑。 你可以使用分號或逗號 作為分隔符設置多于一個的包路徑。每個映射器將會在指定的包路徑中遞歸地被搜索到。

注意，沒 有 必 要 去 指 定 SqlSessionFactory 或 SqlSessionTemplate , 因 為 MapperScannerConfigurer 將會創建 MapperFactoryBean,之后自動裝配。但是,如果你使 用了一個 以上的 DataSource ,那 么自動 裝配可 能會失效 。這種 情況下 ,你可 以使用 sqlSessionFactoryBeanName 或 sqlSessionTemplateBeanName 屬性來設置正確的 bean 名 稱來使用。這就是它如何來配置的,注意 bean 的名稱是必須的,而不是 bean 的引用,因 此,value 屬性在這里替代通常的ref。

<property name="sqlSessionFactoryBeanName" value="sqlSessionFactory" />

整體配置如下所示：

<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
	<property name="dataSource" ref="dataSource" />
	<property name="mapperLocations" value="classpath*:**/*Dao*.xml"></property>
</bean>

<!-- dao配置 -->
<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
	<property name="basePackage" value="com.bijian.study.dao" />
	<property name="sqlSessionFactoryBeanName" value="sqlSessionFactory" />
</bean>

MapperScannerConfigurer 支 持 過 濾 由 指 定 的 創 建 接 口 或 注 解 創 建 映 射 器 。 annotationClass 屬性指定了要尋找的注解名稱。 markerInterface 屬性指定了要尋找的父 接口。如果兩者都被指定了，加入到接口中的映射器會匹配兩種標準。默認情況下，這兩個 屬性都是 null,所以在基包中給定的所有接口可以作為映射器加載。

被發現的映射器將會使用 Spring 對自動偵測組件(參考 Spring 手冊的 3.14.4)默認的命 名策略來命名。也就是說,如果沒有發現注解,它就會使用映射器的非大寫的非完全限定類 名。但是如果發現了@Component 或 JSR-330 的@Named 注解,它會獲取名稱。注意你可以 配 置 到 org.springframework.stereotype.Component , javax.inject.Named(如果你使用 JSE 6 的話)或你自己的注解(肯定是自我注解)中,這 樣注解將會用作生成器和名稱提供器。

接下來讓我們看一下MapperScannerConfigurer類的源碼 看看是如何自動掃描的。

/** 
 * {@inheritDoc} 
 * 
 * @since 1.0.2 
 */ 
@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.registerFilters(); 
 scanner.scan(StringUtils.tokenizeToStringArray(this.basePackage, ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS)); 
}

把Mapper接口轉換成MapperFactoryBean的代碼在scanner.scan方法里，讓我們跟蹤進去看一下。

/** 
 * Perform a scan within the specified base packages. 
 * @param basePackages the packages to check for annotated classes 
 * @return number of beans registered 
 */ 
public int scan(String... basePackages) { 
 int beanCountAtScanStart = this.registry.getBeanDefinitionCount(); 
 
 doScan(basePackages); 
 
 // Register annotation config processors, if necessary. 
 if (this.includeAnnotationConfig) { 
 AnnotationConfigUtils.registerAnnotationConfigProcessors(this.registry); 
 } 
 
 return (this.registry.getBeanDefinitionCount() - beanCountAtScanStart); 
}

/** 
 * Perform a scan within the specified base packages, 
 * returning the registered bean definitions. 
 * <p>This method does <i>not</i> register an annotation config processor 
 * but rather leaves this up to the caller. 
 * @param basePackages the packages to check for annotated classes 
 * @return set of beans registered if any for tooling registration purposes (never {@code null}) 
 */ 
protected Set<BeanDefinitionHolder> doScan(String... basePackages) { 
 Assert.notEmpty(basePackages, "At least one base package must be specified"); 
 Set<BeanDefinitionHolder> beanDefinitions = new LinkedHashSet<BeanDefinitionHolder>(); 
 for (String basePackage : basePackages) { 
 Set<BeanDefinition> candidates = findCandidateComponents(basePackage); 
 for (BeanDefinition candidate : candidates) { 
  ScopeMetadata scopeMetadata = this.scopeMetadataResolver.resolveScopeMetadata(candidate); 
  candidate.setScope(scopeMetadata.getScopeName()); 
  String beanName = this.beanNameGenerator.generateBeanName(candidate, this.registry); 
  if (candidate instanceof AbstractBeanDefinition) { 
  postProcessBeanDefinition((AbstractBeanDefinition) candidate, beanName); 
  } 
  if (candidate instanceof AnnotatedBeanDefinition) { 
  AnnotationConfigUtils.processCommonDefinitionAnnotations((AnnotatedBeanDefinition) candidate); 
  } 
  if (checkCandidate(beanName, candidate)) { 
  BeanDefinitionHolder definitionHolder = new BeanDefinitionHolder(candidate, beanName); 
  definitionHolder = AnnotationConfigUtils.applyScopedProxyMode(scopeMetadata, definitionHolder, this.registry); 
  beanDefinitions.add(definitionHolder); 
  registerBeanDefinition(definitionHolder, this.registry); 
  } 
 } 
 } 
 return beanDefinitions; 
}

關于“Mybatis中如何使用MapperScannerConfigurer自動掃描Mapper接口生成代理注入到Spring”這篇文章就分享到這里了，希望以上內容可以對大家有一定的幫助，使各位可以學到更多知識，如果覺得文章不錯，請把它分享出去讓更多的人看到。