MyBatis工作原理源码分析（三）——获取接口的代理对象（MapperProxy）

「爱情、让人受尽委屈。」 2022-03-19 14:56 540阅读 0赞

## 一、引言 ##

手动使用Mybatis的四个步骤：

获取SqlSessionFactory对象
    获取sqlSession对象
    获取接口的代理对象（MapperProxy）
    执行增删改查方法

[MyBatis工作原理源码分析（一）——SqlSessionFactory的初始化][MyBatis_SqlSessionFactory]  
[MyBatis工作原理源码分析（二）——获取SqlSession对象][MyBatis_SqlSession]  
前两篇详细分析了第一步和第二步，下面在此基础上，继续来分析接口的代理对象（MapperProxy）的获取。

## 二、源码分析 ##

再次说明：我们知道，在第二步中，获得了SqlSession（默认实现是DefaultSqlSession）。该SqlSession中包括执行具体Sql的Executor和保存全局配置信息的Configuration。

// 3、获取接口的实现类对象
    //会为接口自动的创建一个代理对象，代理对象去执行增删改查方法，传入接口名
    DepartmentMapper mapper = openSession.getMapper(DepartmentMapper.class);
    Department dept = mapper.getDeptById(1);

#### 1、调用SqlSession的getMapper()方法 ####

//调用的是Configuration的getMapper()方法，参数type为传入的接口全类名
    //什么都不做，直接去configuration中找
    @Override
    public <T> T getMapper(Class<T> type) { 
      return configuration.<T>getMapper(type, this);
    }

#### 2、SqlSession把包袱甩给了Configuration，接下来就看看Configuration ####

//在Configuration中，又调用了MapperRegistry的getMapper()方法
    public <T> T getMapper(Class<T> type, SqlSession sqlSession) { 
    	//烫手的山芋，俺不要，你找mapperRegistry去要
      return mapperRegistry.getMapper(type, sqlSession);
    }

#### 3、Configuration也不要这烫手的山芋，接着甩给了MapperRegistry， 那咱看看MapperRegistry。 ####

//MapperRegistry中的getMapper()方法
    public <T> T getMapper(Class<T> type, SqlSession sqlSession) { 
       //能偷懒的就偷懒，俺把粗活交给MapperProxyFactory去做
       final MapperProxyFactory<T> mapperProxyFactory = (MapperProxyFactory<T>) knownMappers.get(type);
       if (mapperProxyFactory == null) { 
         throw new BindingException("Type " + type + " is not known to the MapperRegistry.");
       }
       try { 
         //关键在这儿，将sqlSession传入，创建一个MapperProxy
         return mapperProxyFactory.newInstance(sqlSession);
       } catch (Exception e) { 
         throw new BindingException("Error getting mapper instance. Cause: " + e, e);
       }
    }
    
    //MapperProxyFactory中的newInstance()方法，传入SqlSession
    public T newInstance(SqlSession sqlSession) { 
      final MapperProxy<T> mapperProxy = new MapperProxy<T>(sqlSession, mapperInterface, methodCache);
      return newInstance(mapperProxy);
    }
     
    protected T newInstance(MapperProxy<T> mapperProxy) { 
      //动态代理我们写的dao接口
      return (T) Proxy.newProxyInstance(mapperInterface.getClassLoader(), new Class[] {  mapperInterface }, mapperProxy);
    }

MapperRegistry中的knownMappers保存了每一个mapper对应的MapperProxyFactory，如下图。在MapperRegistry中的getMapper()方法中， 所以可以通过全类名从knownMappers中获取得到接口的MapperProxyFactory， 然后用这个MapperProxyFactory创建了接口的代理对象。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3p4ZDE0MzU1MTM3NzU_size_16_color_FFFFFF_t_70]

#### 4、调用SqlSession的getMapper()方法的顺序图 ####

在Mybatis中，通过MapperProxy动态代理接口，也就是说，当我们执行自己写的Dao里面的方法的时候，其实是对应的MapperProxy在代理。那么，咱们就看看怎么获取MapperProxy对象：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3p4ZDE0MzU1MTM3NzU_size_16_color_FFFFFF_t_70 1]

## 三、小结 ##

获取接口的代理对象（MapperProxy）的时序图  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3p4ZDE0MzU1MTM3NzU_size_16_color_FFFFFF_t_70 2]

#### 1、getMapper()方法返回接口的代理对象，包含了SqlSession对象； ####

#### 2、getMapper()方法中，使用MapperProxyFactory创建一个MapperProxy的代理对象，代理对象里面包含了DefaultSqlSession（Executor）； ####

#### 3、openSession.getMapper(DepartmentMapper.class)方法，获取得到的是Mapper接口的代理对象，后面所有对接口的操作，都是代理对象在处理。 ####

[MyBatis_SqlSessionFactory]: https://blog.csdn.net/zxd1435513775/article/details/87300169
[MyBatis_SqlSession]: https://blog.csdn.net/zxd1435513775/article/details/87532451
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3p4ZDE0MzU1MTM3NzU_size_16_color_FFFFFF_t_70]: /images/20220319/754bfd1130b24333b1a5ca5d5a7360d3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3p4ZDE0MzU1MTM3NzU_size_16_color_FFFFFF_t_70 1]: /images/20220319/7b0b3c762f584d358be8547d159b45b2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3p4ZDE0MzU1MTM3NzU_size_16_color_FFFFFF_t_70 2]: /images/20220319/daa8aa076be641218672d71cf813c260.png