CGLib動態代理基本原理

CGLib——Code Generation Library，它是一個動態位元組程式碼生成庫，基於asm。使用CGLib時需要匯入asm相關的jar包。而asm又是何方神聖？

asm是一個java位元組碼操縱框架，它能被用來動態生成類或者增強既有類的功能。ASM 可以直接產生二進位制 class 檔案，也可以在類被載入入 Java 虛擬機器之前動態改變類行為。Java class 被儲存在嚴格格式定義的 .class檔案裡，這些類檔案擁有足夠的元資料來解析類中的所有元素：類名稱、方法、屬性以及 Java 位元組碼（指令）。ASM從類檔案中讀入資訊後，能夠改變類行為，分析類資訊，甚至能夠根據使用者要求生成新類。
瞭解asm的功能原理，有助於更好地理解我們的CGLib,但在本節不會細究asm。我們的主要關注點還是如何使用CGLib實現AOP。為我們後面分析Spring AOP鋪墊。

在上一節中，我們用JDK的動態代理來模擬實現了一個性能監控的例子，用到了JDK內建的反射技術和java.lang.reflect.Proxy代理類，通過例子我們發現，它只能通過讓被代理類實現代理介面的方式來生成代理，而CGLib的區別在於通過在程式執行時動態生成一個被代理類的子類的方式來完成代理。它有幾個核心類:
1. Enhancer 它用於動態生成被代理的類的子類。使用此類生成子類的前奏是指定被代理類和指定CallBack介面
2. CallBack：它是一個很關鍵的介面，我們常常通過CallBack介面來配置我們的攔截方法，
3. MethodInterceptor：是CallBack的實現類，他會攔截我們被代理類的所有方法，來實現自己的增強細節。比如做點日誌記錄，方法處理等，處理完後，還能通過MethodProxy重新呼叫攔截掉的方法。
4. MethodProxy：主要用於重新呼叫MethodInterceptor攔截掉的方法，是jdk反射包中Method的代理類。
5. CallbackFilter：一個Enhancer生成類可以指定多個Callback,這樣我們可以設定條件過濾，讓被代理類中不同的方法被呼叫時使用不同的CallBack來進行處理。

例項匯入，需求分析

在上篇文章的例子基礎上，我們為我們“老類”的每個方法（例子中有method1、method2、method3三個方法）都實現了耗時統計，但現在，對於method3，因為它經常被使用者呼叫，每次被呼叫都統計耗時會對效能造成一定影響，因此，現在需要過濾掉對method3的的耗時統計，而且我們還想對其進行日誌記錄，看看哪些使用者什麼時候呼叫了這個方法。
現在，結合前面提到的核心類，我們通過CGLib來完成這一輪新需求

原始碼例項展示

1. 定義被代理物件

我們的被代理物件：OldClass當然是不(能)變的啦。

public class OldClass
 
 {
    public void method1() throws InterruptedException{
        System.out.println("正在處理業務邏輯1");
        Thread.sleep(100);//模擬處理業務邏輯1過程
        System.out.println("業務邏輯1處理完成");
    }
    public void method2() throws InterruptedException{
        System.out.println("正在處理業務邏輯2");
        Thread.sleep(200);//模擬處理業務邏輯2過程
        System.out.println("業務邏輯2處理完成");
    }
    public void method3(String userName) throws InterruptedException{
        System.out.println("正在處理業務邏輯3");
        Thread.sleep(300);//模擬處理業務邏輯3過程
        System.out.println("業務邏輯3處理完成");
    }
    //下面還有很多很多。。
}

2. 定義代理生成工廠

public class ProxyFactory {
    private Enhancer enhancer = new Enhancer();//動態的類生成器
    public Object createSubObject(Class<?> clazz){
        enhancer.setSuperclass(clazz);//設定需要建立的類，這個類的父類是clazz類
        //當通過enhancer建立的類中的方法被呼叫時，該方法會被CallBack指定的物件攔截。
        enhancer.setCallbacks(new Callback[]{new MyTimeInterceptor(),new MyRecordInterceptor()});
        enhancer.setCallbackFilter(new MyCallBackFilter());//設定我們自定義的過濾器
        return enhancer.create();//通過位元組碼技術動態建立子類例項
    }
}

3. 定義增強攔截器

下面定義我們的兩個CallBack實現類，一個負責攔截需要統計耗時的方法，另一個攔截需要進行日誌記錄的方法

1. 耗時統計攔截器

public class MyTimeInterceptor implements MethodInterceptor {

    @Override
    public Object intercept(Object target, Method method, Object[] args,
            MethodProxy proxy) throws Throwable {//攔截所有父類方法的呼叫
        Long beginTime = System.currentTimeMillis();//記錄開始時間
        //呼叫目標物件的方法，同時獲取該方法的返回值，作為我們本代理方法(invoke)的返回值
        Object returnValue = proxy.invokeSuper(target, args);//target為我們方法所在的目標類，args為方法引數
        System.out.println("方法" + method.getName() + "呼叫結束，耗時"+ (System.currentTimeMillis() - beginTime));
        return returnValue;
    }
}

2. 日誌記錄攔截器

public class MyRecordInterceptor implements MethodInterceptor {

    @Override
    public Object intercept(Object target, Method method, Object[] args,
            MethodProxy proxy) throws Throwable {// 攔截所有父類方法的呼叫
        System.out.println(args[0] + "在"
                + new SimpleDateFormat("yyyy-MM-dd HH-mm").format(new Date())
                + "呼叫了方法" + method.getName());
        Object returnValue = proxy.invokeSuper(target, args);// target為我們方法所在的目標類，args為方法引數
        return returnValue;
    }

}

4. 定義我們的攔截過濾器

public class MyCallBackFilter implements CallbackFilter{//需要實現特定介面

    @Override
    public int accept(Method method) {
        if("method3" .equals(method.getName())){//如果被攔截的方法名滿足特定條件
            //這裡的序號對應於enhancer.setCallbacks(new Callback[]{new MyTimeInterceptor(),new MyRecordInterceptor()})中的Callback陣列的攔截器索引
            return 1;
        }else{
            return 0;
        }
    }
}

5. 測試方法

public static void main(String args[]) throws InterruptedException{
    ProxyFactory cgLibProxy = new ProxyFactory();//建立我們的代理類
    //通過enhancer建立我們的子類
    //因為oldClass是我們子類的父類，所以這裡向上轉型成功
    OldClass oldClass = (OldClass) cgLibProxy.createSubObject(OldClass.class);
    oldClass.method1();//呼叫方法
    oldClass.method2();//呼叫方法
    oldClass.method3("zenghao");//呼叫方法
}

6. 結果分析

執行5中的測試方法，控制檯列印：

正在處理業務邏輯1
業務邏輯1處理完成
方法method1呼叫結束，耗時116
正在處理業務邏輯2
業務邏輯2處理完成
方法method2呼叫結束，耗時201
zenghao在2016-03-24 18-32呼叫了方法method3
正在處理業務邏輯3
業務邏輯3處理完成

在這裡，我們的method1和method2還是被攔截下來統計耗時，但我們的method3就在呼叫前被做了日誌記錄了。

小結

使用CGlib來通過生成子類來完成代理，這樣，我們就不用強迫我們的被代理類實現代理介面了，侵入性更低。而且，使用CGLib還能為我們的攔截方法實現智慧過濾，相對於使用JDK的動態代理，還是優雅了很多。
但在實際的應用場景中，如果我們每次使用AOP，都要進行如上所示一堆配置，還是挺繁瑣的，但如果我們把配置的工作，交給spring完成，那麼我們只要通過簡潔的配置，就能輕鬆實現我們的動態代理。甚至結合上spring的許多特性，我們的代理功能還會更加的靈活強大。
通過對JDK和CGLib動態代理的例項理解，我們對AOP有一個更全面而感性地認識，從下篇文章我們開始進入springAOP部分的學習分析。

原始碼下載