【MyBatis】Spring集成原理（四）：注入代理对象 MapperProxy

怼烎@ 2022-12-28 14:14 197阅读 0赞

在上一篇 [【MyBatis】Spring集成原理（三）：注册 Mapper接口到IOC容器][MyBatis_Spring_ Mapper_IOC] 我们分析了 MyBatis 是如何实现自定义注册 Mapper 接口到 IOC 容器中的，最后我们看到 BeanDefinition 中实际保存的是 MapperFactoryBean.class。

在上篇文末还留了两个问题：

1.  我们只是注入了一个接口，在对象实例化的时候，是怎么拿到 SqlSessionTemplate 的？
2.  当我们调用方法的时候，还是不是用的 MapperProxy？

要解决这俩问题，我们首先要做的就是找到一个分析的入手点。来看下面这段示例代码：

@Service 
    public class EmployeeService {
         
        
        @Autowired 
        // 直接注入mapper接口
        EmployeeMapper employeeMapper;
        
    	public List<Employee> getAll() {
         
            return employeeMapper.selectByMap(null);
        }
    }

其中，@Autowired 的底层实现是 getBean(EmployeeMapper.class)，然后 Spring 会根据 Mapper 的名字从 IOC 容器中获取它的 BeanDefination，再从 BeanDefination 中获取 BeanClass，而 EmployeeMapper 对应的 BeanClass 是 MapperFactoryBean（上一篇已经分析过）。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzNTkyNw_size_16_color_FFFFFF_t_70_pic_center]

可以看到 MapperFactoryBean 实现了 FactoryBean 接口（表明是一个工厂bean），所以 getBean() 最终返回的并不是它自己，而是 getObject 中创建的对象。

> PS：关于 FactoryBean 可以参考 [【Spring】IOC&DI：FactoryBean和BeanFactory分析对比][Spring_IOC_DI_FactoryBean_BeanFactory]…

###  ###

// MapperFactoryBean#getObject()
    public T getObject() throws Exception {
         
    	// 因为 MapperFactoryBean 继承了 SqlSessionDaoSupport 
    	// 所以这个 getSqlSession() 就是调用父类的方法，返回 SqlSessionTemplate。
    	return getSqlSession().getMapper(this.mapperInterface);
    }
    
    // SqlSessionTemplate#getMapper()
    public <T> T getMapper(Class<T> type) {
          
    	// 1.获取配置类 Configuration
    	// 2.创建代理对象 MapperProxy
    	// PS:这里采用的是链式编程
    	return getConfiguration().getMapper(type, this);
    }

我想第一个问题的答案已经很明确了。

**1.获取配置类 Configuration**

// 1.1 SqlSessionTemplate#getConfiguration
    public Configuration getConfiguration() {
        
    	// 调用 DefaultSqlSessionFactory#getConfiguration()
        return this.sqlSessionFactory.getConfiguration(); 
    }
    
    // 1.2 DefaultSqlSessionFactory#getConfiguration
    public Configuration getConfiguration() {
         
    	// 返回全部配置Configuration
    	return configuration; 
    }

**2.创建代理对象**

// 2.1 Configuration.getMapper()
    public <T> T getMapper(Class<T> type, SqlSession sqlSession) {
         
    	// 调用 MapperRegister#getMapper()
    	return mapperRegistry.getMapper(type, sqlSession); 
    }
    
    // 2.2 MapperRegister#getMapper()
    public <T> T getMapper(Class<T> type, SqlSession sqlSession) {
        
    	// 获取MapperProxy工厂
        // 在解析mapper标签和Mapper.xml的时候已经把接口类型和类型对应的MapperProxyFactory放到了一个Map中。
        final MapperProxyFactory<T> mapperProxyFactory = (MapperProxyFactory<T>) knownMappers.get(type);
        if (mapperProxyFactory == null) {
        
          throw new BindingException("Type " + type + " is not known to the MapperRegistry.");
        }
        try {
        
          // 通过 MapperProxyFactory 获取具体对象
          // 注：这里使用的是JDK动态代理，不过代理对象不用组合接口实现对象
          return mapperProxyFactory.newInstance(sqlSession);
        } catch (Exception e) {
        
          throw new BindingException("Error getting mapper instance. Cause: " + e, e);
        }
      }

可以看到，跟编程式使用里面的 getMapper 一样，通过工厂类 MapperProxyFactory 获得一个MapperProxy代理对象。也就是说，我们注入到 Service 层的接口，实际上还是一个 MapperProxy 代理对象。所以最后调用 Mapper 接口方法，就是执行 MapperProxy 的invoke() 方法，后面流程就跟编程式的工程里面一模一样了。

> 想了解 SqlSession 底层 Excutor 如何执行 SQL 的同学，可以参考 [【MyBatis】执行原理（四）：Executor 执行SQL源码分析][MyBatis_Executor _SQL]…

--------------------

**小结**

下面对 Spring 集成原理这四篇文章做个小结：

1）几个关键对象

<table> 
 <thead> 
  <tr> 
   <th align="left">对象</th> 
   <th align="left">生命周期</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">SqlSessionTemplate</td> 
   <td align="left">Spring 中 SqlSession 的替代品，是线程安全的，通过代理的方式调用 DefaultSqlSession 的方法</td> 
  </tr> 
  <tr> 
   <td align="left">SqlSessionInterceptor（内部类）</td> 
   <td align="left">代理对象，用来代理 DefaultSqlSession，在 SqlSessionTemplate 中使用</td> 
  </tr> 
  <tr> 
   <td align="left">SqlSessionDaoSupport</td> 
   <td align="left">用于获取 SqlSessionTemplate，只要继承它即可 MapperFactoryBean 注册到 IOC 容器中替换接口类，继承了 SqlSessionDaoSupport 用来获取 SqlSessionTemplate，因为注入接口的时候，就会调用它的 getObject()方法</td> 
  </tr> 
  <tr> 
   <td align="left">SqlSessionHolder</td> 
   <td align="left">控制 SqlSession 和事务</td> 
  </tr> 
 </tbody> 
</table>

2）用到 Spring 的扩展点

<table> 
 <thead> 
  <tr> 
   <th align="left">接口</th> 
   <th align="left">方法</th> 
   <th align="left">作用</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">FactoryBean</td> 
   <td align="left">getObject()</td> 
   <td align="left">返回由 FactoryBean 创建的 Bean 实例</td> 
  </tr> 
  <tr> 
   <td align="left">InitializingBean</td> 
   <td align="left">afterPropertiesSet()</td> 
   <td align="left">bean 属性初始化完成后添加操作</td> 
  </tr> 
  <tr> 
   <td align="left">BeanDefinitionRegistryPostProcessor</td> 
   <td align="left">postProcessBeanDefinitionRegistry()</td> 
   <td align="left">注入 BeanDefination 时添加操作</td> 
  </tr> 
 </tbody> 
</table>

[MyBatis_Spring_ Mapper_IOC]: https://blog.csdn.net/weixin_43935927/article/details/111321541
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzNTkyNw_size_16_color_FFFFFF_t_70_pic_center]: /images/20221120/dc46e25c4777400cb9abec006d73567b.png
[Spring_IOC_DI_FactoryBean_BeanFactory]: https://blog.csdn.net/weixin_43935927/article/details/110508417
[MyBatis_Executor _SQL]: https://blog.csdn.net/weixin_43935927/article/details/111269659