如何實現一個簡易版的 Spring - 如何實現 AOP（中）

mghio發表於2021-05-30
Spring

前言

在上篇 如何實現 AOP（上） 介紹了 AOP 技術出現的原因和一些重要的概念，在我們自己實現之前有必要先了解一下 AOP 底層到底是如何運作的，所以這篇再來看看 AOP 實現所依賴的一些核心基礎技術。AOP 是使用動態代理和位元組碼生成技術來實現的，在執行期（注意：不是編譯期！）為目標物件生成代理物件，然後將橫切邏輯織入到生成的代理物件中，最後系統使用的是帶有橫切邏輯的代理物件，而不是被代理物件，由代理物件轉發到被代理物件。

代理模式

動態代理的根源是設計模式中的代理模式，代理模式在 GoF 中的描述如下：

Provide a surrogate or placeholder for another object to control access to it.

從其定義可以看出，代理模式主要是為了控制物件的訪問，通常也會擁有被代理者的所有功能。通過代理模式我們可以在不改變被代理類的情況下，通過引入代理類來給被代理類新增一些功能，此時腦海裡飄過電腦科學界中一句著名的話(P.S. 基礎知識很重要啊，可以參見 這篇)：

電腦科學的任何一個問題，都可以通過增加一箇中間層來解決。

代理模式其實在現實生活中也經常會接觸到，比如在一線城市租房時大部分都是找的租房中介去看的房子、談價格以及籤合同，是因為房子的房東已經把房子全權託管給了中介處理了，這裡的租房中介其實就是充當了代理模式中的代理物件的解決，而真正的被代理物件(目標物件)其實是房子的房東，而和我們打交道都是租房中介(代理物件)。代理模式類圖結構如下圖所示：

proxy-pattern.png

圖中各個部分的含義如下：

  • ISubject 是被代理物件所能提供能力的抽象。
  • SubjectImpl 是被代理的具體實現類。
  • SubjectProxy 是代理的實現類，通常該類持有 ISubject 介面的例項。
  • Client 是訪問者的抽象角色，要訪問 ISubject 型別的資源。

可以看到 SubjectImpl 和 SubjectProxy 都實現了相同的介面 ISubject，在代理物件 SubjectProxy 內持有 ISubject 的引用，當 Client 訪問 doOperation() 時，代理物件將請求轉發給被代理物件，單單從這個過程來看，代理物件如果只是為了轉發請求，是不是有點多此一舉了？再結合代理模式的定義思考一下，在轉發之前（後者之後）不就可以新增一些訪問控制了嗎。

static-proxy.png

在代理物件(SubjectProxy)將請求轉發給被代理物件(SubejctImpl)之前或者之後都是根據需要新增一些處理邏輯，而不需要修改被代理物件的具體實現邏輯，假設 SubjectImpl 是我們系統中 Joinpoint 所在的物件，此時 SubjectImpl 就是我們的目標物件了，只需要為這個目標物件建立一個代理物件，然後將橫切邏輯新增到代理物件中，對外暴露出建立出來的代理物件就可以將將橫切邏輯和原來的邏輯融合在一起了。

動態代理

到目前為止，一切都是那麼美好，當只為同一個目標物件型別新增橫切邏輯時，只需要建立一個代理物件即可，但是在 Joinpoint 相同而目標物件型別不同時，需要為每個不同的目標物件型別都單獨建立一個代理物件，而這些代理物件的橫切邏輯其實都是一樣的，根據 DRY原則，需要尋找另一種技術來解決這個問題。
在 JDK 1.3 引入的 動態代理機制 可以為指定的介面在執行期動態的去生成代理物件，使用這個動態代理機制可以解決上述問題，這樣我們就可以不事先為每個原始類建立代理類，而是在執行時動態生成代理類。在 Java 中，使用動態代理是比較簡單的，它本身就已經使用反射實現了動態代理的語法，主要是由一個類 Proxy 和一個介面 InvocationHandler 組成，使用動態代理機制實現前文示例如下：

/**
 * @author mghio
 * @since 2021-05-29
 */
public interface Subject {
  void doOperation();
}

public class SubjectImpl implements Subject {
  @Override
  public void doOperation() {
    System.out.println("SubjectImpl doOperation...");
  }
}

public class JDKInvocationHandler implements InvocationHandler {
  private final Subject target;
  public JDKInvocationHandler(Subject target) {
    this.target = target;
  }
  @Override
  public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
    // add pre process logic if necessary
    
    System.out.println("Proxy before JDKInvocationHandler doOperation...");
    Object result = method.invoke(target, args);
    System.out.println("Proxy after JDKInvocationHandler doOperation...");

    // add post process logic if necessary
    return result;
  }
}

public class Client {
  public static void main(String[] args) {
    // 將生成的代理類儲存在根目錄下（com/sun/proxy/XXX.class）
    System.setProperty("sun.misc.ProxyGenerator.saveGeneratedFiles", "true");
    Subject target = new SubjectImpl();
    Subject proxy = (Subject) Proxy.newProxyInstance(SubjectImpl.class.getClassLoader(),
        new Class[]{Subject.class}, new JDKInvocationHandler(target));
    proxy.doOperation();
  }
}

由以上程式碼可知，使用 JDK 的動態代理只要 3 步：

  1. 定義公共介面 Subject，建立被代理物件 SubjectImpl
  2. 建立被代理物件的處理物件 JDKInvocationHandler，持有目標物件 Subject 的引用
  3. 使用 JDK 的 Proxy 類的靜態方法 newProxyInstance 建立代理物件

通過設定 sun.misc.ProxyGenerator.saveGeneratedFiles 屬性，可以將動態生成的代理類儲存在專案根目錄下，執行上面的示例程式碼生成的代理類如下：

public final class $Proxy0 extends Proxy implements Subject {
  private static Method m1;
  private static Method m2;
  private static Method m3;
  private static Method m0;

  static {
    try {
      m1 = Class.forName("java.lang.Object").getMethod("equals", Class.forName("java.lang.Object"));
      m2 = Class.forName("java.lang.Object").getMethod("toString");
      m3 = Class.forName("cn.mghio.designpattern.proxy.dynamicproxy.Subject").getMethod("doOperation");
      m0 = Class.forName("java.lang.Object").getMethod("hashCode");
    } catch (NoSuchMethodException var2) {
      throw new NoSuchMethodError(var2.getMessage());
    } catch (ClassNotFoundException var3) {
      throw new NoClassDefFoundError(var3.getMessage());
    }
  }

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

  public final void doOperation() throws  {
    try {
      super.h.invoke(this, m3, (Object[])null);
    } catch (RuntimeException | Error var2) {
      throw var2;
    } catch (Throwable var3) {
      throw new UndeclaredThrowableException(var3);
    }
  }

  // omit toString、equals、hashCode method...

}

從動態生成的代理類的程式碼可以看出，JDK 動態代理生成的代理類是繼承 JDK 中提供的 Proxy 和實現被代理類所實現的介面。進一步可以從這個實現方式得出兩點：1. 使用 JDK 動態代理時為什麼只能使用介面引用指向代理，而不能使用被代理的具體類引用指向代理；2. 被代理類必須實現介面，因為 JDK 動態代理生成的代理類必須繼承自 Proxy，而 Java 不支援多重繼承，所以只能通過實現介面的方式。

jdk-dynamic-proxy.png

在預設情況下，Spring AOP 發現了目標物件實現了介面，會使用 JDK 動態代理機制為其動態生成代理物件，雖然提倡面向介面程式設計，但是也有目標物件沒有實現介面的場景，當被代理的目標物件沒有實現介面時就無法使用 JDK 動態代理了，那麼這種情況下就需要使用第三方工具來幫忙了。

位元組碼生成技術

當目標物件沒有實現介面時，可以通過動態位元組碼生成來繼承目標物件來動態生成相應的子類，在生成的子類中重寫父類目標物件的行為，然後將橫切邏輯放在子類，在系統中使用目標物件的子類，最終的效果是代理模式是一樣的，CGLIB 動態位元組碼生成類庫（它本身其實也是一個抽象層，更底層是 ASM）可以動態生成和修改一個類的位元組碼。當以上示例程式碼目標物件未實現介面時修改為 CGLIB 動態生成位元組碼方式實現如下：

/**
 * @author mghio
 * @since 2021-05-29
 */
public class RealSubject {
  public void doOperation() {
    System.out.println("RealSubject doOperation...");
  }
}

public class CglibMethodInterceptor implements MethodInterceptor {
  @Override
  public Object intercept(Object o, Method method, Object[] args, MethodProxy methodProxy)
      throws Throwable {
    // add pre process logic if necessary

    System.out.println("Cglib before RealSubject doOperation...");
    Object result = methodProxy.invokeSuper(o, args);
    System.out.println("Cglib after RealSubject doOperation...");

    // add post process logic if necessary
    return result;
  }
}

public class Client {
  public static void main(String[] args) {
    // 將生成的動態代理類儲存到檔案中
    System.setProperty(DebuggingClassWriter.DEBUG_LOCATION_PROPERTY,
        "/Users/mghio/IdeaProjects/designpattern/cglib/proxy/");
    // 1. 建立 Enhancer 物件
    Enhancer enhancer = new Enhancer();
    // 2. 設定被代理類
    enhancer.setSuperclass(RealSubject.class);
    // 3. 設定回撥物件(實現 MethodInterceptor 介面)
    enhancer.setCallback(new CglibMethodInterceptor());
    // 4. 建立代理物件
    RealSubject proxy = (RealSubject) enhancer.create();
    proxy.doOperation();
  }
}

使用 CGLIB 生成代理物件需要 4 步：

  1. 建立 Enhancer 物件，動態生成位元組碼的絕大部分邏輯都是在這個類中完成的。
  2. 設定被代理類(目標物件)，生成的代理類會繼承自這個介面，也就意味著這個類不能是 final 型別的。
  3. 設定回撥物件(實現 MethodInterceptor 介面)，在這裡根據需要新增橫切邏輯。
  4. 呼叫 Enhaner 的 create() 方法建立代理物件。

在設定 DebuggingClassWriter.DEBUG_LOCATION_PROPERTY 屬性後，反編譯已儲存的動態生成代理類如下：

cglib-generate.png

從反編譯後的程式碼可以看出 CGLIB 生成的代理類是通過繼承被代理類 RealSubject 實現 Factory 介面實現的，要能被繼承也就要求被代理類不能是 final 型別的。看到這裡你可能會問：既然 JDK 動態代理要求被代理類實現介面，而 CGLIB 動態位元組碼生成要求不能是 final 類，那對於那些沒有實現介面同時還是 final 類，要怎麼動態代理呢？好問題，這個就留給你自己去思考了。

總結

本文簡要介紹了 Spring AOP 實現所依賴的核心基礎技術，從動態代理的根源代理模式到動態代理和動態位元組碼生成技術，為下篇動手實現簡易版的 AOP 打下基礎，在瞭解了所依賴的基礎技術後，在具體實現時就會更加絲滑，動態代理和動態位元組碼生成對比如下：

對比項 JDK 動態代理 CGLIB
生成代理類的方式 繼承 JDK 中 Proxy，實現被代理類的所有介面 繼承被代理類，實現 CGLIB 的 Factory 介面
被代理物件的要求 必須實現介面，可以是 final 類 非 final 類，方法也要是非 final 型別的
整合方式 JDK 內建 第三方動態位元組碼生成類庫

相關文章