解析Spring中的靜態(tài)代理和動(dòng)態(tài)代理

更新時(shí)間：2021年06月11日 11:49:24 作者：SharpCJ

學(xué)習(xí) Spring 的過(guò)程中，不可避免要掌握代理模式。這篇文章總結(jié)一下代理模式。顧名思義，代理，就是你委托別人幫你辦事，所以代理模式也有人稱作委托模式的。比如領(lǐng)導(dǎo)要做什么事，可以委托他的秘書去幫忙做，這時(shí)就可以把秘書看做領(lǐng)導(dǎo)的代理

一、靜態(tài)代理

1.1、靜態(tài)代理的使用

靜態(tài)代理，代理類和被代理的類實(shí)現(xiàn)了同樣的接口，代理類同時(shí)持有被代理類的引用，這樣，當(dāng)我們需要調(diào)用被代理類的方法時(shí)，可以通過(guò)調(diào)用代理類的方法來(lái)做到。舉例如下：

假設(shè)領(lǐng)導(dǎo)的工作是開會(huì)和給員工考評(píng)。

先定義一個(gè)接口：

package com.sharpcj;

public interface IWork {
    void meeting();

    int evaluate(String name);
}

然后定義領(lǐng)導(dǎo)類：

package com.sharpcj;

import java.util.Random;

public class Leader implements IWork {

    @Override
    public void meeting() {
        System.out.println("領(lǐng)導(dǎo)早上要組織會(huì)議");
    }

    @Override
    public int evaluate(String name) {
        int score = new Random(System.currentTimeMillis()).nextInt(20) + 80;
        System.out.println(String.format("領(lǐng)導(dǎo)給%s的考評(píng)為%s分", name, score));
        return score;
    }
}

秘書類：

package com.sharpcj;

public class Secretary implements IWork {
    private Leader mLeader;

    public Secretary(Leader mLeader) {
        this.mLeader = mLeader;
    }

    @Override
    public void meeting() {
        System.out.println("秘書先給老板準(zhǔn)備材料");
        mLeader.metting();
    }

    @Override
    public int evaluate(String name) {
        return mLeader.evaluate(name);
    }
}

測(cè)試類：

package com.sharpcj;

public class TestApp {
    public static void main(String[] args) {
        Leader leader = new Leader();
        Secretary secretary = new Secretary(leader);
        secretary.meeting();
        secretary.evaluate("Joy");
    }
}

執(zhí)行結(jié)果：

這個(gè)代碼很簡(jiǎn)單，注意在調(diào)用Secretary類的 meeting 方法時(shí)，我們調(diào)用了Leader類的 meeting 的方法，在此之前，我們還擴(kuò)充了該方法。這時(shí)有的人可能有疑惑了，這看起來(lái)有點(diǎn)是裝飾者模式了。這到底怎么回事？

1.2、與裝飾者模式的區(qū)別

實(shí)際上，在裝飾器模式和代理模式之間還是有很多差別的。裝飾器模式關(guān)注于在一個(gè)對(duì)象上動(dòng)態(tài)的添加方法，然而代理模式關(guān)注于控制對(duì)對(duì)象的訪問(wèn)。換句話說(shuō)，用代理模式，代理類（proxy class）可以對(duì)它的客戶隱藏一個(gè)對(duì)象的具體信息。因此，當(dāng)使用代理模式的時(shí)候，我們常常在一個(gè)代理類中創(chuàng)建一個(gè)對(duì)象的實(shí)例。并且，當(dāng)我們使用裝飾器模式的時(shí)候，我們通常的做法是將原始對(duì)象作為一個(gè)參數(shù)傳給裝飾者的構(gòu)造器。

我們可以用另外一句話來(lái)總結(jié)這些差別：使用代理模式，代理和真實(shí)對(duì)象之間的的關(guān)系通常在編譯時(shí)就已經(jīng)確定了，而裝飾者能夠在運(yùn)行時(shí)遞歸地被構(gòu)造。

先看看兩者的 UML 類圖區(qū)別：

代理模式

裝飾者模式

兩者偽代碼：

代理模式:

Interface Subject {
    void doAction()
}

public class RealSubject implements Subject{
    @Override
    public void doAction() {};
}


public class Proxy implements Subject{
       private RealSubject realSubject;

       public Proxy(RealSubject realSubject) {
             //關(guān)系在編譯時(shí)確定
            this.realSubject = realSubject;
       }

       @Override
       public void doAction() {
             ….
             realSubject.doAction();
             ….
       }
}

// 裝飾者模式

Interface Component {
    void doAction()
}

public class ConcreteComponent implement Component {
    @Override
    public void doAction() {};
}

public class Decorator implements Component {
       private Component component;

       public Decorator(Component component) {
             //關(guān)系在編譯時(shí)確定
            this.component = new component;
       }
       public void doAction() {
             ….
             component.doAction();
             ….
       }
}

其實(shí)代理模式和裝飾者模式側(cè)重點(diǎn)不一樣，代理模式重點(diǎn)在于明確了被代理的類。如上例中，秘書很明確要代理的是的領(lǐng)導(dǎo)。而裝飾者模式側(cè)重于拓展類的方法，裝飾類持有的實(shí)現(xiàn)Component接口的類的對(duì)象不是固定的，也就是說(shuō)，裝飾類可以根據(jù)在調(diào)用時(shí)傳入的參數(shù)，裝飾任意一個(gè)實(shí)現(xiàn)了 Component 接口的類。

二、動(dòng)態(tài)代理

動(dòng)態(tài)代理的根據(jù)實(shí)現(xiàn)方式的不同可以分為 JDK 動(dòng)態(tài)代理和 CGlib 動(dòng)態(tài)代理。

JDK 動(dòng)態(tài)代理：利用反射機(jī)制生成一個(gè)實(shí)現(xiàn)代理接口的類，在調(diào)用具體方法前調(diào)用InvokeHandler來(lái)處理。
CGlib 動(dòng)態(tài)代理：利用ASM（開源的Java字節(jié)碼編輯庫(kù)，操作字節(jié)碼）開源包，將代理對(duì)象類的class文件加載進(jìn)來(lái)，通過(guò)修改其字節(jié)碼生成子類來(lái)處理。

區(qū)別：JDK代理只能對(duì)實(shí)現(xiàn)接口的類生成代理；CGlib是針對(duì)類實(shí)現(xiàn)代理，對(duì)指定的類生成一個(gè)子類，并覆蓋其中的方法，這種通過(guò)繼承類的實(shí)現(xiàn)方式，不能代理final修飾的類。

2.1、JDK 動(dòng)態(tài)代理

還是以上面的例子為例：

首先，定一個(gè)類實(shí)現(xiàn) InvocationHandler 接口，并實(shí)現(xiàn) invoke 方法：

package com.sharpcj;

import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;

public class WorkInvocationHandler implements InvocationHandler {
    private Object object;

    public WorkInvocationHandler(Object object) {
        this.object = object;
    }

    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
        System.out.println("object: " + object.getClass().getSimpleName());
        System.out.println("proxy: " + proxy.getClass().getSimpleName());

        if ("meeting".equals(method.getName())) {
            System.out.println("代理先準(zhǔn)備會(huì)議材料...");
            return method.invoke(object, args);
        } else if ("evaluate".equals(method.getName())) {
            if(args[0] instanceof String) {
                if ("James".equals(args[0])) {
                    System.out.println("James 犯過(guò)錯(cuò)誤，所以考評(píng)分?jǐn)?shù)較低...");
                    return 70;
                }
            }
            return method.invoke(object, args);
        }
        return null;
    }
}

然后通過(guò) Proxy.newProxyInstance() 方法創(chuàng)建代理對(duì)象：

package com.sharpcj;

import java.lang.reflect.Proxy;

public class TestApp {
    public static void main(String[] args) {
        /*Leader leader = new Leader();
        Secretary secretary = new Secretary(leader);
        secretary.meeting();
        secretary.evaluate("Joy");*/

        Leader leader = new Leader();
        IWork proxy = (IWork) Proxy.newProxyInstance(Leader.class.getClassLoader(),
                new Class[]{IWork.class}, new WorkInvocationHandler(leader));
        proxy.meeting();
        proxy.evaluate("Joy");
        proxy.evaluate("James");
    }
}

輸出結(jié)果：

我們看到，通過(guò) WorkInvocationHandler 類，我們同樣可以代理 Leader 類的方法的實(shí)現(xiàn)，實(shí)際上我們實(shí)現(xiàn)的是任意的方法的實(shí)現(xiàn)，只是我們?cè)趧?chuàng)建代理對(duì)象的時(shí)候傳入的是 Iwork 接口以及 Leader 類對(duì)象。
這里需要注意的是：在 InvocationHandler 接口的 invoke 方法中第一個(gè)參數(shù) proxy, 并不是我們調(diào)用方法的對(duì)象，那這個(gè)參數(shù)是什么呢？代碼中，我特別增加相應(yīng)打印，打印出了 proxy 的類名，實(shí)際上 proxy 是代理對(duì)象本身，它的意義在于，我們可以在 invoke 方法中，返回該代理對(duì)象，然后進(jìn)行連續(xù)調(diào)用。

看如下例子：

package com.sharpcj.proxytest;

public interface IWork {
    IWork work(String subject);
}

package com.sharpcj.proxytest;

import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;

public class WorkInvocationHandler implements InvocationHandler {
    private Object object;

    public WorkInvocationHandler(Object object) {
        this.object = object;
    }

    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
        if ("work".equals(method.getName())){
            System.out.println("--- work: " + args[0]);
            return proxy;
        }
        return null;
    }
}

package com.sharpcj.proxytest;

import java.lang.reflect.Proxy;

public class TestApp {
    public static void main(String[] args) {
        IWork worker = (IWork) Proxy.newProxyInstance(IWork.class.getClassLoader(), new Class[]{IWork.class},
                new WorkInvocationHandler(new IWork() {
                    @Override
                    public IWork work(String subject) {
                        return null;
                    }
                }));
        worker.work("AAA").work("BBB").work("CCC");
    }
}

結(jié)果如下：

2.2、CGlib 動(dòng)態(tài)代理實(shí)現(xiàn)

首先添加 cglib 依賴

build.gradle 文件：

dependencies {
    // 引入 cglib 庫(kù)
    compile 'cglib:cglib:3.1'
    testCompile group: 'junit', name: 'junit', version: '4.12'
}

前面說(shuō)了，cglib 針對(duì)類進(jìn)行代理，我們以上面的 Leader 類為例，先創(chuàng)建一個(gè)類實(shí)現(xiàn) MethodInterceptor接口：

package com.sharpcj;

import net.sf.cglib.proxy.MethodInterceptor;
import net.sf.cglib.proxy.MethodProxy;

import java.lang.reflect.Method;

public class LeaderMethodInterceptor implements MethodInterceptor {
    @Override
    public Object intercept(Object o, Method method, Object[] objects, MethodProxy methodProxy) throws Throwable {
        if ("meeting".equals(method.getName())) {
            System.out.println("代理先準(zhǔn)備會(huì)議材料...");
            return methodProxy.invokeSuper(o, objects);
        } else if ("evaluate".equals(method.getName())) {
            if(objects[0] instanceof String) {
                if ("James".equals(objects[0])) {
                    System.out.println("James 犯過(guò)錯(cuò)誤，所以考評(píng)分?jǐn)?shù)較低...");
                    return 70;
                }
            }
            return methodProxy.invokeSuper(o, objects);
        }
        return null;
    }
}

測(cè)試代碼：

package com.sharpcj;

import net.sf.cglib.core.DebuggingClassWriter;
import net.sf.cglib.proxy.Enhancer;

import java.lang.reflect.Proxy;

public class TestApp {
    public static void main(String[] args) {
        // System.setProperty(DebuggingClassWriter.DEBUG_LOCATION_PROPERTY, "D:\\temp\\code");  //保存生成的 class 文件
        Enhancer enhancer = new Enhancer(); // 通過(guò)CGLIB動(dòng)態(tài)代理獲取代理對(duì)象的過(guò)程
        enhancer.setSuperclass(Leader.class); // 設(shè)置enhancer對(duì)象的父類
        enhancer.setCallback(new LeaderMethodInterceptor()); // 設(shè)置enhancer的回調(diào)對(duì)象
        Leader proxy= (Leader)enhancer.create(); // 創(chuàng)建代理對(duì)象

        // 通過(guò)代理對(duì)象調(diào)用目標(biāo)方法
        proxy.meeting();
        proxy.evaluate("Joy");
        proxy.evaluate("James");
    }
}

結(jié)果如下：