mybatis 源码笔记(全局流程,初始化大纲)

源码入口

这是我从ssm项目中找的一份配置文件,如果你想问我为什么不用springboot,只能说是springboot自动包装的太好.无奈找不到入口

 <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <property name="dataSource" ref="dataSource"/>
        <property name="mapperLocations">
            <list>
                <value>classpath*:/mapper/*Mapper.xml
            
        
        
			
		
    
	
	
		
	
	
	
    
        
    
    
         
         
    

    
	
    
        
        
        
        
        
        
        
        
        
        
        
    	

从上面的配置中可以发现几个很关键的类,如下

1. 事务管理(DataSourceTransactionManager)
2. Api会话工厂(SqlSessionFactoryBean)
3. 数据源(DataSource)
4. Mapper扫描器(MapperScannerConfigurer)

其中实现的接口类如下

MapperScannerConfigurer

public class MapperScannerConfigurer implements BeanDefinitionRegistryPostProcessor, InitializingBean, ApplicationContextAware, BeanNameAware 

SqlSessionFactoryBean

public class SqlSessionFactoryBean implements FactoryBean<SqlSessionFactory>, InitializingBean, ApplicationListener<ApplicationEvent>

下面是我从spring源码中截的一张图,分别对应的实现类的执行顺序…不懂的同学建议后续看看spring源码,先脑海有个印象先执行 MapperScannerConfigurer#postProcessBeanDefinitionRegistry,再执行 SqlSessionFactoryBean#getObject

我从SqlSessionFactoryBean,MapperScannerConfigurer中分出了俩条初始化线路

• MapperScannerConfigurer扫描Mapper,并生成对应的代理类
• MapperFactoryBean 加载配置文件

我们先看 MapperScannerConfigurer

其中 if (this.processPropertyPlaceHolders) { processPropertyPlaceHolders(); }

代码注释解释
	BeanDefinitionRegistries会在应用启动的时候调用，并且会早于BeanFactoryPostProcessors的调用，这就意味着PropertiesResourceConfigurers还没有被加载所有对于属性文件的引用将会失效，为避免此种情况发生，此方法手动地找出定义的PropertyResourceConfigurers并进行调用以以保证对于属性的引用可以正常工作。
大白话解释
	 
 如果用${basePackage}表达式的话：
 加入
     此方法手动地找出定义的PropertyResourceConfigurers并进行调用以以保证对于属性的引用可以正常工作。
 （1）找到所有已经注册的PropertyResourceConfigurer类型的bean。
 （2）模拟Spring的环境来用处理器。这里通过使用呢new DefaultlistableBeanFactory()来模拟Spring中的环境（完成处理器的调用后便失效），
 将映射的bean，也就是MapperScannerConfigurer类型bean注册到环境中来进行后处理器的调用。

ClassPathMapperScanner

继承了ClassPathBeanDefinitionScanner,这个类是spring提供的组件扫描工具类,扫描的类会被spring注入到BeanDefinitionRegistry中,初始化组件的时候也会被注册到spring上下文中. springboot (AnnotationConfigServletWebServerApplicationContext)也使用了该类扫描组件

最终会被调用

/**
   * 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) {
    // 调用ClassPathBeanDefinitionScanner的doScan方法
    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 {
      // 遍历扫描的mapper,动态生成接口的代理类 MapperFactoryBean   
      for (BeanDefinitionHolder holder : beanDefinitions) {
        GenericBeanDefinition definition = (GenericBeanDefinition) holder.getBeanDefinition();

        if (logger.isDebugEnabled()) {
          logger.debug("Creating MapperFactoryBean with name '" + holder.getBeanName() 
              + "' and '" + definition.getBeanClassName() + "' mapperInterface");
        }

        // 为这个mapper接口设置 class
        // 设置代理实现类为 MapperFactoryBean
        definition.getPropertyValues().add("mapperInterface", definition.getBeanClassName());
        definition.setBeanClass(MapperFactoryBean.class);

        definition.getPropertyValues().add("addToConfig", this.addToConfig);

        boolean explicitFactoryUsed = false;
        if (StringUtils.hasText(this.sqlSessionFactoryBeanName)) {
          // MapperFactoryBean 添加引用,因为此时SqlSessionFactory未生成(SqlSessionFactory由SqlSessionFactoryBean生成,SqlSessionFactoryBean比ClassPathBeanDefinitionScanner晚执行),生成bean的时候会根据RuntimeBeanReference 生成对象引用
          definition.getPropertyValues().add("sqlSessionFactory", new RuntimeBeanReference(this.sqlSessionFactoryBeanName));
          explicitFactoryUsed = true;
        } else if (this.sqlSessionFactory != null) {
          definition.getPropertyValues().add("sqlSessionFactory", this.sqlSessionFactory);
          explicitFactoryUsed = true;
        }

        if (StringUtils.hasText(this.sqlSessionTemplateBeanName)) {
          if (explicitFactoryUsed) {
            logger.warn("Cannot use both: sqlSessionTemplate and sqlSessionFactory together. sqlSessionFactory is ignored.");
          }
          definition.getPropertyValues().add("sqlSessionTemplate", new RuntimeBeanReference(this.sqlSessionTemplateBeanName));
          explicitFactoryUsed = true;
        } else if (this.sqlSessionTemplate != null) {
          if (explicitFactoryUsed) {
            logger.warn("Cannot use both: sqlSessionTemplate and sqlSessionFactory together. sqlSessionFactory is ignored.");
          }
          definition.getPropertyValues().add("sqlSessionTemplate", this.sqlSessionTemplate);
          explicitFactoryUsed = true;
        }

        if (!explicitFactoryUsed) {
          if (logger.isDebugEnabled()) {
            logger.debug("Enabling autowire by type for MapperFactoryBean with name '" + holder.getBeanName() + "'.");
          }
          definition.setAutowireMode(AbstractBeanDefinition.AUTOWIRE_BY_TYPE);
        }
      }
    }

    return beanDefinitions;
  }

MapperFactoryBean

这是mybatis代理的核心类,通过实现FactoryBean来生成对应的mapper操作类

spring获取mapper具体方法如下

SqlSessionFactoryBean

实现了spring 提供的FactoryBean接口,因此具备了生成bean的能力,getObject方法会在这个目标bean初始化的时候执行,当前类的主要作用就是生成SqlSessionFactory

下面是我找的初始化流程,图来自 MyBatis源码分析-MyBatis初始化流程

SqlSessionFactoryBuilder相关代码：

public SqlSessionFactory build(InputStream inputStream) {
  return build(inputStream, null, null);
}
public SqlSessionFactory build(InputStream inputStream, String environment, Properties properties) {
  try {
    // 1. 创建XMLConfigBuilder对象解析XML配置
    XMLConfigBuilder parser = new XMLConfigBuilder(inputStream, environment, properties);
    // 2. 将XML配置解析成Configuration对象，通过Configuration对象创建SqlSessionFactory
    return build(parser.parse());
  } catch (Exception e) {
    throw ExceptionFactory.wrapException("Error building SqlSession.", e);
  } finally {
    ErrorContext.instance().reset();
    try {
    inputStream.close();
    } catch (IOException e) {
    // Intentionally ignore. Prefer previous error.
    }
  }
}
/**
 * 内部通过Configuration对象创建SqlSessionFactory，也可以通过Java API方式创建Configuration对象，
 * 然后调用该方法创建SqlSessionFactory
 */
public SqlSessionFactory build(Configuration config) {
  return new DefaultSqlSessionFactory(config);
}

核心API类架构SqlSessionFactory

Configuration是MyBatis中相当重要的一个类，可以这么说，如果理解了其中的所有参数的意义，不仅清楚地知道MyBatis提供的所有配置项，还理解了MyBatis的内部核心运行原理，当然要真正理解这些参数的意义及实现，还需要阅读完完整的MyBatis框架之后才能做到。

由上图可以看到，Configuration对象与DefaultSqlSessionFactory是1:1的关联关系，这也就意味着在一个DefaultSqlSessionFactory衍生出来的所有SqlSession作用域里，Configuration对象是全局唯一的。同时SqlSessionFactory提供了getConfiguration()接口来公开Configuration对象，因此开发者除了配置文件之外，还可以在程序里动态更改Configuration的属性项以达到动态调整的目的，但此时不仅要考虑到执行完reset，同时还要考虑在修改过程中会可能影响到其他SqlSession的执行。

大致流程可以总结为:

1. ClassPathMapperScanner 扫描mapper注入到spring容器中
2. ClassPathMapperScanner 动态生成接口代理类(MapperFactoryBean),通过definition.getPropertyValues().add(“sqlSessionFactory”, new RuntimeBeanReference(this.sqlSessionFactoryBeanName));注入此时还没生成的SqlSessionFactory
3. SqlSessionFactoryBean 的 getObject 方法 使用 SqlSessionFactoryBuilder 来初始化 SqlSessionFactory