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 class="org.mybatis.spring.mapper.MapperScannerConfigurer"> <property name="basePackage" value="com.bijian.study.dao" /> </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; }
相关推荐
本文将详细介绍如何将Spring和MyBatis进行整合,并采用Mapper代理自动扫描的方式实现,同时还会提及到JUnit测试。 首先,我们需要在项目中引入Spring和MyBatis的相关依赖。通常,我们会使用Maven或Gradle作为构建...
4. 集成Mapper:在SpringBoot中,需要将生成的Mapper接口注入到Service层,以便进行数据操作。SpringBoot通过MapperScannerConfigurer或@MapperScan注解扫描并自动注册Mapper接口。 5. 使用自动生成的组件:现在,...
在MyBatis框架中,MapperScannerConfigurer是一个非常重要的工具类,它能够帮助我们自动扫描指定包下的Mapper接口,并将其注册到SqlSessionFactory中,极大地简化了配置工作。本文将深入探讨MapperScannerConfigurer...
同时,对于Mapper接口,我们需要定义一个MapperScannerConfigurer,扫描指定包下的Mapper接口,让Spring自动创建对应的MapperFactoryBean。 2. **基于注解的整合:** 使用Java配置代替XML配置,通过@Configuration...
3. **MapperFactoryBean**: 对于每一个Mapper接口,MyBatis-Spring都会创建一个对应的MapperFactoryBean,它会根据接口生成代理对象,这个代理对象能够调用MyBatis的底层方法执行SQL。通过这种方式,开发者可以直接...
- **MapperScannerConfigurer**:Spring配置类,用于扫描指定包下的所有@Mapper接口,自动创建MapperFactoryBean实例。 - **MapperFactoryBean**:Spring Bean工厂,处理Mapper接口与XML配置的映射,使得可以在...
3. **MapperFactoryBean**: 这个Bean用于将MyBatis的Mapper接口实例化,并自动注入到Spring容器中。MapperFactoryBean会根据Mapper接口生成对应的MapperProxy,从而实现方法调用到SQL执行的映射。 4. **...
4. 配置Mapper:将Mapper接口和对应的XML配置文件关联起来,Spring通过`MapperScannerConfigurer`扫描指定包下的Mapper接口,生成对应的MapperFactoryBean。 5. 事务配置:在Spring的配置文件中,配置...
此外,还需要配置MapperScannerConfigurer,扫描包含Mapper接口的包,这样Spring可以自动创建Mapper接口的实现类。 3. **Mapper接口与XML映射文件**:Mybatis的Mapper接口定义了数据库操作的方法,每个方法对应XML...
- **MapperScannerConfigurer**:这个类用于扫描指定包下的Mapper接口,将其注册到Spring的Bean工厂中,方便Spring进行依赖注入。 - **MapperFactoryBean**:它是Spring的FactoryBean,用于创建Mapper接口的代理...
- **Mapper接口未找到**:检查Mapper接口是否已正确扫描并注册到Spring容器中,以及Mapper接口与XML配置文件的namespace是否一致。 - **SQL语句错误**:确保SQL语句的编写无误,特别注意动态SQL的使用,避免语法...
- **配置Mapper接口**:定义Mapper接口,并在Spring配置文件中配置对应的MapperScannerConfigurer,自动扫描Mapper接口并生成代理对象。 - **编写Mapper XML文件**:在资源目录下创建Mapper XML文件,编写SQL语句...
- **Mapper配置**:在Spring中,我们需要定义MapperScannerConfigurer来扫描所有的Mapper接口,并将它们注入到Spring容器中。 - **Mapper接口与XML配置**:每个Mapper接口对应一个XML配置文件,里面包含具体的SQL...
3. **配置 MapperScannerConfigurer**:扫描指定包下的 Mapper 接口,使其成为 Spring 的 Bean。 4. **Service 层的配置**:在 Service 类中,通过 @Autowired 注解注入 Mapper 接口。 5. **事务配置**:配置 ...
DataSource配置数据库连接信息,SqlSessionFactoryBean用于生成SqlSessionFactory,MapperScannerConfigurer则扫描指定包下所有的Mapper接口。 ```xml <bean id="dataSource" class="org.springframework.jdbc....
1. **继承Mapper接口**:MyBatis的`org.mybatis.spring.mapper.MapperScannerConfigurer`类允许我们在Spring配置中扫描特定基类的Mapper接口。如果我们创建一个基类Mapper接口,比如`BaseMapper`,并在此接口中定义...
3. **配置Mybatis**:设置数据源、事务管理器、SqlSessionFactory以及MapperScannerConfigurer,让Spring能够自动扫描并管理Mapper接口。 4. **创建Mapper接口**:定义Mapper接口,每个方法对应一个SQL查询。例如:...
6. **整合到项目**:将生成的代码引入到你的项目中,通过Mybatis的MapperScannerConfigurer或@MapperScan注解,使其能够被Spring容器扫描并注入到服务层。 7. **测试**:完成上述步骤后,进行单元测试以确保自动...
3. 配置MapperScannerConfigurer:通过这个配置,Spring会自动扫描指定包下的所有Mapper接口,并将它们注册为Bean。 4. 使用SqlSessionTemplate和Mapper:在Service层,我们可以注入SqlSessionTemplate进行数据库...
Spring通过MapperScannerConfigurer自动扫描Mapper接口并生成代理对象,使得可以在Service层直接调用Mapper的方法。 **6. 混合使用JPA和MyBatis** 在同一个项目中使用JPA和MyBatis,可以根据需求选择合适的数据访问...