mybatis（1）- Springboot中的规范使用

@Mapper与@MapperScan正确使用

结论

[auto-configuration package 路径] 默认是启动类包路径。
下文测试1中 @Mapper能正常启动是因为MybatisAutoConfiguration下的AutoConfiguredMapperScannerRegistrar来扫码启动类路径包下带@Mapper的对象。
尽量不要自动创建SqlSessionTemplate，除非有特殊需要将SqlSessionTemplate归于容器管理。
MapperFactoryBean先执行SqlSessionDaoSupport中的setSqlSessionFactory方法, 会新建一个SqlSessionTemplate; 但被随后执行的setSqlSessionTemplate方法注入的托管于容器的SqlSessionTemplate实例覆盖。

正确的使用方式有2种

@Mapper + @ImportAutoConfiguration(MybatisAutoConfiguration.AutoConfiguredMapperScannerRegistrar.class) + @SpringBootApplication(exclude = { MybatisAutoConfiguration.class })
@MapperScan({ "com.noob.giant.dao" }) + @SpringBootApplication(exclude = { MybatisAutoConfiguration.class })
（package的路径要尽量精确到DAO层。当然也可以在@MapperScan 配置 annotationClass 来指定扫描的注解类型或者 markerInterface 指定接口）

分析

MybatisAutoConfiguration 在装载时会生成SqlSessionTemplate对象托管于容器中，导致MapperFactoryBean中setSqlSessionFactory、setSqlSessionTemplate 先后执行。

引用javadoc对于 MybatisAutoConfiguration 的描述：
If {@link org.mybatis.spring.annotation.MapperScan} is used, or a configuration file is specified as a property, those will be considered, otherwise this auto-configuration will attempt to register mappers based on the interface definitions in or under the root auto-configuration package.

如果@MapperScan 或者特定的资源文件被加载，那就要慎重考虑了。此类会尝试注册auto-configuration package路径下定义的接口为mappers

而对于MybatisAutoConfiguration.AutoConfiguredMapperScannerRegistrar在执行过程中会扫描auto-configuration package路径下带@Mapper注解的类

再来比对下MapperScannerConfigurer源码、@MapperScan import的MapperScannerRegistrar的源码，发现与AutoConfiguredMapperScannerRegistrar都是创建了ClassPathMapperScanner并确定扫描路径！
详见：mybatis的MapperScan到底做了什么

测试1

不使用@MapperScan和@Mapper：

public interface DecisionAdjustApplyMapper {
    DecisionAdjustApply selectUnqiue(@Param("applyNo") String applyNo);
}


import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.data.redis.RedisAutoConfiguration;
import org.springframework.boot.autoconfigure.data.redis.RedisRepositoriesAutoConfiguration;
import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.cloud.netflix.feign.EnableFeignClients;
import org.springframework.context.annotation.EnableAspectJAutoProxy;
import org.springframework.context.annotation.ImportResource;
import org.springframework.scheduling.annotation.EnableAsync;
import org.springframework.transaction.annotation.EnableTransactionManagement;

@EnableDiscoveryClient
@EnableFeignClients
@EnableConfigurationProperties // 配合@ConfigurationProperties 合用
@EnableTransactionManagement(proxyTargetClass = true) // 启注解事务管理，等同于xml配置方式的 <tx:annotation-driven />
@EnableAsync //开启异步调用
@EnableAspectJAutoProxy //开启自定义切面
@ImportResource("classpath:dependence.xml")
@SpringBootApplication(exclude = {DataSourceAutoConfiguration.class, RedisAutoConfiguration.class, RedisRepositoriesAutoConfiguration.class})
//@MapperScan("com.noob.giant.dao")
public class GiantApplication {

    public static void main(String[] args) {
          //System.setProperty("DEPLOY_ENV", "test");
        SpringApplication.run(GiantApplication.class, args);
    }
}

结果: 抛出异常 , Mapper对象无法注入容器!

Description:
A component required a bean of type 'com.noob.giant.dao.DecisionAdjustApplyMapper' that could not be found.

Action:
Consider defining a bean of type 'com.noob.giant.dao.DecisionAdjustApplyMapper' in your configuration.

Caused by: org.springframework.beans.factory.NoSuchBeanDefinitionException: No qualifying bean of type 'com.noob.giant.dao.DecisionAdjustApplyMapper' available: expected at least 1 bean which qualifies as autowire candidate. Dependency annotations: {@javax.annotation.Resource(shareable=true, lookup=, name=, description=, authenticationType=CONTAINER, type=class java.lang.Object, mappedName=)}
	at org.springframework.beans.factory.support.DefaultListableBeanFactory.raiseNoMatchingBeanFound(DefaultListableBeanFactory.java:1493)
	at org.springframework.beans.factory.support.DefaultListableBeanFactory.doResolveDependency(DefaultListableBeanFactory.java:1104)
	at org.springframework.beans.factory.support.DefaultListableBeanFactory.resolveDependency(DefaultListableBeanFactory.java:1066)
	at org.springframework.context.annotation.CommonAnnotationBeanPostProcessor.autowireResource(CommonAnnotationBeanPostProcessor.java:518)
	at org.springframework.context.annotation.CommonAnnotationBeanPostProcessor.getResource(CommonAnnotationBeanPostProcessor.java:496)
	at org.springframework.context.annotation.CommonAnnotationBeanPostProcessor$ResourceElement.getResourceToInject(CommonAnnotationBeanPostProcessor.java:627)
	at org.springframework.beans.factory.annotation.InjectionMetadata$InjectedElement.inject(InjectionMetadata.java:169)
	at org.springframework.beans.factory.annotation.InjectionMetadata.inject(InjectionMetadata.java:88)
	at org.springframework.context.annotation.CommonAnnotationBeanPostProcessor.postProcessPropertyValues(CommonAnnotationBeanPostProcessor.java:318)
	... 54 common frames omitted

后续测试发现：单独在Mapper类上增加@Mapper 或在启动类上增加“@MapperScan("com.noob.giant.dao")” 都能启动注入成功。

SqlSessionTemplate 被处理了2次?

在对每一个Mapper对象进行beanWrapper过程中，创建MapperFactoryBean（extends SqlSessionDaoSupport）对象时，会先执行SqlSessionDaoSupport中的setSqlSessionFactory方法根据传入的SqlSessionFactory （测试例子中实际对象是DefaultSqlSessionFactory）创建了一个SqlSessionTemplate，而后再执行setSqlSessionTemplate方法又注入了一个SqlSessionTemplate来覆盖原有的！

debug发现：
在AbstractAutowireCapableBeanFactory.populateBean方法中

入参对象RootBeanDefinition的PropertyValues初始值正常：

处理后最终得到的PropertyValues对象中却含SqlSessionFactory 、SqlSessionTemplate ！

在测试中发现，MapperFactoryBean两方法中的SqlSessionTemplate 实例内容是大致一样（构造方式默认相同：new SqlSessionTemplate(sqlSessionFactory)）。各个不同Mapper通过setSqlSessionTemplate方法注入的SqlSessionTemplate 实例是同一个对象，且setSqlSessionFactory的入参SqlSessionFactory实例也是同一个对象。

所以推测： sqlSessionTemplate在另外的地方被初始化托管在Spring容器中，被当做自动注入的属性了。

测试2 - AutoConfiguredMapperScannerRegistrar

经查验发现：
在运行环境中引用的mybatis-spring-boot-autoconfigure.jar中有一个MybatisAutoConfiguration自动装载了sqlSessionTemplate托管于容器，且提供了扫描@Mapper的处理类AutoConfiguredMapperScannerRegistrar。

   <parent>
       <groupId>org.mybatis.spring.boot</groupId>
       <artifactId>mybatis-spring-boot</artifactId>
       <version>1.3.2</version>
   </parent>
   <artifactId>mybatis-spring-boot-autoconfigure</artifactId>
   <name>mybatis-spring-boot-autoconfigure</name>

与其他无此jar引用仍旧正常启动且只会执行setSqlSessionFactory方法的项目比对后，发现没有MybatisAutoConfiguration加载也能启动，但多了个配置：

<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer" >
       <property name="basePackage" value="com.noob.dao" />
       <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory" />
   </bean>

第一次

@Mapper + 启动类排除自动装载： @SpringBootApplication(exclude = { MybatisAutoConfiguration.class })

结果： 失败！无法正常注入Mapper对象，报错同上。

第二次

@Mapper + 启动类排除自动装载： @SpringBootApplication(exclude = { MybatisAutoConfiguration.class }) + 启动类增加自动装载@ImportAutoConfiguration(MybatisAutoConfiguration.AutoConfiguredMapperScannerRegistrar.class)

@ImportAutoConfiguration(MybatisAutoConfiguration.AutoConfiguredMapperScannerRegistrar.class)
@SpringBootApplication(exclude = { DataSourceAutoConfiguration.class, MybatisAutoConfiguration.class,
        RedisAutoConfiguration.class, RedisRepositoriesAutoConfiguration.class })
//@MapperScan({ "com.noob.giant"})
public class GiantApplication { ...

@ImportAutoConfiguration 改为 @Import 就没用了！失败在：AutoConfiguredMapperScannerRegistrar的registerBeanDefinitions时 AutoConfigurationPackages.get()获取不到auto-configuration package 的路径。

结果： 正常启动，且只执行了setSqlSessionFactory方法！！

debug发现：

在AbstractAutowireCapableBeanFactory.populateBean()中处理得到的最后PropertyValues中只有SqlSessionFactory

后续测试时增入自己显示声明@Bean SqlSessionTemplate，又出现了！

关键在于AbstractAutowireCapableBeanFactory的populateBean方法中执行autowireByType时对于resolveDependency结果是否为空的判定！

详细分析见：https://my.oschina.net/u/3434392/blog/3010046 的【反向验证】
MybatisAutoConfiguration 提供的 MapperScannerRegistrarNotFoundConfiguration 类自动加载的 AutoConfiguredMapperScannerRegistrar 获取到扫描mapper类的包路径。
(该地址与启动application类包路径一致！)

第三次

启动类增加@MapperScan({ "com.noob.giant.dao" }) + 启动排除自动装载： @SpringBootApplication(exclude = { MybatisAutoConfiguration.class })

@SpringBootApplication(exclude = { DataSourceAutoConfiguration.class,MybatisAutoConfiguration.class, RedisAutoConfiguration.class,RedisRepositoriesAutoConfiguration.class })
@MapperScan({ "com.noob.giant.dao", "com.noob.xmagic.dao" })
public class GiantApplication { .......

结果： 具体呈现和第二次一致！正常启动！！且创建MapperFactoryBean只执行了setSqlSessionFactory方法！！

测试3 - auto-configuration package 一定是启动类包路径

我们将启动的Application类移动到“com.noob.giant.hh”路径下：
（因为启动时默认扫描的是启动类包路径下的对象，所以本测试用例需要在启动Application类重新指定 @SpringBootApplication(scanBasePackages={"com.noob.giant"}，否则加载不到bean）

测试4 - 单独使用@MapperScan时，扫描包路径一定要精确到Dao层！

@MapperScan({ "com.noob.giant" })：

一个大范围包路径的话，在 ClassPathMapperScanner.doScan 时会把一些额外的接口也当作mapper。如果精确到Dao层就没有这个现象！

这是因为：

ClassPathBeanDefinitionScanner.doScan方法，在通过basePackage执行findCandidateComponens方法时使用了ClassPathMapperScanner的isCandidateComponent方法对返回结果集判定：但只是判定bean的定义描述是否是接口。所以导致doScan最终返回的BeanDefinitionHolder集合中含有很多不相干的接口信息。

  @Override
  protected boolean isCandidateComponent(AnnotatedBeanDefinition beanDefinition) {
    return beanDefinition.getMetadata().isInterface() && beanDefinition.getMetadata().isIndependent();
  }

来源：oschina

链接：https://my.oschina.net/u/3434392/blog/3009819

标签

Spring

Mybatis Spring Boot

Spring Boot

MyBatis