Mybatis spring and mybatis and mybatis-springboot-starter

這篇博文主要涉及到的是mybatis是怎么集成到spring已經(jīng)spring boot的，有關(guān)mybatis的用法及其自身的源碼

設(shè)計(jì)，我會(huì)到開另一個(gè)文章進(jìn)行分析

mybatis可以通過 mybatis-spring 和mybatis-springboot-starter這兩個(gè)模塊分別集成到純spring應(yīng)用或者是

springboot應(yīng)用，其實(shí)兩者都是有異曲同工的感覺的。

首先梳理下mybatis的重要元素，這部分后期會(huì)詳細(xì)的分析

mybatis最重要的三大件分別是SqlSessionFactory， SqlSession， Mapper，這三個(gè)也是我們?cè)诩僲ybatis應(yīng)用

開發(fā)中涉及到最多的三個(gè)組建。它們也有著各自的生命周期。

當(dāng)mybatis需要集成到spring的時(shí)候，首先就是要通過spring 的方式管理這些組建，同時(shí)，支持mybatis datasource

和transaction的托管，由spring全權(quán)維護(hù)。

這篇文章著重介紹的是spring 如何識(shí)別并且注冊(cè)mybatis的mappers。

這里的mappers注冊(cè)識(shí)別，主要包含了手動(dòng)單體注冊(cè)和掃描注冊(cè)。

手動(dòng)組冊(cè)

通過 MapperFactoryBean 進(jìn)行mapper的注冊(cè)。

<bean id="userMapper" class="org.mybatis.spring.mapper.MapperFactoryBean">
  <property name="mapperInterface" value="org.mybatis.spring.sample.mapper.UserMapper" />
  <property name="sqlSessionFactory" ref="sqlSessionFactory" />
</bean>

這里的核心思想，就是通過依賴的SqlSessionFactory得到對(duì)應(yīng)的configuration，將對(duì)應(yīng)的UserMapper注冊(cè)到mybatis中。應(yīng)為這里的的MapperFactoryBean是一個(gè)spring里的factoryBean，它負(fù)責(zé)生成實(shí)際的Mapper，提供使用方注入使用

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

自動(dòng)掃描mapper

如果一個(gè)應(yīng)用中設(shè)計(jì)到的mapper數(shù)量非常的多，單一手動(dòng)的注冊(cè)所有的mapper會(huì)變得特別瑣碎，于是就用了自動(dòng)mapper掃描注冊(cè)

這里mybatis使用到了spring里的一個(gè)很有意思的類，它可以完成額外的BeanDefinition的注冊(cè)。

這個(gè)類就是ClassPathBeanDefinitionScanner.java

于是，mybatis就繼承擴(kuò)充了這個(gè)類，叫做ClassPathMapperScanner，可以完成所有的Mapper的掃描注冊(cè)。每掃描一個(gè)符合條件的mapper接口，就生成一個(gè)MapperFactoryBean，用來完成這個(gè)Mapper的實(shí)例化。

Note

在mybatis里，如果你恰巧使用xml進(jìn)行查詢語句的編寫（雖然mybatis后期支持annotion，但是還是xml親切），只要你把xml mapper文件放到和interface 文件同樣的包里，就可以完成自動(dòng)注冊(cè)

由于ClassPathMapperScanner相對(duì)來說比較底層，實(shí)際操作的過程中，我們主要會(huì)用兩個(gè)類

@MapperScan annotion and MapperScannerConfigurer 來真正的完成mapper注冊(cè)

@MapperScan

這是一個(gè)很有意思的annotaion類，它利用了MapperScannerRegistrar來調(diào)用ClassPathMapperScanner，最終完成mapper的注冊(cè)。

 public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {

    AnnotationAttributes annoAttrs = AnnotationAttributes.fromMap(importingClassMetadata.getAnnotationAttributes(MapperScan.class.getName()));
    ClassPathMapperScanner scanner = new ClassPathMapperScanner(registry);

    // this check is needed in Spring 3.1
    if (resourceLoader != null) {
      scanner.setResourceLoader(resourceLoader);
    }

    Class<? extends Annotation> annotationClass = annoAttrs.getClass("annotationClass");
    if (!Annotation.class.equals(annotationClass)) {
      scanner.setAnnotationClass(annotationClass);
    }

    Class<?> markerInterface = annoAttrs.getClass("markerInterface");
    if (!Class.class.equals(markerInterface)) {
      scanner.setMarkerInterface(markerInterface);
    }

    Class<? extends BeanNameGenerator> generatorClass = annoAttrs.getClass("nameGenerator");
    if (!BeanNameGenerator.class.equals(generatorClass)) {
      scanner.setBeanNameGenerator(BeanUtils.instantiateClass(generatorClass));
    }

    Class<? extends MapperFactoryBean> mapperFactoryBeanClass = annoAttrs.getClass("factoryBean");
    if (!MapperFactoryBean.class.equals(mapperFactoryBeanClass)) {
      scanner.setMapperFactoryBean(BeanUtils.instantiateClass(mapperFactoryBeanClass));
    }

    scanner.setSqlSessionTemplateBeanName(annoAttrs.getString("sqlSessionTemplateRef"));
    scanner.setSqlSessionFactoryBeanName(annoAttrs.getString("sqlSessionFactoryRef"));

    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.registerFilters();
    scanner.doScan(StringUtils.toStringArray(basePackages));

MapperScannerConfigurer

這個(gè)類是曾經(jīng)的mapper標(biāo)準(zhǔn)掃描方案，他是一個(gè) BeanDefinitionRegistryPostProcessor 的子類，利用 spring里BeanDefinitionRegistryPostProcessor可以操作并且添加新的BeanDefinition的特性，可以完成對(duì)與mapper的注冊(cè)發(fā)現(xiàn)。

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

mybatis-springboot-starter

終于，到了最有意思的springboot 和mybatis的繼承，這個(gè)主要要?dú)w功于 MybatisAutoConfiguration.class

這里充分利用了spring boot的autoconfiguration ，

如果沒有MapperFactoryBean 存在，就會(huì)利用它本身的內(nèi)部靜態(tài)類 AutoConfiguredMapperScannerRegistrar 來完成mapper的注冊(cè)

mapper interfaes has to be annotated with annotation @Mapper

其中，他內(nèi)部也是使用了 ClassPathMapperScanner 來完成mapper的注冊(cè)。

  @Configuration
  @Import({ AutoConfiguredMapperScannerRegistrar.class })
  @ConditionalOnMissingBean(MapperFactoryBean.class)
  public static class MapperScannerRegistrarNotFoundConfiguration {



  public static class AutoConfiguredMapperScannerRegistrar
      implements BeanFactoryAware, ImportBeanDefinitionRegistrar, ResourceLoaderAware {

    private BeanFactory beanFactory;

    private ResourceLoader resourceLoader;

    @Override
    public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {

      logger.debug("Searching for mappers annotated with @Mapper");

      ClassPathMapperScanner scanner = new ClassPathMapperScanner(registry);

      try {
        if (this.resourceLoader != null) {
          scanner.setResourceLoader(this.resourceLoader);
        }

        List<String> packages = AutoConfigurationPackages.get(this.beanFactory);
        if (logger.isDebugEnabled()) {
          for (String pkg : packages) {
            logger.debug("Using auto-configuration base package '{}'", pkg);
          }
        }

        scanner.setAnnotationClass(Mapper.class);
        scanner.registerFilters();
        scanner.doScan(StringUtils.toStringArray(packages));
      } catch (IllegalStateException ex) {
        logger.debug("Could not determine auto-configuration package, automatic mapper scanning disabled.", ex);
      }
    }

SqlSessionTemplate

SqlSessionTemplate 實(shí)現(xiàn)了 SqlSession,內(nèi)部也包含了一個(gè)sqlSession的代理，通過手段，可以完成sqlsession對(duì)于spring transaction的綁定，再也不需要手動(dòng)開啟關(guān)閉session，也不用自己維護(hù)transaction

 this.sqlSessionProxy = (SqlSession) newProxyInstance(
        SqlSessionFactory.class.getClassLoader(),
        new Class[] { SqlSession.class },
        new SqlSessionInterceptor());

同時(shí) SqlSessionTemplate 可以將mybatis的 PersistenceExceptions 轉(zhuǎn)化為統(tǒng)一的DataAccessExceptions

上面只是簡單的介紹了mybatis和spring的融合，mybatis雖然每天都在用，spring也是，但是兩者內(nèi)部的源代碼，還是很值得推敲和學(xué)習(xí)。這里只是介紹了皮毛，以備后期自我學(xué)習(xí)。