Java設計模式之代理模式詳解

目錄

一、代理模式

代理模式就是有一個(gè)張三，別人都沒(méi)有辦法找到他，只有他的秘書(shū)可以找到他。那其他人想和張三交互，只能通過(guò)他的秘書(shū)來(lái)進(jìn)行轉達交互。這個(gè)秘書(shū)就是代理者，他代理張三。

再看看另一個(gè)例子：賣(mài)房子

賣(mài)房子的步驟：

1.找買(mǎi)家

2.談價(jià)錢(qián)

3.簽合同

4.和房產(chǎn)局簽訂一些亂七八糟轉讓協(xié)議

一般賣(mài)家只在簽合同的時(shí)候可能出面一下，其他的1，2，4都由中介去做。那你問(wèn)這樣有什么用呢？

首先，一個(gè)中介可以代理多個(gè)賣(mài)房子的賣(mài)家，其次，我們可以在不修改賣(mài)家的代碼的情況下，給他實(shí)現房子加價(jià)、打廣告等等夾帶私貨的功能。

而Java的代理模式又分為靜態(tài)代理和動(dòng)態(tài)代理

二、靜態(tài)代理

靜態(tài)代理中存在著(zhù)以下的角色：

• 抽象角色：一般使用接口或者抽象類(lèi)實(shí)現（一般是真實(shí)角色和代理角色抽象出來(lái)的共同部分，比如賣(mài)房子的人和中介都有公共的方法賣(mài)房子）
• 真實(shí)角色：被代理的角色（表示一個(gè)具體的人，比如賣(mài)房子的張三）
• 代理角色：代理真實(shí)角色的中介，一般在代理真實(shí)角色后，會(huì )做一些附屬的操作
• 客戶(hù)：使用代理角色來(lái)進(jìn)行一些操作（買(mǎi)房子的）

代碼實(shí)現：

//接口(抽象角色)
public interface Singer{
	// 歌星要會(huì )唱歌
	void sing();
}

實(shí)體類(lèi)男歌手

//具體角色，男歌手
public class MaleSinger implements Singer{
    private String name;
    public MaleSinger(String name) {
        this.name = name;
    }
    @Override
    public void sing() {
        System.out.println(this.name+"男歌手在唱歌");
    }
}

歌手的經(jīng)紀人

//代理角色
public class Agent implements Singer{
    private MaleSinger singer; //代理角色要有一個(gè)被代理角色
    public Agent(MaleSinger singer) {
        this.singer = singer;
    }
    @Override
    public void sing() {
        System.out.println("協(xié)商出場(chǎng)費，做會(huì )場(chǎng)工作");
        //一定是被代理角色歌手去唱歌
        singer.sing();
        System.out.println("會(huì )場(chǎng)收拾，結算費用");
    }
}

客戶(hù)

//客戶(hù)
public class Client {
    public static void main(String[] args) {
        MaleSinger singer=new MaleSinger("周杰倫");
        Agent agent=new Agent(singer);
        agent.sing();//通過(guò)代理來(lái)運行唱歌
    }
}

可以看到抽象角色就包含了具體角色和代理角色公共的方法sing()。然后通過(guò)歌手的經(jīng)紀人在歌手唱歌的前后可以任意增加自己想要增加的代碼。從而達到不修改歌手類(lèi)方法的同時(shí)給唱歌增加新功能的目的。

說(shuō)白了。代理就是在不修改原來(lái)的代碼的情況下，給源代碼增強功能。

小結

靜態(tài)代理模式的主要優(yōu)點(diǎn)有：

• 代理模式在客戶(hù)端與目標對象之間起到一個(gè)中介作用和保護目標對象的作用（經(jīng)紀人保護周杰倫，外界不能直接接觸周杰倫）
• 代理對象可以擴展目標對象的功能（本來(lái)只能唱歌，現在又多了協(xié)商出場(chǎng)費，做會(huì )場(chǎng)工作等等功能）
• 代理模式能將客戶(hù)端與目標對象分離，在一定程度上降低了系統的耦合度，增加了程序的可擴展性

其主要缺點(diǎn)是：

• 代理模式會(huì )造成系統設計中類(lèi)的數量增加（多了個(gè)代理類(lèi)）
• 在客戶(hù)端和目標對象之間增加一個(gè)代理對象，會(huì )造成請求處理速度變慢（每次都要先找中介才能找到周杰倫）
• 增加了系統的復雜度（一開(kāi)始只是個(gè)獨立的流浪歌手，然后有了經(jīng)紀人后就十分復雜了）

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

靜態(tài)代理中，比如上述的例子，我們所寫(xiě)的經(jīng)紀人只能服務(wù)malesinger，不能再服務(wù)其他的類(lèi)型的歌手，這很不現實(shí)。因為經(jīng)紀人肯定能去服務(wù)不止一種歌手，甚至可能連歌手都不是，去服務(wù)跳舞的了。如果靜態(tài)代理中要實(shí)現這個(gè)結果，那我們要手動(dòng)編寫(xiě)好多個(gè)agent類(lèi)，十分繁瑣而復雜。所以就出現了動(dòng)態(tài)代理，動(dòng)態(tài)代理可以自動(dòng)生成代理人的代碼。

JDK原生的動(dòng)態(tài)代理

核心類(lèi)：InvocationHandler類(lèi)和Proxy類(lèi)

我們重新寫(xiě)一下Singer接口，給他多一個(gè)跳舞的方法

//歌手接口
public interface Singer2 {
    void sing();
    void dance();
}

當然對應的男歌手實(shí)現類(lèi)也要改變

//男歌手實(shí)現類(lèi)
public class MaleSinger2 implements Singer2 {
    private String name;

    public MaleSinger2(String name) {
        this.name = name;
    }

    @Override
    public void sing() {
        System.out.println(this.name+"在唱歌");
    }

    @Override
    public void dance() {
        System.out.println(this.name+"在跳舞");
    }
}

然后我們直接進(jìn)入客戶(hù)，測試。

import com.hj.Agent2;
import com.hj.MaleSinger2;
import com.hj.Singer2;

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

public class Client2 {
    public static void main(String[] args) {
        System.getProperties().put("sun.misc.ProxyGenerator.saveGeneratedFiles","true");//設置用于輸出jdk動(dòng)態(tài)代理產(chǎn)生的類(lèi)
        //簡(jiǎn)單例子，把所有東西放到一段來(lái)解釋
        System.out.println("實(shí)例1------------------------------------------------");
        MaleSinger2 maleSinger = new MaleSinger2("周杰倫");
        //新建代理實(shí)例
        //newProxyInstance(ClassLoader loader, 類(lèi)加載器，不懂的可以去看https://blog.csdn.net/Doraemon_Nobita/article/details/115702012?spm=1001.2014.3001.5501
        //Class<?>[] interfaces, 實(shí)現的接口，注意是個(gè)數組
        //InvocationHandler h 處理函數)
        Singer2 agent = (Singer2) Proxy.newProxyInstance(Client2.class.getClassLoader(),
                new Class[]{Singer2.class}, new InvocationHandler() {//匿名內部類(lèi)的方式實(shí)現InvocationHandler接口，對這個(gè)看不懂的可以參考https://blog.csdn.net/Doraemon_Nobita/article/details/115506705?spm=1001.2014.3001.5501
                    @Override
                    // 這個(gè)invoke就是我們調用agent.sing()后調用的方法
                    // invoke(Object proxy, 代理對象
                    // Method method, method是方法，即我們要調用的方法（是唱歌還是跳舞，在調用的時(shí)候會(huì )是sing()還是dance()）
                    // Object[] args 參數列表,可能你需要傳參)
                    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
                        System.out.println("協(xié)商出場(chǎng)費，做會(huì )場(chǎng)工作");
                        //關(guān)于invoke的講解，詳情可以參考：https://blog.csdn.net/Doraemon_Nobita/article/details/115702012?spm=1001.2014.3001.5501 調用指定的方法的那部分。
                        //invoke方法的參數，一個(gè)是Object類(lèi)型，也就是調用該方法的對象，
                        //第二個(gè)參數是一個(gè)可變參數類(lèi)型，也就是給這個(gè)方法的傳參,外層的這個(gè)已經(jīng)給我們封裝成args了，直接用就是了
                        Object invoke = method.invoke(maleSinger,args);//通過(guò)反射獲取到的method名我們再invoke激活一下，傳入要調用該方法的對象。這里用maleSinger
                        System.out.println("會(huì )場(chǎng)收拾，結算費用");
                        return invoke;
                    }
                });
        agent.sing();//可以調用到maleSinger的sing()
        agent.dance();//調用到maleSinger的dance()
        System.out.println("實(shí)例2------------------------------------------------");
        //這個(gè)簡(jiǎn)單例子不行啊，我還每次必須寫(xiě)死這里是maleSinger，以后想換別的還得改這里。動(dòng)態(tài)代理豈是如此不便之物。
        //所以我們直接實(shí)現一下InvocationHandler接口，取名為Agent2
        MaleSinger2 JayZ=new MaleSinger2("周杰倫");
        MaleSinger2 JJ =new MaleSinger2("林俊杰");
        Singer2 agentJJ=(Singer2) Proxy.newProxyInstance(Client2.class.getClassLoader(),
                new Class[]{Singer2.class}, new Agent2(JJ));
        Singer2 agentJayZ=(Singer2) Proxy.newProxyInstance(Client2.class.getClassLoader(),
                new Class[]{Singer2.class}, new Agent2(JayZ));
        //可以看到現在代理人創(chuàng  )建就十分方便了
        agentJJ.dance();
        agentJJ.sing();
        agentJayZ.sing();
        agentJayZ.dance();
    }
}

在第一個(gè)例子中，可以看到我們需要利用Proxy類(lèi)的newProxyInstance()方法就可以生成一個(gè)代理對象。而newProxyInstance()的參數又有類(lèi)加載器、實(shí)現的接口數組、以及InvocationHandler對象。在這里使用匿名內部類(lèi)來(lái)實(shí)現InvocationHandler接口。實(shí)現該接口需要實(shí)現他的invoke方法，這個(gè)方法就是我們代理對象調用原方法的時(shí)候會(huì )使用到的方法。區別于反射中的invoke方法，它有三個(gè)參數分別是代理對象，調用的方法，方法的參數數組。這里代理對象我們不管，調用的方法則是通過(guò)反射獲取到的我們使用該代理調用sing()方法或者dance()方法的方法名。通過(guò)反射中的invoke方法，可以運行這個(gè)指定的對象里方法名的方法。

而第二個(gè)例子中，為了實(shí)現可以代理任何類(lèi)，我們實(shí)現InvocationHandler接口，并把取類(lèi)名為Agent2。下面是Agent2的代碼。

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

public class Agent2 implements InvocationHandler {
    private Object object;//想代理誰(shuí)都可以，隨便啊

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

    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
        System.out.println("協(xié)商出場(chǎng)費，做會(huì )場(chǎng)工作");
        //一定是歌手去唱歌
        Object invoke = method.invoke(object,args);
        System.out.println("會(huì )場(chǎng)收拾，結算費用");
        return invoke;
    }
}

可以看出，這里和第一個(gè)例子的實(shí)現是差不多的，只不過(guò)我們使用Object類(lèi)來(lái)代替了之前的寫(xiě)死的MaleSinger類(lèi)，這樣我們就可以代理任何的類(lèi)型了，只要這個(gè)類(lèi)型需要我們在前后加"協(xié)商出場(chǎng)費，做會(huì )場(chǎng)工作"、“會(huì )場(chǎng)收拾，結算費用”。那可以看到第二個(gè)例子中，林俊杰和周杰倫的代理人可以很方便地創(chuàng )建出來(lái)，哪怕后面再實(shí)現了一個(gè)FemaleSinger類(lèi)，也可以直接生成他的代理人。

加了

System.getProperties().put("sun.misc.ProxyGenerator.saveGeneratedFiles","true");//設置用于輸出jdk動(dòng)態(tài)代理產(chǎn)生的類(lèi)這句代碼以后，我們就可以在項目中找到JDK自動(dòng)生成的代理類(lèi)代碼：

打開(kāi)可以看到就是自動(dòng)生成的一段幫我們寫(xiě)代理的方法。

可以看到就是調用了h.invoke，這個(gè)h就是我們傳參為InvocationHandler的對象，調用了我們自己寫(xiě)的invoke方法。

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

我們需要在maven配置文件中導入相應的包。在pom.xml文件里增加如下代碼：

<dependencies>
    <dependency>
        <groupId>cglib</groupId>
        <artifactId>cglib</artifactId>
        <version>3.3.0</version>
    </dependency>
</dependencies>

使用方法和JDK的動(dòng)態(tài)代理類(lèi)似，只是我們不需要再實(shí)現接口了，定義一個(gè)普通類(lèi)CglibMaleSinger.java

public class CglibMaleSinger {
    public CglibMaleSinger(String name) {
        this.name = name;
    }

    private String name;

    public CglibMaleSinger() {//注意這里一定要有無(wú)參構造器，不然之后會(huì )報錯Superclass has no null constructors but no arguments were given
    }

    public void sing(){
        System.out.println(this.name+"要去唱歌了");
    }
    public void dance(){
        System.out.println(this.name+"要去跳舞了");
    }
}

然后直接在客戶(hù)端測試：

import com.hj.CglibMaleSinger;
import net.sf.cglib.core.DebuggingClassWriter;
import net.sf.cglib.proxy.Enhancer;
import net.sf.cglib.proxy.MethodInterceptor;
import net.sf.cglib.proxy.MethodProxy;

import java.lang.reflect.Method;

public class CglibClient {
    public static void main(String[] args) {
        System.setProperty(DebuggingClassWriter.DEBUG_LOCATION_PROPERTY,"./class");//用于輸出生成的代理class文件,"./class"表示存儲在class文件夾中
        CglibMaleSinger JayZ=new CglibMaleSinger("周杰倫");
        Enhancer enhancer = new Enhancer();//定義一個(gè)增強器enhancer
        enhancer.setSuperclass(CglibMaleSinger.class);//設置其超類(lèi)，我們要代理哪個(gè)類(lèi)就傳哪個(gè)類(lèi)
        //MethodInterceptor是攔截器，就是把我的方法攔截住然后再去增強
        enhancer.setCallback(new MethodInterceptor() {//設置方法攔截器
            // o 是指被增強的對象，指自己
            // method是攔截后的方法，把父類(lèi)的方法攔截，增強后寫(xiě)在了子類(lèi)里
            // objs 參數
            // methodProxy 父類(lèi)的方法（攔截前的方法對象）
            @Override
            public Object intercept(Object o, Method method, Object[] objects, MethodProxy methodProxy) throws Throwable {
                System.out.println("談出場(chǎng)費");
                method.invoke(JayZ,objects);
                System.out.println("出場(chǎng)費談完了");
                return null;
            }
        });
        CglibMaleSinger cglibMaleSinger = (CglibMaleSinger)enhancer.create();
        cglibMaleSinger.sing();
        cglibMaleSinger.dance();
    }
}

和JDK的動(dòng)態(tài)代理使用方法基本一致，只是invoke方法變成了intercept方法而已。

加上System.setProperty(DebuggingClassWriter.DEBUG_LOCATION_PROPERTY,"存儲路徑");語(yǔ)句后，在你自己設置的存儲路徑下會(huì )出現一個(gè)包含生成的class文件的文件夾。

點(diǎn)開(kāi)hj文件夾下的.class文件

可以看到是繼承了我們的CglibMaleSinger類(lèi)，并且重寫(xiě)了我們的方法，重寫(xiě)內容中調用了intercept()方法。

小結

Java動(dòng)態(tài)代理只能夠對接口進(jìn)行代理，不能對普通類(lèi)進(jìn)行代理（因為所有生成的代理類(lèi)的父類(lèi)為Proxy，java不支持多重繼承）CGLIB可以代理普通類(lèi)Java動(dòng)態(tài)代理使用Java原生的反射API進(jìn)行操作，在生成類(lèi)上比較高效；而CGLIB使用ASM框架直接對字節碼（.class）改了，所以運行的時(shí)候是要比Java原生的效率要高些。

到此這篇關(guān)于Java設計模式之代理模式詳解的文章就介紹到這了,更多相關(guān)Java代理模式內容請搜索腳本之家以前的文章或繼續瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！