这篇文章主要给大家介绍了关于Mybatis MapperScannerConfigurer自动扫描将Mapper接口生成代理注入到Spring的相关资料，文中通过示例代码介绍的非常详细，需要的朋友可以参考下
前言
Mybatis MapperScannerConfigurer 自动扫描 将Mapper接口生成代理注入到Spring Mybatis在与Spring集成的时候可以配置 Mapperfactorybean来生成Mapper接口的代理。
例如：
Mapperfactorybean创建的代理类实现了 UserMapper 接口,并且注入到应用程序中。 因为代理创建在运行时环境中(Runtime,译者注) ,那么指定的映射器必须是一个接口,而 不是一个具体的实现类。
上面的配置有一个很大的缺点，就是系统有很多的配置文件时 全部需要手动编写，所以上述的方式已经很用了。
没有必要在 Spring 的 XML 配置文件中注册所有的映射器。相反,你可以使用一个 MapperScannerConfigurer，它 将 会 查 找 类 路 径 下 的 映 射 器 并 自 动 将 它 们 创 建 成 Mapperfactorybean。
要创建 MapperScannerConfigurer，可以在 Spring 的配置中添加如下代码：
basePackage 属性是让你为映射器接口文件设置基本的包路径。 你可以使用分号或逗号 作为分隔符设置多于一个的包路径。每个映射器将会在指定的包路径中递归地被搜索到。
注意，没 有 必 要 去 指 定 sqlSessionFactory 或 sqlSessionTemplate , 因 为 MapperScannerConfigurer 将会创建 Mapperfactorybean,之后自动装配。但是,如果你使 用了一个 以上的 DataSource ,那 么自动 装配可 能会失效 。这种 情况下 ,你可 以使用 sqlSessionfactorybeanName 或 sqlSessionTemplateBeanName 属性来设置正确的 bean 名 称来使用。这就是它如何来配置的,注意 bean 的名称是必须的,而不是 bean 的引用,因 此,value 属性在这里替代通常的ref。
整体配置如下所示：
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. * This method does not 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 doScan(String... basePackages) { Assert.notEmpty(basePackages, "At least one base package must be specified"); Set beanDeFinitions = new LinkedHashSet(); for (String basePackage : basePackages) { Set 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; }
总结
