Mybatis 源碼（三）Mybatis 代理模塊

在使用Mybatis的時候大家可能都有一個疑問饥臂，為什么只寫Mapper接口就能操作數(shù)據(jù)庫傻粘？

它的主要實現(xiàn)思想是：使用動態(tài)代理生成實現(xiàn)類强经，然后配合xml的映射文件中的SQL語句來實現(xiàn)對數(shù)據(jù)庫的訪問厂榛。

Mybatis編程模型

Mybatis是在iBatis上演變而來ORM框架吕粹，所以Mybatis最終會將代碼轉換成iBatis編程模型族扰，而 Mybatis 代理階段主要是將面向接口編程模型隆夯，通過動態(tài)代理轉換成ibatis編程模型。

我們不直接使用iBatis編程模型的原因是為了解耦别伏，從下面的兩種示例我們可以看出蹄衷，iBatis編程模型和配置文件耦合很嚴重。

面向接口編程模型

@Test
// 面向接口編程模型
public void quickStart() throws Exception {
    // 2.獲取sqlSession
    try (SqlSession sqlSession = sqlSessionFactory.openSession()) {
        initH2dbMybatis(sqlSession);

        // 3.獲取對應mapper
        PersonMapper mapper = sqlSession.getMapper(PersonMapper.class);
        JdkProxySourceClassUtil.writeClassToDisk(mapper.getClass().getSimpleName(), mapper.getClass());
        // 4.執(zhí)行查詢語句并返回結果
        Person person = mapper.selectByPrimaryKey(1L);
        System.out.println(person.toString());
    }
}

ibatis編程模型

@Test
// ibatis編程模型
public void quickStartIBatis() throws Exception {
    // 2.獲取sqlSession
    try (SqlSession sqlSession = sqlSessionFactory.openSession()) {
        initH2dbMybatis(sqlSession);
        // ibatis編程模型(與配置文件耦合嚴重)
        Person person = sqlSession.selectOne("com.xiaolyuh.domain.mapper.PersonMapper.selectByPrimaryKey", 1L);
        System.out.println(person.toString());
    }
}

代理模塊核心類

  • MapperRegistry：Mapper接口動態(tài)代理工廠（MapperProxyFactory）的注冊中心
  • MapperProxyFactory：Mapper接口對應的動態(tài)代理工廠類厘肮。Mapper接口和MapperProxyFactory工廠類是一一對應關系
  • MapperProxy：Mapper接口的增強器愧口，它實現(xiàn)了InvocationHandler接口，通過該增強的invoke方法實現(xiàn)了對數(shù)據(jù)庫的訪問
  • MapperMethod：對insert, update, delete, select, flush節(jié)點方法的包裝類类茂，它通過sqlSession來完成了對數(shù)據(jù)庫的操作
binding.png

代理初始化

加載Mapper接口到內存

在Mybatis 源碼（二）中我們會發(fā)現(xiàn)當配置文件解析完成的最后一步是調用org.apache.ibatis.builder.xml.XMLMapperBuilder#bindMapperForNamespace方法耍属。該方法的主要作用是：根據(jù) namespace 屬性將Mapper接口的動態(tài)代理工廠（MapperProxyFactory）注冊到 MapperRegistry 中。源碼如下：

private void bindMapperForNamespace() {
  // 獲取namespace屬性（對應Mapper接口的全類名）
  String namespace = builderAssistant.getCurrentNamespace();
  if (namespace != null) {
    Class<?> boundType = null;
    try {
      boundType = Resources.classForName(namespace);
    } catch (ClassNotFoundException e) {
      //ignore, bound type is not required
    }
    if (boundType != null) {
      // 防止重復加載
      if (!configuration.hasMapper(boundType)) {
        // Spring may not know the real resource name so we set a flag
        // to prevent loading again this resource from the mapper interface
        // look at MapperAnnotationBuilder#loadXmlResource
        configuration.addLoadedResource("namespace:" + namespace);
        // 將Mapper接口的動態(tài)代理工廠注冊到 MapperRegistry 中
        configuration.addMapper(boundType);
      }
    }
  }
}
  1. 讀取namespace屬性巩检，獲取Mapper接口的全類名
  2. 根據(jù)全類名將Mapper接口加載到內存
  3. 判斷是否重復加載Mapper接口
  4. 調用Mybatis 配置類（configuration）的addMapper方法厚骗，完成后續(xù)步驟

注冊代理工廠類

org.apache.ibatis.session.Configuration#addMapper該方法直接回去調用org.apache.ibatis.binding.MapperRegistry#addMapper方法完成注冊。

public <T> void addMapper(Class<T> type) {
  // 必須是接口
  if (type.isInterface()) {
    if (hasMapper(type)) {
      // 防止重復注冊
      throw new BindingException("Type " + type + " is already known to the MapperRegistry.");
    }
    boolean loadCompleted = false;
    try {
      // 根據(jù)接口類兢哭，創(chuàng)建MapperProxyFactory代理工廠類
      knownMappers.put(type, new MapperProxyFactory<>(type));
      // It's important that the type is added before the parser is run
      // otherwise the binding may automatically be attempted by the
      // mapper parser. If the type is already known, it won't try.
      MapperAnnotationBuilder parser = new MapperAnnotationBuilder(config, type);
      parser.parse();
      loadCompleted = true;
    } finally {
      // 如果加載出現(xiàn)異常需要移除對應Mapper
      if (!loadCompleted) {
        knownMappers.remove(type);
      }
    }
  }
}
  1. 判斷加載類型是否是接口
  2. 重復注冊校驗领舰，如果校驗不通拋出BindingException異常
  3. 根據(jù)接口類，創(chuàng)建MapperProxyFactory代理工廠類
  4. 如果加載出現(xiàn)異常需要移除對應Mapper

獲取代理對象

在Mybatis 源碼（一）的快速開始中有如下代碼迟螺，通過 sqlSession獲取Mapper的代理對象：

PersonMapper mapper = sqlSession.getMapper(PersonMapper.class);

getMapper 獲取代理對象

sqlSession.getMapper(PersonMapper.class)最終調用的是org.apache.ibatis.binding.MapperRegistry#getMapper方法冲秽，最后返回的是PersonMapper接口的代理對象，源碼如下：

public <T> T getMapper(Class<T> type, SqlSession sqlSession) {
  // 根據(jù)類型獲取對應的代理工廠
  final MapperProxyFactory<T> mapperProxyFactory = (MapperProxyFactory<T>) knownMappers.get(type);
  if (mapperProxyFactory == null) {
    throw new BindingException("Type " + type + " is not known to the MapperRegistry.");
  }
  try {
    // 根據(jù)工廠類新建一個代理對象矩父，并返回
    return mapperProxyFactory.newInstance(sqlSession);
  } catch (Exception e) {
    throw new BindingException("Error getting mapper instance. Cause: " + e, e);
  }
}
  1. 根據(jù)類型獲取對應的代理工廠
  2. 根據(jù)工廠類新建一個代理對象锉桑，并返回

newInstance 創(chuàng)建代理對象

每一個Mapper接口對應一個MapperProxyFactory工廠類。
MapperProxyFactory通過JDK動態(tài)代理創(chuàng)建代理對象窍株，Mapper接口的代理對象是方法級別民轴，所以每次訪問數(shù)據(jù)庫都需要新創(chuàng)建代理對象。源碼如下：

protected T newInstance(MapperProxy<T> mapperProxy) {
  // 使用JDK動態(tài)代理生成代理實例
  return (T) Proxy.newProxyInstance(mapperInterface.getClassLoader(), new Class[]{mapperInterface}, mapperProxy);
}

public T newInstance(SqlSession sqlSession) {
  // Mapper的增強器
  final MapperProxy<T> mapperProxy = new MapperProxy<>(sqlSession, mapperInterface, methodCache);
  return newInstance(mapperProxy);
}
  1. 先獲取Mapper對應增強器(MapperProxy)
  2. 根據(jù)增強器使用JDK動態(tài)代理產(chǎn)生代理對象

代理類的反編譯結果

import com.sun.proxy..Proxy8;
import com.xiaolyuh.domain.model.Person;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
import java.lang.reflect.UndeclaredThrowableException;

public final class $Proxy8 extends Proxy implements Proxy8 {
    private static Method m3;
   ...

    public $Proxy8(InvocationHandler var1) throws  {
        super(var1);
    }

    ...
    public final Person selectByPrimaryKey(Long var1) throws  {
        try {
            return (Person)super.h.invoke(this, m3, new Object[]{var1});
        } catch (RuntimeException | Error var3) {
            throw var3;
        } catch (Throwable var4) {
            throw new UndeclaredThrowableException(var4);
        }
    }

    static {
        try {
            m3 = Class.forName("com.sun.proxy.$Proxy8").getMethod("selectByPrimaryKey", Class.forName("java.lang.Long")); 
        } catch (NoSuchMethodException var2) {
            throw new NoSuchMethodError(var2.getMessage());
        } catch (ClassNotFoundException var3) {
            throw new NoClassDefFoundError(var3.getMessage());
        }
    }
}

從代理類的反編譯結果來看球订，都是直接調用增強器的invoke方法后裸，進而實現(xiàn)對數(shù)據(jù)庫的訪問。

執(zhí)行代理

通過上訴反編譯代理對象辙售，我們可以發(fā)現(xiàn)所有對數(shù)據(jù)庫的訪問都是在增強器org.apache.ibatis.binding.MapperProxy#invoke中實現(xiàn)的轻抱。

執(zhí)行增強器 MapperProxy

@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
  try {
    // 如果是Object本身的方法不增強
    if (Object.class.equals(method.getDeclaringClass())) {
      return method.invoke(this, args);
    }
    // 判斷是否是默認方法
    else if (method.isDefault()) {
      if (privateLookupInMethod == null) {
        return invokeDefaultMethodJava8(proxy, method, args);
      } else {
        return invokeDefaultMethodJava9(proxy, method, args);
      }
    }
  } catch (Throwable t) {
    throw ExceptionUtil.unwrapThrowable(t);
  }
  // 從緩存中獲取MapperMethod對象
  final MapperMethod mapperMethod = cachedMapperMethod(method);
  // 執(zhí)行MapperMethod
  return mapperMethod.execute(sqlSession, args);
}
  1. 如果是Object本身的方法不增強
  2. 判斷是否是默認方法
  3. 從緩存中獲取MapperMethod對象
  4. 執(zhí)行MapperMethod

模型轉換 MapperMethod

MapperMethod封裝了Mapper接口中對應方法的信息(MethodSignature)，以及對應的sql語句的信息(SqlCommand)旦部；它是mapper接口與映射配置文件中sql語句的橋梁祈搜； MapperMethod對象不記錄任何狀態(tài)信息，所以它可以在多個代理對象之間共享士八；

  • SqlCommand ： 從configuration中獲取方法的命名空間.方法名以及SQL語句的類型容燕；
  • MethodSignature：封裝mapper接口方法的相關信息（入?yún)ⅲ祷仡愋停?/li>
  • ParamNameResolver： 解析mapper接口方法中的入?yún)ⅲ?/li> 
public Object execute(SqlSession sqlSession, Object[] args) {
  Object result;
  // 根據(jù)SQL類型婚度，調用不同方法蘸秘。
  // 這里我們可以看出，操作數(shù)據(jù)庫都是通過 sqlSession 來實現(xiàn)的
  switch (command.getType()) {
    case INSERT: {
      Object param = method.convertArgsToSqlCommandParam(args);
      result = rowCountResult(sqlSession.insert(command.getName(), param));
      break;
    }
    case UPDATE: {
      Object param = method.convertArgsToSqlCommandParam(args);
      result = rowCountResult(sqlSession.update(command.getName(), param));
      break;
    }
    case DELETE: {
      Object param = method.convertArgsToSqlCommandParam(args);
      result = rowCountResult(sqlSession.delete(command.getName(), param));
      break;
    }
    case SELECT:
      // 根據(jù)方法返回值類型來確認調用sqlSession的哪個方法

      // 無返回值或者有結果處理器
      if (method.returnsVoid() && method.hasResultHandler()) {
        executeWithResultHandler(sqlSession, args);
        result = null;
      }
      // 返回值是否為集合類型或數(shù)組
      else if (method.returnsMany()) {
        result = executeForMany(sqlSession, args);
      }
      // 返回值是否為Map
      else if (method.returnsMap()) {
        result = executeForMap(sqlSession, args);
      }
      // 返回值是否為游標類型
      else if (method.returnsCursor()) {
        result = executeForCursor(sqlSession, args);
      }
      // 查詢單條記錄
      else {
        // 參數(shù)解析
        Object param = method.convertArgsToSqlCommandParam(args);
        result = sqlSession.selectOne(command.getName(), param);
        if (method.returnsOptional()
          && (result == null || !method.getReturnType().equals(result.getClass()))) {
          result = Optional.ofNullable(result);
        }
      }
      break;
    case FLUSH:
      result = sqlSession.flushStatements();
      break;
    default:
      throw new BindingException("Unknown execution method for: " + command.getName());
  }
  if (result == null && method.getReturnType().isPrimitive() && !method.returnsVoid()) {
    throw new BindingException("Mapper method '" + command.getName()
      + " attempted to return null from a method with a primitive return type (" + method.getReturnType() + ").");
  }
  return result;
}

private <E> Object executeForMany(SqlSession sqlSession, Object[] args) {
  List<E> result;
  // 將方法參數(shù)轉換成SqlCommand參數(shù)
  Object param = method.convertArgsToSqlCommandParam(args);
  if (method.hasRowBounds()) {
    // 獲取分頁參數(shù)
    RowBounds rowBounds = method.extractRowBounds(args);
    result = sqlSession.selectList(command.getName(), param, rowBounds);
  } else {
    result = sqlSession.selectList(command.getName(), param);
  }
  // issue #510 Collections & arrays support
  if (!method.getReturnType().isAssignableFrom(result.getClass())) {
    if (method.getReturnType().isArray()) {
      return convertToArray(result);
    } else {
      return convertToDeclaredCollection(sqlSession.getConfiguration(), result);
    }
  }
  return result;
}

在execute方法中完成了面向接口編程模型到iBatis編程模型的轉換蝗茁，轉換過程如下：

  1. 通過MapperMethod.SqlCommand. type+MapperMethod.MethodSignature.returnType來確定需要調用SqlSession中的那個方法
  2. 通過MapperMethod.SqlCommand. name來找到需要執(zhí)行方法的全類名
  3. 通過MapperMethod.MethodSignature.paramNameResolver來轉換需要傳遞的參數(shù)

SqlSession

在Mybatis中SqlSession相當于一個門面醋虏，所有對數(shù)據(jù)庫的操作都需要通過SqlSession接口，SqlSession中定義了所有對數(shù)據(jù)庫的操作方法哮翘，如數(shù)據(jù)庫讀寫命令颈嚼、獲取映射器、管理事務等饭寺，也是Mybatis中為數(shù)不多的有注釋的類阻课。

SqlSession接口.png

流程圖

mybatis流程圖.png

總結

通過上面的源碼解析，可以發(fā)現(xiàn)Mybatis面向接口編程是通過JDK動態(tài)代理模式來實現(xiàn)的艰匙。主要執(zhí)行流程是：

  1. 在映射文件初始化完成后限煞，將對應的Mapper接口的代理工廠類MapperProxyFactory注冊到MapperRegistry
  2. 每次操作數(shù)據(jù)庫時，sqlSession通過MapperProxyFactory獲取Mapper接口的代理類
  3. 代理類通過增強器MapperProxy調用XML映射文件中SQL節(jié)點的封裝類MapperMethod
  4. 通過MapperMethod將Mybatis 面向接口的編程模型轉換成iBatis編程模型（SqlSession模型）
  5. 通過SqlSession完成對數(shù)據(jù)庫的操作

示例源碼

https://github.com/wyh-spring-ecosystem-student/spring-boot-student/tree/releases

spring-boot-student-mybatis工程

Mybatis 源碼中文注釋

https://github.com/xiaolyuh/mybatis

最后編輯于 ：
?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
  • 人面猴
    序言：七十年代末员凝，一起剝皮案震驚了整個濱河市署驻，隨后出現(xiàn)的幾起案子，更是在濱河造成了極大的恐慌健霹，老刑警劉巖硕舆，帶你破解...
    沈念sama閱讀 211,123評論 6贊 490
  • 死咒
    序言：濱河連續(xù)發(fā)生了三起死亡事件，死亡現(xiàn)場離奇詭異骤公，居然都是意外死亡抚官，警方通過查閱死者的電腦和手機，發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,031評論 2贊 384
  • 救了他兩次的神仙讓他今天三更去死
    文/潘曉璐 我一進店門阶捆，熙熙樓的掌柜王于貴愁眉苦臉地迎上來凌节，“玉大人，你說我怎么就攤上這事洒试”渡荩” “怎么了？”我有些...
    開封第一講書人閱讀 156,723評論 0贊 345
  • 道士緝兇錄：失蹤的賣姜人
    文/不壞的土叔 我叫張陵垒棋，是天一觀的道長卒煞。 經(jīng)常有香客問我，道長叼架，這世上最難降的妖魔是什么畔裕？ 我笑而不...
    開封第一講書人閱讀 56,357評論 1贊 283
  • ?港島之戀（遺憾婚禮）
    正文 為了忘掉前任衣撬，我火速辦了婚禮，結果婚禮上扮饶，老公的妹妹穿的比我還像新娘具练。我一直安慰自己，他們只是感情好甜无，可當我...
    茶點故事閱讀 65,412評論 5贊 384
  • 惡毒庶女頂嫁案：這布局不是一般人想出來的
    文/花漫 我一把揭開白布扛点。 她就那樣靜靜地躺著，像睡著了一般岂丘。 火紅的嫁衣襯著肌膚如雪陵究。 梳的紋絲不亂的頭發(fā)上，一...
    開封第一講書人閱讀 49,760評論 1贊 289
  • 城市分裂傳說
    那天奥帘，我揣著相機與錄音铜邮，去河邊找鬼。 笑死翩概，一個胖子當著我的面吹牛牲距，可吹牛的內容都是我干的。 我是一名探鬼主播钥庇，決...
    沈念sama閱讀 38,904評論 3贊 405
  • 雙鴛鴦連環(huán)套：你想象不到人心有多黑
    文/蒼蘭香墨 我猛地睜開眼牍鞠，長吁一口氣：“原來是場噩夢啊……” “哼！你這毒婦竟也來了评姨？” 一聲冷哼從身側響起难述，我...
    開封第一講書人閱讀 37,672評論 0贊 266
  • 萬榮殺人案實錄
    序言：老撾萬榮一對情侶失蹤，失蹤者是張志新（化名）和其女友劉穎吐句，沒想到半個月后胁后，有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體，經(jīng)...
    沈念sama閱讀 44,118評論 1贊 303
  • ?護林員之死
    正文 獨居荒郊野嶺守林人離奇死亡嗦枢，尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 36,456評論 2贊 325
  • ?白月光啟示錄
    正文 我和宋清朗相戀三年攀芯，在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片文虏。...
    茶點故事閱讀 38,599評論 1贊 340
  • 活死人
    序言：一個原本活蹦亂跳的男人離奇死亡侣诺，死狀恐怖，靈堂內的尸體忽然破棺而出氧秘，到底是詐尸還是另有隱情年鸳，我是刑警寧澤，帶...
    沈念sama閱讀 34,264評論 4贊 328
  • ?日本核電站爆炸內幕
    正文 年R本政府宣布丸相，位于F島的核電站搔确，受9級特大地震影響，放射性物質發(fā)生泄漏。R本人自食惡果不足惜膳算，卻給世界環(huán)境...
    茶點故事閱讀 39,857評論 3贊 312
  • 男人毒藥：我在死后第九天來索命
    文/蒙蒙 一座硕、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧畦幢，春花似錦坎吻、人聲如沸缆蝉。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,731評論 0贊 21
  • 一樁弒父案，背后竟有這般陰謀
    文/蒼蘭香墨 我抬頭看了看天上的太陽刊头。三九已至黍瞧，卻和暖如春，著一層夾襖步出監(jiān)牢的瞬間原杂，已是汗流浹背印颤。 一陣腳步聲響...
    開封第一講書人閱讀 31,956評論 1贊 264
  • 情欲美人皮
    我被黑心中介騙來泰國打工， 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留穿肄，地道東北人年局。 一個月前我還...
    沈念sama閱讀 46,286評論 2贊 360
  • 代替公主和親
    正文 我出身青樓，卻偏偏與公主長得像咸产，于是被迫代替她去往敵國和親矢否。 傳聞我的和親對象是個殘疾皇子，可洞房花燭夜當晚...
    茶點故事閱讀 43,465評論 2贊 348