Java設(shè)計(jì)模式之代理模式
本文由老王出租房子引出——代理設(shè)計(jì)模式,將從最簡(jiǎn)單的靜態(tài)代理實(shí)現(xiàn)開(kāi)始,后延伸使用jdk實(shí)現(xiàn)動(dòng)態(tài)代理,最后擴(kuò)展到Cglib實(shí)現(xiàn)動(dòng)態(tài)代理。為了更深入理解代理模式,我們會(huì)對(duì)實(shí)際應(yīng)用中的典型案例進(jìn)行介紹,包括在Spring和Mybatis中的應(yīng)用。
讀者可以拉取完整代碼到本地進(jìn)行學(xué)習(xí),實(shí)現(xiàn)代碼均測(cè)試通過(guò)后上傳到碼云,本地源碼下載。
一、引出問(wèn)題
上篇文章老王和小王組裝電腦雖然完美結(jié)束了,但是老王和小王的爭(zhēng)吵卻并沒(méi)有結(jié)束。老王決定將小王掃地出門(mén),并把小王住的房子出租,租金用來(lái)彌補(bǔ)游戲本的花銷。
老王花費(fèi)很大的功夫,搞清楚了各種租房平臺(tái)的規(guī)則并發(fā)布了房源信息,接著鄰居提醒他:房子租出去并不代表躺著收租金了,有一天租客提出一些額外的要求,在合同允許的范圍內(nèi),你也要盡量滿足他們(為了便于理解,現(xiàn)實(shí)當(dāng)然不存在啦),房子租出去后物業(yè)有問(wèn)題你還要和物業(yè)協(xié)調(diào)。
老王開(kāi)始思考,如果我直租給租客,會(huì)面臨兩個(gè)問(wèn)題:
①我需要了解租房的全過(guò)程,我自己的事和租房的事嚴(yán)重的耦合了。
②租客提出的一些要求我不得不介入到其中,我不得不改變我自己的行程安排。
我應(yīng)該想到一種辦法,
第一點(diǎn),將業(yè)務(wù)和功能解耦,業(yè)務(wù)層專注業(yè)務(wù),比如網(wǎng)絡(luò)接口請(qǐng)求,業(yè)務(wù)層只需要知道該調(diào)哪個(gè)接口請(qǐng)求方法,而不需要知道這個(gè)接口請(qǐng)求是如何發(fā)起網(wǎng)絡(luò)請(qǐng)求的。
第二點(diǎn),創(chuàng)建一個(gè)切面,在這個(gè)切面中增加一些通用的附加操作,比如注解解析,日志上報(bào)等,避免這些通用操作在每個(gè)接口方法都要寫(xiě)一遍。
老王靈感一閃:我可以給我的房子找一個(gè)一個(gè)代理,以控制對(duì)這個(gè)房子的管理。即通過(guò)代理管理房子.這樣做的好處是:可以在目標(biāo)實(shí)現(xiàn)的基礎(chǔ)上,增強(qiáng)額外的功能操作,即擴(kuò)展目標(biāo)的功能。
這實(shí)際上就是靜態(tài)代理。
二、靜態(tài)代理
代理模式:為一個(gè)對(duì)象提供一個(gè)替身,以控制對(duì)這個(gè)對(duì)象的訪問(wèn)。即通過(guò)代理對(duì)象訪問(wèn)目標(biāo)對(duì)象.這樣做的好處是:可以在目標(biāo)對(duì)象實(shí)現(xiàn)的基礎(chǔ)上,增強(qiáng)額外的功能操作,即擴(kuò)展目標(biāo)對(duì)象的功能。
也即在靜態(tài)代理中應(yīng)該有三個(gè)角色:
①代理對(duì)象,消費(fèi)端通過(guò)它來(lái)訪問(wèn)實(shí)際的對(duì)象(中介)
②實(shí)際被代理的對(duì)象(老王房子)
③一組可以被代理的行為的集合,通常是一個(gè)接口(老王和中介之間的約定事件)
老王與中介的約定接口:
/** * 代理行為的集合(接口) * @author tcy * @Date 02-08-2022 */ public interface HostAgreement { // 房子出租 void rent(); }
實(shí)際對(duì)象類(老王):
/** * 目標(biāo)對(duì)象 * @author tcy * @Date 02-08-2022 */ public class Host implements HostAgreement { /** * 目標(biāo)對(duì)象的原始方法 */ @Override public void rent() { System.out.println(" 這個(gè)房子要出租..."); } }
代理類(中介):
/** * 實(shí)際對(duì)象的代理 * @author tcy * @Date 02-08-2022 */ public class HostProxy implements HostAgreement { // 目標(biāo)對(duì)象,通過(guò)接口來(lái)聚合 private HostAgreement target; //構(gòu)造器 public HostProxy(HostAgreement target) { this.target = target; } @Override public void rent() { System.out.println("房子出租前,裝修一下...."); target.rent(); System.out.println("房子出租后,與物業(yè)協(xié)調(diào)....");//方法 } }
客戶類:
/** * @author tcy * @Date 02-08-2022 */ public class Client { public static void main(String[] args) { //創(chuàng)建目標(biāo)對(duì)象(被代理對(duì)象) Host hostTarget = new Host(); //創(chuàng)建代理對(duì)象, 同時(shí)將被代理對(duì)象傳遞給代理對(duì)象 HostProxy hostProxy = new HostProxy(hostTarget); //通過(guò)代理對(duì)象,調(diào)用到被代理對(duì)象的方法 hostProxy.rent(); } }
這樣就很好的解決了老王想到的問(wèn)題,老王心滿意足的看著自己的成果。
但中介看著老王的方案開(kāi)始小聲的嘀咕了,我一個(gè)人管那么多的房子,每一個(gè)房東都讓我實(shí)現(xiàn)一個(gè)代理類,那我就會(huì)有很多的代理類,這是個(gè)問(wèn)題呀!還有就是,有一天協(xié)議變動(dòng)了,我們倆都要做許多工作。
最好是不要讓我實(shí)現(xiàn)我們之間的協(xié)議(接口)了。
老王開(kāi)始改造他的方案了。
三、動(dòng)態(tài)代理Jdk
老王突然想到,使用jdk的動(dòng)態(tài)代理可以很好的解決這個(gè)問(wèn)題。
Jdk代理對(duì)象的生成,是利用JDK的API,動(dòng)態(tài)的在內(nèi)存中構(gòu)建代理對(duì)象動(dòng)態(tài)代理,也叫做:JDK代理、接口代理。
我們對(duì)代碼進(jìn)行改造。
目標(biāo)對(duì)象和目標(biāo)對(duì)象的協(xié)議保持不變,我們需要修改也就是中介(代理類)的代碼。
代理類:
/** * 代理類 * @author tcy * @Date 02-08-2022 */ public class HostProxy { //維護(hù)一個(gè)目標(biāo)對(duì)象 , Object private Object target; //構(gòu)造器 , 對(duì)target 進(jìn)行初始化 public HostProxy(Object target) { this.target = target; } //給目標(biāo)對(duì)象 生成一個(gè)代理對(duì)象 public Object getProxyInstance() { //說(shuō)明 /* * //1. ClassLoader loader : 指定當(dāng)前目標(biāo)對(duì)象使用的類加載器, 獲取加載器的方法固定 //2. Class<?>[] interfaces: 目標(biāo)對(duì)象實(shí)現(xiàn)的接口類型,使用泛型方法確認(rèn)類型 //3. InvocationHandler h : 事情處理,執(zhí)行目標(biāo)對(duì)象的方法時(shí),會(huì)觸發(fā)事情處理器方法, 會(huì)把當(dāng)前執(zhí)行的目標(biāo)對(duì)象方法作為參數(shù)傳入 */ return Proxy.newProxyInstance(target.getClass().getClassLoader(), target.getClass().getInterfaces(), new InvocationHandler() { /** * 該方法會(huì)調(diào)用目標(biāo)對(duì)象的方法 * @param proxy * @param method * @param args * @return * @throws Throwable */ @Override public Object invoke(Object proxy, Method method, Object[] args) throws Throwable { System.out.println("房子出租前,裝修一下...."); //反射機(jī)制調(diào)用目標(biāo)對(duì)象的方法 Object returnVal = method.invoke(target, args); System.out.println("房子出租后,與物業(yè)協(xié)調(diào)...."); return returnVal; } }); } }
客戶端:
/** * @author tcy * @Date 02-08-2022 */ public class Client { public static void main(String[] args) { //創(chuàng)建目標(biāo)對(duì)象 HostAgreement hostAgreement = new Host(); //給目標(biāo)對(duì)象,創(chuàng)建代理對(duì)象, 可以轉(zhuǎn)成 ITeacherDao HostAgreement hostProxy = (HostAgreement)new HostProxy(hostAgreement).getProxyInstance(); // proxyInstance=class com.sun.proxy.$Proxy0 內(nèi)存中動(dòng)態(tài)生成了代理對(duì)象 //通過(guò)代理對(duì)象,調(diào)用目標(biāo)對(duì)象的方法 hostProxy.rent(); } }
這樣就很好的解決了中介實(shí)現(xiàn)協(xié)議(接口)的問(wèn)題,無(wú)論房子怎么變化,中介都能很完美的實(shí)現(xiàn)代理。
中介想讓老王給他講講,Proxy.newProxyInstance()怎么就能完美的解決這個(gè)問(wèn)題了。
老王擼起袖子開(kāi)始給他講實(shí)現(xiàn)原理。
在我們用Proxy.newProxyInstance實(shí)現(xiàn)動(dòng)態(tài)代理的時(shí)候,有三個(gè)參數(shù),第一個(gè)便是classloader。
public static Object newProxyInstance(ClassLoader loader, Class<?>[] interfaces, InvocationHandler h)
在我們的代碼中classloader就是目標(biāo)對(duì)象的類加載器。
第二個(gè)參數(shù)是 目標(biāo)對(duì)象實(shí)現(xiàn)的接口類型,使用泛型方法確認(rèn)類型,我們使用java的反射target.getClass().getInterfaces()獲取到了接口類型。
第三個(gè)參數(shù)是實(shí)現(xiàn)InvocationHandler接口,并實(shí)現(xiàn)它唯一的方法invoke(),invoke其實(shí)就會(huì)執(zhí)行我們的目標(biāo)方法,我們就可以在invoke前后去做一些事。比如,房子出租前,裝修一下或者房子出租后,與物業(yè)協(xié)調(diào)。
中介聽(tīng)完心滿意足的離開(kāi)了,老王總覺(jué)得哪里不對(duì),中介都從協(xié)議中抽出來(lái)了,那我為什么還要被協(xié)議約束著呢?我何不也從協(xié)議(接口)中抽離出來(lái)。
我們查閱書(shū)籍覺(jué)得Cglib或許能幫到他。
四、動(dòng)態(tài)代理Cglib
1、概念及實(shí)現(xiàn)
CGLIB是一個(gè)強(qiáng)大的、高性能的代碼生成庫(kù)。采用非常底層的字節(jié)碼技術(shù),對(duì)指定目標(biāo)類生成一個(gè)子類,并對(duì)子類進(jìn)行增強(qiáng),其被廣泛應(yīng)用于AOP框架(Spring、dynaop)中,用以提供方法攔截操作。
CGLIB代理主要通過(guò)對(duì)字節(jié)碼的操作,為對(duì)象引入間接級(jí)別,以控制對(duì)象的訪問(wèn)。我們知道Java中有一個(gè)動(dòng)態(tài)代理也是做這個(gè)事情的,那我們?yōu)槭裁床恢苯邮褂肑ava動(dòng)態(tài)代理,而要使用CGLIB呢?答案是CGLIB相比于JDK動(dòng)態(tài)代理更加強(qiáng)大,JDK動(dòng)態(tài)代理雖然簡(jiǎn)單易用,但是其有一個(gè)致命缺陷是,只能對(duì)接口進(jìn)行代理。如果要代理的類為一個(gè)普通類、沒(méi)有接口,那么Java動(dòng)態(tài)代理就沒(méi)法使用了。
老王覺(jué)得這些概念都不說(shuō)人話,不如老王直接著手改造項(xiàng)目。
CGLIB是一個(gè)第三方的類庫(kù),首先需要引入依賴。
<dependency> <groupId>cglib</groupId> <artifactId>cglib</artifactId> <version>2.2.2</version> </dependency>
現(xiàn)在只需要兩個(gè)角色即可,代理類和目標(biāo)類。
目標(biāo)類:
/** * @author tcy * @Date 02-08-2022 */ public class Host { /** * 租房方法 */ public void rent() { System.out.println("這個(gè)房子要出租..."); } }
代理類:
/** * 代理類 * @author tcy * @Date 02-08-2022 */ public class HostProxy implements MethodInterceptor { //維護(hù)一個(gè)目標(biāo)對(duì)象 private Object target; //構(gòu)造器,傳入一個(gè)被代理的對(duì)象 public HostProxy(Object target) { this.target = target; } //返回一個(gè)代理對(duì)象: 是 target 對(duì)象的代理對(duì)象 public Object getProxyInstance() { //1. 創(chuàng)建一個(gè)工具類 Enhancer enhancer = new Enhancer(); //2. 設(shè)置父類 enhancer.setSuperclass(target.getClass()); //3. 設(shè)置回調(diào)函數(shù) enhancer.setCallback(this); //4. 創(chuàng)建子類對(duì)象,即代理對(duì)象 return enhancer.create(); } @Override public Object intercept(Object o, Method method, Object[] args, MethodProxy methodProxy) throws Throwable { System.out.println("房子出租前,裝修一下...."); Object returnVal = method.invoke(target, args); System.out.println("房子出租后,與物業(yè)協(xié)調(diào)...."); return returnVal; } }
客戶類:
/** * @author tcy * @Date 02-08-2022 */ public class Client { public static void main(String[] args) { //創(chuàng)建目標(biāo)對(duì)象 Host HostTarget = new Host(); //獲取到代理對(duì)象,并且將目標(biāo)對(duì)象傳遞給代理對(duì)象 Host Hostproxy = (Host)new HostProxy(HostTarget).getProxyInstance(); //執(zhí)行代理對(duì)象的方法,觸發(fā)intecept 方法,從而實(shí)現(xiàn) 對(duì)目標(biāo)對(duì)象的調(diào)用 Hostproxy.rent(); } }
現(xiàn)在不僅老王和中介都不需要實(shí)現(xiàn)接口了,而且完美的實(shí)現(xiàn)了他們之間的功能。
jdk和CGLIB實(shí)現(xiàn)動(dòng)態(tài)代理的區(qū)別我們對(duì)比一下:
2、JDK動(dòng)態(tài)代理與CGLIB對(duì)比
JDK動(dòng)態(tài)代理:基于Java反射機(jī)制實(shí)現(xiàn),必須要實(shí)現(xiàn)了接口的業(yè)務(wù)類才生成代理對(duì)象。
CGLIB動(dòng)態(tài)代理:基于ASM機(jī)制實(shí)現(xiàn),通過(guò)生成業(yè)務(wù)類的子類作為代理類。
JDK Proxy的優(yōu)勢(shì):
最小化依賴關(guān)系、代碼實(shí)現(xiàn)簡(jiǎn)單、簡(jiǎn)化開(kāi)發(fā)和維護(hù)、JDK原生支持,比CGLIB更加可靠,隨JDK版本平滑升級(jí)。而字節(jié)碼類庫(kù)通常需要進(jìn)行更新以保證在新版Java上能夠使用。
基于CGLIB的優(yōu)勢(shì):
無(wú)需實(shí)現(xiàn)接口,達(dá)到代理類無(wú)侵入,只操作關(guān)心的類,而不必為其他相關(guān)類增加工作量。高性能。
靜態(tài)代理和JDK代理模式都要求目標(biāo)對(duì)象是實(shí)現(xiàn)一個(gè)接口,但是有時(shí)候目標(biāo)對(duì)象只是一個(gè)單獨(dú)的對(duì)象,并沒(méi)有實(shí)現(xiàn)任何的接口,這個(gè)時(shí)候可使用目標(biāo)對(duì)象子類來(lái)實(shí)現(xiàn)代理-這就是Cglib。
為了讓代理模式理解的更加深刻,我們來(lái)看代理模式在兩個(gè)經(jīng)典框架SpringAop和Mybtis中的應(yīng)用。
五、典型應(yīng)用
1、在SpringAop的運(yùn)用
動(dòng)態(tài)代理一個(gè)顯著的作用就是,在不改變目標(biāo)對(duì)象的前提下,能增強(qiáng)目標(biāo)對(duì)象的功能,這其實(shí)就是AOP的核心。
AOP(Aspect Oriented Programming)是基于切面編程的,可無(wú)侵入的在原本功能的切面層添加自定義代碼,一般用于日志收集、權(quán)限認(rèn)證等場(chǎng)景。
SpringAop同時(shí)實(shí)現(xiàn)了Jdk的動(dòng)態(tài)代理和Cglib的動(dòng)態(tài)代理。
運(yùn)用動(dòng)態(tài)代理直接作用到需要增強(qiáng)的方法上面,而不改變我們?cè)镜臉I(yè)務(wù)代碼。
2、在MyBatis的運(yùn)用
在Mybitis實(shí)現(xiàn)的是Jdk的動(dòng)態(tài)代理。
源碼中有一個(gè)MapperProxyFactory類,其中有一個(gè)方法。
//構(gòu)建handler的過(guò)程。 protected T newInstance(MapperProxy<T> mapperProxy) { //標(biāo)準(zhǔn)的類加載器,接口,以及invocationHandler接口實(shí)現(xiàn)。 return (T) Proxy.newProxyInstance(mapperInterface.getClassLoader(), new Class[] { mapperInterface }, mapperProxy); }
Proxy.newProxyInstance()正是我們?cè)贘dk動(dòng)態(tài)代理中的使用。
結(jié)合典型應(yīng)用,認(rèn)真體會(huì)動(dòng)態(tài)代理設(shè)計(jì)模式,參考軟件設(shè)計(jì)七大原則 在實(shí)際應(yīng)用中更加靈活的使用,不生搬硬套。
以上就是這篇文章的全部?jī)?nèi)容了,希望本文的內(nèi)容對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,謝謝大家對(duì)腳本之家的支持。如果你想了解更多相關(guān)內(nèi)容請(qǐng)查看下面相關(guān)鏈接
相關(guān)文章
java 定時(shí)同步數(shù)據(jù)的任務(wù)優(yōu)化
這篇文章主要介紹了java 定時(shí)同步數(shù)據(jù)的任務(wù)優(yōu)化,幫助大家更好的理解和使用Java,感興趣的朋友可以了解下2020-12-12SpringBoot ApplicationContextAware拓展接口使用詳解
當(dāng)一個(gè)類實(shí)現(xiàn)了這個(gè)接口(ApplicationContextAware)之后,這個(gè)類就可以方便獲得ApplicationContext中的所有bean。換句話說(shuō),就是這個(gè)類可以直接獲取spring配置文件中,所有有引用到的bean對(duì)象2023-04-04Java編程中靜態(tài)內(nèi)部類與同步類的寫(xiě)法示例
這篇文章主要介紹了Java編程中靜態(tài)內(nèi)部類與同步類的寫(xiě)法示例,用于構(gòu)建靜態(tài)對(duì)象以及實(shí)現(xiàn)線程同步等,需要的朋友可以參考下2015-09-09多模塊maven的deploy集成gitlab?ci自動(dòng)發(fā)版配置
這篇文章主要為大家介紹了多模塊maven項(xiàng)目deploy集成gitlab?ci自動(dòng)發(fā)版的配置流程步驟,有需要的朋友可以借鑒參考下,希望能夠有所幫助2022-02-02SpringCloud Zuul實(shí)現(xiàn)動(dòng)態(tài)路由
這篇文章主要介紹了SpringCloud Zuul實(shí)現(xiàn)動(dòng)態(tài)路由,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2019-01-01java操作mongodb基礎(chǔ)(查詢 排序 輸出list)
java操作mongodb基礎(chǔ)學(xué)習(xí)查詢,排序,limit,輸出為list實(shí)例,大家參考使用吧2013-12-12MyBatis常用動(dòng)態(tài)sql大總結(jié)
這篇文章主要給大家介紹了關(guān)于MyBatis常用動(dòng)態(tài)sql的相關(guān)資料,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2021-05-05