从Springboot集成Mybatis看Mybatis到底是怎么集成到Spring中的

疑惑

我们知道Mybatis单独使用时，需要如下步骤：

@Autowired
    public SqlSessionFactory sqlSessionFactory;
    @Test
    public void testMybatis() {
        //步骤1 拿到数据库连接
        SqlSession sqlSession = sqlSessionFactory.openSession();
        //步骤2 获取接口的代理，也就是将sqlSession与接口包装成一个proxy对象
        BikeMapper mapper = sqlSession.getMapper(BikeMapper.class);
        //步骤3 通过代理调用指定方法，并返回结果
        Bike bike = mapper.selectByPrimaryKey(1L);
        System.out.println(bike);
    }

注释写的很清楚了，就不赘述了。
但是从springboot集成Mybatis时可以非常简单配置一些参数就可以了，而且使用时直接调用接口方法就可以完成上面的步骤。好奇的我就想知道到底spring做了哪些工作，使得我们不用获取sqlSession并且不用从sqlSession获取接口代理，也就是上面的1和2步。

揭秘

springboot集成Mybatis时，只需要引入对应的starter即可

<dependency>
                <groupId>org.mybatis.spring.boot</groupId>
                <artifactId>mybatis-spring-boot-starter</artifactId>
                <version>${mybatis-spring.version}</version>
            </dependency>

而使用JavaConfig配置集成Mybatis数据源时，可以使用一个注解来完成对Mybatis功能接口的检索

@Configuration
@MapperScan(basePackages = {"com.demo.test.mapper.master"}, sqlSessionFactoryRef = "masterSqlSessionFactory")
public class MasterDataBaseConfig {
    
    @Bean(name = "masterDataSource")
    @ConfigurationProperties(prefix = "spring.datasource.druid.master")
    public DataSource dataSource() {
        return DruidDataSourceBuilder.create().build();
    }

    @Bean(name = "masterTransactionManager")
    public DataSourceTransactionManager transactionManager(@Qualifier("masterDataSource") DataSource dataSource) {
        return new DataSourceTransactionManager(dataSource);
    }

    @Bean(name = "masterSqlSessionFactory")
    public SqlSessionFactory sqlSessionFactory(@Qualifier("masterDataSource") DataSource dataSource) throws Exception {
        SqlSessionFactoryBean factoryBean = new SqlSessionFactoryBean();
        factoryBean.setDataSource(dataSource);
        factoryBean.setMapperLocations(new PathMatchingResourcePatternResolver().getResources("classpath:mapper/master/*.xml"));
        factoryBean.setConfigLocation(new ClassPathResource("mybatis.xml"));
        factoryBean.setTypeAliasesPackage("com.demo.test.po");
        return factoryBean.getObject();
    }
}

通过代码来看，通过向spring容器注入sqlSessionFactory的Bean，让容器管理这个Mybatis中重要的类。除此之外还有个注解@MapperScan，这个注解指定了检索的目录和SqlSessionFactory类名，这里就是答案所在。

@MapperScan

这个注解除了上面提到的两个参数之外还包括了一个重要的参数

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@Import(MapperScannerRegistrar.class)
public @interface MapperScan {
  String[] basePackages() default {};
  String sqlSessionFactoryRef() default "";
  //mapper的工厂bean
  Class<? extends MapperFactoryBean> factoryBean() default MapperFactoryBean.class;
}

这里没有列举出所有参数，而factoryBean参数的默认MapperFactoryBean.class是我们关注的重点，下面还会提到。

检索过程

@MapperScan通过spring的@Import标签引入了实际检索接口的类MapperScannerRegistrar。@Import是Spring自动装配的基础，提供了向spring容器注入Bean的功能。但是mybatis提供的MapperScannerRegistrar类不只是将检索到的接口注入到spring容器这么简单，接着往下看。

源码很长，我这里只给出关键位置。

MapperScannerRegistrar.registerBeanDefinitions:在@Import被解析时会调用这个方法。里面创建一个检索对象ClassPathMapperScanner scanner = new ClassPathMapperScanner(registry);并对scanner进行参数赋值，最后调用scanner.doScan方法，我们跟到这里
ClassPathMapperScanner.doScan:方法一共两步，第一步是检索给定目录文件夹中类并转成BeanDefinition，第二步是对BeanDefinition进行处理(关键)。

  @Override
  public Set<BeanDefinitionHolder> doScan(String... basePackages) {
    Set<BeanDefinitionHolder> beanDefinitions = super.doScan(basePackages);

    if (beanDefinitions.isEmpty()) {
      logger.warn("No MyBatis mapper was found in '" + Arrays.toString(basePackages) + "' package. Please check your configuration.");
    } else {
      processBeanDefinitions(beanDefinitions);
    }
    return beanDefinitions;
  }

ClassPathMapperScanner.processBeanDefinitions：给出缩略代码

private void processBeanDefinitions(Set<BeanDefinitionHolder> beanDefinitions) {
    GenericBeanDefinition definition;
    for (BeanDefinitionHolder holder : beanDefinitions) {
      definition = (GenericBeanDefinition) holder.getBeanDefinition();
      definition.getConstructorArgumentValues().addGenericArgumentValue(definition.getBeanClassName()); // issue #59
      //Bean的Class指定为工厂类
      definition.setBeanClass(this.mapperFactoryBean.getClass());
      //自动装配sqlSessionFactory
      definition.getPropertyValues().add("sqlSessionFactory", this.sqlSessionFactory);
      definition.setAutowireMode(AbstractBeanDefinition.AUTOWIRE_BY_TYPE);
    }
  }

这里就真正的学到了，还有这种操作：

使用代码的方式将一个普通的spring的beanDefinition通过setBeanClass的方式变成一个工厂Bean。
还添加了属性sqlSessionFactory，并在实例化时通过自动注入到bean中。

既然将bean转成的工厂bean，那么就要看mapperFactoryBean，也就是上面提到的@MapperScan中MapperFactoryBean.class这个类。

MapperFactoryBean
上一步提到了将Bean的class指定为MapperFactoryBean，并且添加了参数sqlSessionFactory，在实例化时需要自动注入sqlSessionFactory。那么 MapperFactoryBean中就会有setSqlSessionFactory方法。我们在MapperFactoryBean的父类SqlSessionDaoSupport中发现了：

  public void setSqlSessionFactory(SqlSessionFactory sqlSessionFactory) {
    if (!this.externalSqlSession) {
      this.sqlSession = new SqlSessionTemplate(sqlSessionFactory);
    }
  }

new SqlSessionTemplate方法最终调用代码(中间忽略了一些调用过程)：

  public SqlSessionTemplate(SqlSessionFactory sqlSessionFactory, ExecutorType executorType,
      PersistenceExceptionTranslator exceptionTranslator) {
    this.sqlSessionFactory = sqlSessionFactory;
    this.executorType = executorType;
    this.exceptionTranslator = exceptionTranslator;
    this.sqlSessionProxy = (SqlSession) newProxyInstance(
        SqlSessionFactory.class.getClassLoader(),
        new Class[] { SqlSession.class },
        new SqlSessionInterceptor());
  }

这里就可以发现，在工厂类实例化时，通过注入SqlSessionFactory时，通过SqlSessionFactory创建了sqlSession。这就揭开疑惑中第一步的获取SqlSession的过程。

既然是工厂Bean，那在spring实例化时就一定会调用getObject方法来创建真正的Bean。我们来揭开最终的谜底。

  @Override
  public T getObject() throws Exception {
    return getSqlSession().getMapper(this.mapperInterface);
  }

getSqlSession()是上一步创建的SqlSession。而getMapper就是我们苦苦寻找的疑惑中第二步的获取Mapper代理过程。

总结

从疑惑到揭秘，这里过程有点长，但是还算清晰的解释了Spring继承MyBatis之后便捷之处：在项目启动时，检索Mybatis业务接口并注入到Spring时，就已经将接口在Bean初始化时转换成最终的接口代理类了。

有问题的地方，可以在留言中指出，希望对看到的人有帮助。