首页 > 开发 > Java > 正文

Mybatis MapperScannerConfigurer自动扫描Mapper接口生成代理注入到Spring的方法

2024-07-14 08:43:51
字体:
来源:转载
供稿:网友

前言

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; } 

总结

以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,谢谢大家对VeVb武林网的支持。


注:相关教程知识阅读请移步到JAVA教程频道。
发表评论 共有条评论
用户名: 密码:
验证码: 匿名发表