超全MyBatis動態代理詳解(絕對幹貨)

Posted on by

前言

假如有人問你這麼幾個問題，看能不能答上來

  • Mybatis Mapper 接口沒有實現類，怎麼實現的動態代理
  • JDK 動態代理為什麼不能對類進行代理（充話費送的問題）
  • 抽象類可不可以進行 JDK 動態代理（附加問題）

答不上來的鐵汁，證明 Proxy、Mybatis 源碼還沒看到位。不過沒有關系，繼續往下看就明白瞭

動態代理實戰

眾所周知哈，Mybatis 底層封裝使用的 JDK 動態代理。說 Mybatis 動態代理之前，先來看一下平常我們寫的動態代理 Demo，拋磚引玉

一般來說定義 JDK 動態代理分為三個步驟，如下所示

  • 定義代理接口
  • 定義代理接口實現類
  • 定義動態代理調用處理器

三步代碼如下所示，玩過動態代理的小夥伴看過就能明白

public interface Subject { // 定義代理接口
 String sayHello();
}

public class SubjectImpl implements Subject { // 定義代理接口實現類
 @Override
 public String sayHello() {
  System.out.println(" Hello World");
  return "success";
 }
}

public class ProxyInvocationHandler implements InvocationHandler { // 定義動態代理調用處理器
 private Object target;

 public ProxyInvocationHandler(Object target) {
  this.target = target;
 }

 @Override
 public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
  System.out.println(" 🧱 🧱 🧱 進入代理調用處理器 ");
  return method.invoke(target, args);
 }
}

寫個測試程序，運行一下看看效果，同樣是分三步

  • 創建被代理接口的實現類
  • 創建動態代理類，說一下三個參數
    • 類加載器
    • 被代理類所實現的接口數組
    • 調用處理器（調用被代理類方法，每次都經過它）
  • 被代理實現類調用方法
public class ProxyTest {
 public static void main(String[] args) {
  Subject subject = new SubjectImpl();
  Subject proxy = (Subject) Proxy
    .newProxyInstance(
      subject.getClass().getClassLoader(),
      subject.getClass().getInterfaces(),
      new ProxyInvocationHandler(subject));

  proxy.sayHello();
  /**
   * 打印輸出如下
   * 調用處理器：🧱 🧱 🧱 進入代理調用處理器
   * 被代理實現類：Hello World
   */
 }
}

Demo 功能實現瞭，大致運行流程也清楚瞭，下面要針對原理實現展開分析

動態代理原理分析

從原理的角度上解析一下，上面動態代理測試程序是如何執行的

第一步簡單明瞭， 創建瞭 Subject 接口的實現類 ，也是我們常規的實現

第二步是創建被代理對象的動態代理對象。這裡有朋友就問瞭，怎麼證明這是個動態代理對象？如圖所示

JDK 動態代理對象名稱是有規則的，凡是經過 Proxy 類生成的動態代理對象，前綴必然是 $Proxy ，後面的數字也是名稱組成部分

如果有小夥伴想要一探究竟， 關註 Proxy 內部類 ProxyClassFactory ，這裡會有想要的答案

回歸正題，繼續看一下 ProxyInvocationHandler， 內部保持瞭被代理接口實現類的引用 ，invoke 方法內部使用反射調用被代理接口實現類方法

可以看出生成的動態代理類，繼承瞭 Proxy 類，然後對 Subject 接口進行瞭實現，而實現方法 sayHello 中實際調用的是 ProxyInvocationHandler 的 invoke 方法

一不小心發現瞭 JDK 動態代理不能對類進行代理的原因 ^ ^

也就是說，當我們調用 Subject#sayHello 時，方法調用鏈是這樣的

但是，Demo 裡有被代理接口的實現類，Mybatis Mapper 沒有，這要怎麼玩

不知道不要緊，知道瞭估計也看不到這瞭，一起看下 mybatis 源碼是怎麼玩的

mybatis version：3.4.x

Mybatis 源碼實現

不知道大傢考沒考慮過這麼一個問題， Mybatis Mapper 為什麼不需要實現類？

假如說，我們項目使用的三層設計，Controller 控制請求接收，Service 負責業務處理，Mapper 負責數據庫交互

Mapper 層也就是我們常說的數據庫映射層，負責對數據庫的操作，比如對數據的查詢或者新增、刪除等

大膽設想下，項目沒有使用 Mybatis，需要在 Mapper 實現層寫數據庫交互，會寫一些什麼內容？

會寫一些常規的 JDBC 操作，比如：

// 裝載Mysql驅動
Class.forName(driveName);
// 獲取連接
con = DriverManager.getConnection(url, user, pass);
// 創建Statement
Statement state = con.createStatement();
// 構建SQL語句
String stuQuerySqlStr = "SELECT * FROM student";
// 執行SQL返回結果
ResultSet result = state.executeQuery(stuQuerySqlStr);
...

如果項目中所有 Mapper 實現層都要這麼玩，那豈不是很想打人…

所以 Mybatis 結合項目痛點，應運而生，怎麼做的呢

  • 將所有和 JDBC 交互的操作，底層采用 JDK 動態代理封裝，使用者隻需要自定義 Mapper 和 .xml 文件
  • SQL 語句定義在 .xml 文件或者 Mapper 中，項目啟動時通過解析器解析 SQL 語句組裝為 Java 中的對象

解析器分為多種，因為 Mybatis 中不僅有靜態語句，同時也包含動態 SQL 語句

這也就是為什麼 Mapper 接口不需要實現類， 因為都已經被 Mybatis 通過動態代理封裝瞭，如果每個 Mapper 都來一個實現類，臃腫且無用 。經過這一頓操作，展示給我們的就是項目裡用到的 Mybatis 框架

上面鋪墊這麼久，終於要到主角瞭， 為什麼 Mybatis Mapper 接口沒有實現類也可以實現動態代理

想要嚴格按照先後順序介紹 Mybatis 動態代理流程，而不超前引用未介紹過的術語，這幾乎是不可能的，筆者盡量說的通俗易懂

無實現類完成動態代理

核心點來瞭，拿起小本本坐板正瞭

我們先來看下普通動態代理有沒有可能不用實現類，僅靠接口完成

public interface Subject {
 String sayHello();
}

public class ProxyInvocationHandler implements InvocationHandler {

 @Override
 public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
  System.out.println(" 🧱 🧱 🧱 進入代理調用處理器 ");
  return "success";
 }
}

根據代碼可以看到，我們並沒有實現接口 Subject，繼續看一下怎麼實現動態代理

public class ProxyTest {
 public static void main(String[] args) {
  Subject proxy = (Subject) Proxy
    .newProxyInstance(
      subject.getClass().getClassLoader(),
      new Class[]{Subject.class},
      new ProxyInvocationHandler());

  proxy.sayHello();
  /**
   * 打印輸出如下
   * 調用處理器：🧱 🧱 🧱 進入代理調用處理器
   */
 }
}

可以看到，對比文初的 Demo，這裡對 Proxy.newProxyInstance 方法的參數作出瞭變化

之前是通過實現類獲取所實現接口的 Class 數組，而這裡是把接口本身放到 Class 數組中，殊歸同途

有實現類接口和無實現類接口產生的動態代理類有什麼區別

  • 有實現類接口是對 InvocationHandler#invoke 方法調用，invoke 方法通過反射調用被代理對象（SubjectImpl）方法（sayHello）
  • 無實現類接口則是僅對 InvocationHandler#invoke 產生調用。 所以有實現類接口返回的是被代理對象接口返回值，而無實現類接口返回的僅是 invoke 方法返回值

InvocationHandler#invoke 方法返回值是 success 字符串，定義個字符串變量，是否能成功返回

現在第一個問題答案已經浮現， Mapper 沒有實現類，所有調用 JDBC 等操作都是在 Mybatis InvocationHandler 實現的

問題既然已經得到瞭解決，給人一種感覺，好像沒那麼難，但是你不好奇，Mybatis 底層怎麼做的麼？

先拋出一個問題，然後帶著問題去看源碼，可能讓你記憶 Double 倍深刻

咱們 Demo 裡的接口是固定的，Mybatis Mapper 可是不固定的，怎麼搞？

Mybatis 是這麼說的

看看 Mybatis 底層它怎麼實現的動態接口代理，小夥伴隻需要關註標記處的代碼即可

和我們的 Demo 代碼很像，核心點在於 mapperInterface 它是怎麼賦值的

先來說一下 Mybatis 代理工廠中具體生成動態代理類具體邏輯

  • 根據 .xml 上關聯的 namespace, 通過 Class#forName 反射的方式返回 Class 對象（不止 .xml namespace 一種方式）
  • 將得到的 Class 對象（實際就是接口對象）傳遞給 Mybatis 代理工廠生成代理對象，也就是剛才 mapperInterface 屬性

謎底揭曉，Mybatis 使用接口全限定名通過 Class#forName 生成 Class 對象，這個 Class 對象類型就是接口

為瞭方便大傢理解，通過 Mybatis 源碼提供的測試類舉例。假設已有接口 AutoConstructorMapper 以及對應的 .xml 如下

執行第一步，根據 .xml namespace 得到 Class 對象

  1. 首先第一步獲取 .xml 上 mapper 標簽 namespace 屬性，得到 mapper 接口全限定信息
  2. 根據 mapper 全限定信息獲取 Class 對象
  3. 添加到對應的映射器容器中，等待生成動態代理對象

如果此時調用生成動態代理對象，代理工廠 newInstance 方法如下：

至此，文初提的 Proxy、Mybatis 動態代理相關問題已全部答疑

抽象類能否 JDK 動態代理

說代碼前結論先行， 不能！

public abstract class AbstractProxy {
 abstract void sayHello();
}

AbstractProxy proxyInterface = (AbstractProxy) Proxy
  .newProxyInstance(
    ProxyTest.class.getClassLoader(),
    new Class[]{AbstractProxy.class},
    new ProxyInvocationHandler());
proxyInterface.sayHello();

毫無疑問，報錯是必然的，JDK 是不能對類進行代理的

帶著小疑惑我們看一下 Proxy 源碼報錯位置，JDK 動態代理在生成代理類的過程代碼中，會有是否接口驗證

抽象類終歸是類，加個 abstract 也成不瞭接口（就像我，雖然胖瞭 60 斤，但依然是帥哥）

下次面試官如果有問這問題的， 斬釘截鐵一點 ，就是不能

結言

結合 Mybatis 使用 JDK 動態代理相關的問題，展開瞭文章的講述，這裡總結如下

Q：JDK 動態代理能否對類代理？

因為 JDK 動態代理生成的代理類，會繼承 Proxy 類，由於 Java 無法多繼承，所以無法對類進行代理

Q：抽象類是否可以 JDK 動態代理？

不可以，抽象類本質上也是類，Proxy 生成代理類過程中，會校驗傳入 Class 是否接口

Q：Mybatis Mapper 接口沒有實現類，怎麼實現的動態代理？

Mybatis 會通過 Class#forname 得到 Mapper 接口 Class 對象，生成對應的動態代理對象，核心業務處理都會在 InvocationHandler#invoke 進行處理

到此這篇關於超全MyBatis動態代理詳解(絕對幹貨)的文章就介紹到這瞭,更多相關MyBatis 動態代理內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：