Spring集成第三方组件-Mybatis

一、mybatis简介

Mybaits是java语言一个ORM框架。官网介绍如下：

MyBatis 是一款优秀的持久层框架，它支持自定义 SQL、存储过程以及高级映射。MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO（Plain Old Java Objects，普通老式 Java 对象）为数据库中的记录。

mybatis把SQL抽离到了xml中（此处不考虑使用注解声明SQL方式，因为违背了SQL可配置的原则，不推崇），如下所示：

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
  PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
  "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="org.mybatis.example.BlogMapper">
  <select id="selectBlog" resultType="Blog">
    select * from Blog where id = #{id}
  </select>
</mapper>

使用时，有几种不同的方式：

1）直接通过XML中的命名空间直接通过

SqlSession session = sqlSessionFactory.openSession()
Blog blog = (Blog) session.selectOne("org.mybatis.example.BlogMapper.selectBlog", 101);

2）定义一个与之相对应的java接口作为DAO层使用。

package org.mybatis.example;
public interface BlogMapper {
  Blog selectBlog(int id);
}

使用时通过接口执行操作：

SqlSession session = sqlSessionFactory.openSession()
BlogMapper mapper = session.getMapper(BlogMapper.class);
Blog blog = mapper.selectBlog(101);

目前第二种方式比较常用，更符合ORM的使用习惯。

二、Spring通过MapperScan注解集成Mybatis

spring使用可以通过配置文件和注解来集成mybatis，此处只探究注解方式的实现机制。

1. MapperScan注解，设置扫描包

MapperScan使用如下，只需要在某个Bean上加伤@MapperScan即可：

@SpringBootApplication  
@MapperScan("pers.kivi.demo.mapper")  
public class App {  
    public static void main(String[] args) {  
       SpringApplication.run(App.class, args);  
    }  
}

观察MapperScan注解发现其通过Import注解引入了MapperScannerRegistrar：

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@Import(MapperScannerRegistrar.class)
public @interface MapperScan {
    ...
}

2.@Import的解析时机

在org.springframework.context.support.AbstractApplicationContext#invokeBeanFactoryPostProcessors调用时，会调用ConfigurationClassPostProcessor这个内置的BeanFactoryPostProcessor对传入的配置类进行级联的解析，把符合条件的类解析为BeanDefinition注册到beanDefinitionMap中。

其中就包含对@Import注解的解析，ConfigurationClassPostProcessor会调用其registerBeanDefinitions方法注册bean定义。

3. MapperScannerRegistrar

该接口是ImportBeanDefinitionRegistrar的子类，职责是负责注册BeanDefinition到BeanFactory。

public class MapperScannerRegistrar implements ImportBeanDefinitionRegistrar, ResourceLoaderAware {
  private ResourceLoader resourceLoader;

  @Override
  public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
    AnnotationAttributes annoAttrs = AnnotationAttributes.fromMap(importingClassMetadata.getAnnotationAttributes(MapperScan.class.getName()));
    ClassPathMapperScanner scanner = new ClassPathMapperScanner(registry);
    
    /**
    * 设置属性至scanner，忽略此处逻辑
    */
    
    
    List<String> basePackages = new ArrayList<String>();
    for (String pkg : annoAttrs.getStringArray("value")) {
      if (StringUtils.hasText(pkg)) {
        basePackages.add(pkg);
      }
    }
    for (String pkg : annoAttrs.getStringArray("basePackages")) {
      if (StringUtils.hasText(pkg)) {
        basePackages.add(pkg);
      }
    }
    for (Class<?> clazz : annoAttrs.getClassArray("basePackageClasses")) {
      basePackages.add(ClassUtils.getPackageName(clazz));
    }
        scanner.doScan(StringUtils.toStringArray(basePackages));
   }
}

从源码可以发现，MapperScannerRegistrar使用ClassPathMapperScanner来扫描传入的package，解析并注册BeanDefinition。

4.ClassPathBeanDefinitionScanner

ClassPathBeanDefinitionScanner继承了ClassPathBeanDefinitionScanner来扫描BeanDefinition，但是为了把Mybatis声明的Mapper接口扫描为BeanDefinition，其重写了isCandidateComponent方法。

然后把扫描到的Bean定义的class通过processBeanDefinitions方法设置为MapperFactoryBeans。

package org.mybatis.spring.mapper;
public class ClassPathMapperScanner extends ClassPathBeanDefinitionScanner {
    /**
   * Calls the parent search that will search and register all the candidates.
   * Then the registered objects are post processed to set them as
   * MapperFactoryBeans
   */
  @Override
  public Set<BeanDefinitionHolder> doScan(String... basePackages) {
    /**
    * 调用父类doScan方法进行扫描并注册BeanDefinition
    */
    Set<BeanDefinitionHolder> beanDefinitions = super.doScan(basePackages);
    
    /**
    * 把已经注册的Mybatis的Mapper接口的BeanDefinition的class修改为MapperFactoryBeans
    */
        processBeanDefinitions(beanDefinitions);
    return beanDefinitions;
  }
  
  private void processBeanDefinitions(Set<BeanDefinitionHolder> beanDefinitions) {
    GenericBeanDefinition definition;
    for (BeanDefinitionHolder holder : beanDefinitions) {
      definition = (GenericBeanDefinition) holder.getBeanDefinition();

      // the mapper interface is the original class of the bean
      // but, the actual class of the bean is MapperFactoryBean
      definition.getConstructorArgumentValues().addGenericArgumentValue(definition.getBeanClassName());
      definition.setBeanClass(this.mapperFactoryBean.getClass());
            
      /**
      *设置其他BeanDefinition属性
      */
    }
  }
  
  @Override
  protected boolean isCandidateComponent(AnnotatedBeanDefinition beanDefinition) {
    return beanDefinition.getMetadata().isInterface() && beanDefinition.getMetadata().isIndependent();
  }  
}

5. MapperFactoryBeans

不出意外MapperFactoryBean肯定是一个FactoryBean，负责对接口生成对应的代理实例。

public class MapperFactoryBean<T> extends SqlSessionDaoSupport implements FactoryBean<T> {
    ... 
    
  @Override
  public T getObject() throws Exception {
    return getSqlSession().getMapper(this.mapperInterface);
  }
  
  ...
}

三、Spring创建Bean时机

Spring会在org.springframework.context.support.AbstractApplicationContext#finishBeanFactoryInitialization方法中对非BeanFactoryPostProcessor，ApplicationListener类型等的普通Bean进行初始化。如果发现某BeanDefinitino的类型是FactoryBean，则会继续调用getObject方法创建具体实例。

至此完成Mybatis的Mapper集成进Spring的Context管理。

四、总结

Spring内部提供了太多的扩展点供增强使用，例如:

1）BeanFactoryPostProcessor可以用来增强BeanDefinition的加载；

2）BeanPostProcessor可以用来增强Bean创建过程；

3）Aware可以使Bean织入Spring的一些Bean；

4）EventListener/ApplicationEventMulticaster可以用来实现广播自己的事件；

5）Xml配置文件直至自定义schema的NameSpaceHandler，来进行BeanDefinition注册；

等等。

我们实际开发的时候多了解里面的机制，就可以做到更低耦合，更优雅的功能扩展和实现。