Mybatis-Spring源码分析（二）：SqlSessionFactoryBean的设计与实现

逃离我推掉我的手 2022-03-15 09:26 264阅读 0赞

### 概述 ###

*  mybatis-spring为了实现spring对mybatis的整合，即将mybatis的相关组件作为spring的IOC容器的bean来管理，使用了spring的FactoryBean接口来对mybatis的相关组件进行包装。spring的IOC容器在启动加载时，如果发现某个bean实现了FactoryBean接口，则会调用该bean的getObject方法，获取实际的bean对象注册到IOC容器，其中FactoryBean接口提供了getObject方法的声明，从而统一spring的IOC容器的行为。
 *  SqlSessionFactory作为mybatis的启动组件，在mybatis-spring中提供了SqlSessionFactoryBean来进行包装，所以在spring项目中整合mybatis，首先需要在spring的配置，如XML配置文件applicationContext.xml中，配置SqlSessionFactoryBean来引入SqlSessionFactory，即在spring项目启动时能加载并创建SqlSessionFactory对象，然后注册到spring的IOC容器中，从而可以直接在应用代码中注入使用或者作为属性，注入到mybatis的其他组件对应的bean对象。在applicationContext.xml的配置如下：
    
        <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
           	<property name="dataSource" ref="dataSource" />
           	<property name="mapperLocations" value="classpath:mybatis/mapper/**/*.xml" />
           	<property name="configLocation" value="classpath:mybatis/mybitas-config.xml" />
        </bean>

### 接口设计与实现 ###

*  SqlSessionFactory的接口设计如下：实现了spring提供的FactoryBean，InitializingBean和ApplicationListener这三个接口，在内部封装了mybatis的相关组件作为内部属性，如mybatisConfig.xml配置资源文件引用，mapper.xml配置资源文件引用，以及SqlSessionFactoryBuilder构造器和SqlSessionFactory引用。
    
        // 解析mybatisConfig.xml文件和mapper.xml，设置数据源和所使用的事务管理机制，将这些封装到Configuration对象
        // 使用Configuration对象作为构造参数，创建SqlSessionFactory对象，其中SqlSessionFactory为单例bean
        public class SqlSessionFactoryBean implements FactoryBean<SqlSessionFactory>, InitializingBean, ApplicationListener<ApplicationEvent> { 
        
          private static final Logger LOGGER = LoggerFactory.getLogger(SqlSessionFactoryBean.class);
        
          // mybatis配置mybatisConfig.xml的资源文件
          private Resource configLocation;
        
          private Configuration configuration;
        
          // mapper.xml的资源文件
          private Resource[] mapperLocations;
        
          // 数据源
          private DataSource dataSource;
        
          // 事务管理，mybatis接入spring的一个重要原因也是可以直接使用spring提供的事务管理
          private TransactionFactory transactionFactory;
        
          private Properties configurationProperties;
        
          // mybatis的SqlSessionFactoryBuidler和SqlSessionFactory
          private SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
        
          private SqlSessionFactory sqlSessionFactory;
          
          ...
          
          // 实现FactoryBean的getObject方法
          @Override
          public SqlSessionFactory getObject() throws Exception { 
          
              ...
              
          }
          
          // 实现InitializingBean的
          @Override
          public void afterPropertiesSet() throws Exception { 
          
            ...
            
          }
          // 为单例
          public boolean isSingleton() { 
            return true;
          }
          
        }
 *  其中重点关注FactoryBean，InitializingBean这两个接口，spring的IOC容器在加载创建SqlSessionFactoryBean的bean对象实例时，会调用InitializingBean的afterPropertiesSet方法进行对该bean对象进行相关初始化处理。

#### InitializingBean的afterPropertiesSet方法定义 ####

*  如下为spring的BeanFactory在创建bean对象的核心逻辑：具体在AbstractAutowireCapableBeanFactory定义，在initializeBean方法中调用InitializingBean的afterPropertiesSet，而在前一步操作populateBean中，以及将该bean对象实例的属性设值好了，InitializingBean的afterPropertiesSet进行一些后置处理。
    
        // bean对象实例创建的核心实现方法
        protected Object doCreateBean(final String beanName, final RootBeanDefinition mbd, final @Nullable Object[] args)
        		throws BeanCreationException { 
        
        	// 使用构造函数或者工厂方法来创建bean对象实例
        	// Instantiate the bean.
        	BeanWrapper instanceWrapper = null;
        	if (mbd.isSingleton()) { 
        		instanceWrapper = this.factoryBeanInstanceCache.remove(beanName);
        	}
        	if (instanceWrapper == null) { 
        		instanceWrapper = createBeanInstance(beanName, mbd, args);
        	}
        	
        	...
        
        	// 初始化bean对象实例，包括属性赋值，初始化方法，BeanPostProcessor的执行
        	// Initialize the bean instance.
        	Object exposedObject = bean;
        	try { 
        
        		// 1. InstantiationAwareBeanPostProcessor执行:
        		// (1). 调用InstantiationAwareBeanPostProcessor的postProcessAfterInstantiation,
        		// (2). 调用InstantiationAwareBeanPostProcessor的postProcessProperties和postProcessPropertyValues
        		// 2. bean对象的属性赋值
        		populateBean(beanName, mbd, instanceWrapper);
        
        		// 1. Aware接口的方法调用
        		// 2. BeanPostProcess执行：调用BeanPostProcessor的postProcessBeforeInitialization
        		// 3. 调用init-method：首先InitializingBean的afterPropertiesSet，然后应用配置的init-method
        		// 4. BeanPostProcess执行：调用BeanPostProcessor的postProcessAfterInitialization
        		exposedObject = initializeBean(beanName, exposedObject, mbd);
        	}
        	
        	...
        
        	// Register bean as disposable.
        	try { 
        		registerDisposableBeanIfNecessary(beanName, bean, mbd);
        	}
        	catch (BeanDefinitionValidationException ex) { 
        		throw new BeanCreationException(
        				mbd.getResourceDescription(), beanName, "Invalid destruction signature", ex);
        	}
        
        	return exposedObject;
        }
 *  SqlSessionFactoryBean的afterPropertiesSet方法实现如下：调用buildSqlSessionFactory方法创建用于注册到spring的IOC容器的sqlSessionFactory对象。
    
        @Override
        public void afterPropertiesSet() throws Exception { 
            notNull(dataSource, "Property 'dataSource' is required");
            notNull(sqlSessionFactoryBuilder, "Property 'sqlSessionFactoryBuilder' is required");
            state((configuration == null && configLocation == null) || !(configuration != null && configLocation != null),
                      "Property 'configuration' and 'configLocation' can not specified with together");
        
            // 创建sqlSessionFactory
            this.sqlSessionFactory = buildSqlSessionFactory();
        }
 *  buildSqlSessionFactory的核心逻辑：解析mybatis配置文件mybatisConfig.xml和mapper配置文件mapper.xml并封装到Configuration对象中，最后调用mybatis的sqlSessionFactoryBuilder来创建SqlSessionFactory对象。
    
        protected SqlSessionFactory buildSqlSessionFactory() throws IOException { 
            // 配置类
            final Configuration targetConfiguration;
        
            // 解析mybatisConfig.xml文件，
            // 将相关配置信息保存到targetConfiguration
            XMLConfigBuilder xmlConfigBuilder = null;
            
            ...
        
            if (xmlConfigBuilder != null) { 
              try { 
                xmlConfigBuilder.parse();
                LOGGER.debug(() -> "Parsed configuration file: '" + this.configLocation + "'");
              }
              
              ...
              
            }
        
            // 为sqlSessionFactory绑定事务管理器和数据源，
            // 这样sqlSessionFactory在创建sqlSession的时候可以通过该事务管理器获取jdbc连接，从而执行SQL
            targetConfiguration.setEnvironment(new Environment(this.environment,
                this.transactionFactory == null ? new SpringManagedTransactionFactory() : this.transactionFactory,
                this.dataSource));
        
            // 解析mapper.xml
            if (!isEmpty(this.mapperLocations)) { 
              for (Resource mapperLocation : this.mapperLocations) { 
                if (mapperLocation == null) { 
                  continue;
                }
        
                try { 
                  // 解析mapper.xml文件，并注册到configuration对象的mapperRegistry
                  XMLMapperBuilder xmlMapperBuilder = new XMLMapperBuilder(mapperLocation.getInputStream(),
                      targetConfiguration, mapperLocation.toString(), targetConfiguration.getSqlFragments());
                  xmlMapperBuilder.parse();
                } 
                
                ...
                
              }
            }
            
            ...
        
            // 将Configuration对象实例作为参数，
            // 调用sqlSessionFactoryBuilder创建sqlSessionFactory对象实例
            return this.sqlSessionFactoryBuilder.build(targetConfiguration);
        }

#### FactoryBean的getObject方法定义 ####

*  FactoryBean：创建某个类的对象实例的工厂。
 *  spring的IOC容器在启动，创建好bean对象实例后，会检查这个bean对象是否实现了FactoryBean接口，如果是，则调用该bean对象的getObject方法，在getObject方法中实现创建并返回实际需要的bean对象实例，然后将该实际需要的bean对象实例注册到spring容器；如果不是则直接将该bean对象实例注册到spring容器。
 *  通过提供FactoryBean接口，提供了一个机会给应用代码自定义应用自身类对象bean的创建，在getObject中可以访问spring的IOC容器的其他资源和组件。
 *  SqlSessionFactoryBean的getObject方法实现如下：由于spring在创建SqlSessionFactoryBean自身的bean对象时，已经调用了InitializingBean的afterPropertiesSet方法创建了sqlSessionFactory对象，故可以直接返回sqlSessionFactory对象给spring的IOC容器，从而完成sqlSessionFactory的bean对象的注册，之后可以直接在应用代码注入或者spring在创建其他bean对象时，依赖注入。
    
        @Override
        public SqlSessionFactory getObject() throws Exception { 
            if (this.sqlSessionFactory == null) { 
              afterPropertiesSet();
            }
            // 直接返回sqlSessionFactory对象
            // 单例对象，由所有mapper共享
            return this.sqlSessionFactory;
        }

### 总结 ###

由以上分析可知，spring在加载创建SqlSessionFactoryBean的bean对象实例时，调用SqlSessionFactoryBean的afterPropertiesSet方法完成了sqlSessionFactory对象实例的创建；在将SqlSessionFactoryBean对象实例注册到spring的IOC容器时，发现SqlSessionFactoryBean实现了FactoryBean接口，故不是SqlSessionFactoryBean对象实例自身需要注册到spring的IOC容器，而是SqlSessionFactoryBean的getObject方法的返回值对应的对象需要注册到spring的IOC容器，而这个返回值就是SqlSessionFactory对象，故完成了将sqlSessionFactory对象实例注册到spring的IOC容器。