文章目录
- 1 代理模式(Proxy Pattern)
- 1.1 介绍
- 1.2 概述
- 1.3 代理模式的结构
- 2 静态代理
- 2.1 介绍
- 2.2 案例——静态代理
- 2.3 代码实现
- 3 JDK动态代理★★★
- 3.1 介绍
- 3.2 代码实现
- 3.3 解析代理类
- 3.3.1 思考
- 3.3.2 使用 Arthas 解析代理类
- 3.3.3 结论
- 3.4 动态代理的执行流程
- 4 CGLIB动态代理★
- 4.1 介绍
- 4.2 代码实现
- 5 总结
- 5.1 三种代理的对比
- 5.1.1 jdk代理 VS CGLIB代理
- 5.1.2 动态代理 VS 静态代理
- 5.2 代理模式的优缺点
- 5.2.1 优点
- 5.2.2 缺点
- 5.3 代理模式的使用场景
🙊 前言:本文章为瑞_系列专栏之《23种设计模式》的代理模式篇。本文中的部分图和概念等资料,来源于博主学习设计模式的相关网站《菜鸟教程 | 设计模式》和《黑马程序员Java设计模式详解》,特此注明。本文中涉及到的软件设计模式的概念、背景、优点、分类、以及UML图的基本知识和设计模式的6大法则等知识,建议阅读 《瑞_23种设计模式_概述》
本系列 - 设计模式 - 链接:《瑞_23种设计模式_概述》
⬇️本系列 - 创建型模式 - 链接🔗单例模式:《瑞_23种设计模式_单例模式》
工厂模式:《瑞_23种设计模式_工厂模式》
原型模式:《瑞_23种设计模式_原型模式》
抽象工厂模式:《瑞_23种设计模式_抽象工厂模式》
建造者模式:《瑞_23种设计模式_建造者模式》⬇️本系列 - 结构型模式 - 链接🔗
代理模式:《瑞_23种设计模式_代理模式》
适配器模式:《后续更新》
装饰者模式:《后续更新》
桥接模式:《后续更新》
外观模式:《后续更新》
组合模式:《后续更新》
享元模式:《后续更新》⬇️本系列 - 行为型模式 - 链接🔗
模板方法模式:《后续更新》
策略模式:《后续更新》
命令模式:《后续更新》
职责链模式:《后续更新》
状态模式:《后续更新》
观察者模式:《后续更新》
中介者模式:《后续更新》
迭代器模式:《后续更新》
访问者模式:《后续更新》
备忘录模式:《后续更新》
解释器模式:《后续更新》
1 代理模式(Proxy Pattern)
在代理模式(Proxy Pattern)中,一个类代表另一个类的功能。这种类型的设计模式属于结构型模式。
在代理模式中,我们创建具有现有对象的对象,以便向外界提供功能接口。
瑞:结构型模式描述如何将类或对象按某种布局组成更大的结构。它分为类结构型模式和对象结构型模式,前者采用继承机制来组织接口和类,后者釆用组合或聚合来组合对象。由于组合关系或聚合关系比继承关系耦合度低,满足“合成复用原则”,所以对象结构型模式比类结构型模式具有更大的灵活性。
1.1 介绍
-
意图:为其他对象提供一种代理以控制对这个对象的访问。
-
主要解决:在直接访问对象时带来的问题,比如说:要访问的对象在远程的机器上。在面向对象系统中,有些对象由于某些原因(比如对象创建开销很大,或者某些操作需要安全控制,或者需要进程外的访问),直接访问会给使用者或者系统结构带来很多麻烦,我们可以在访问此对象时加上一个对此对象的访问层。
-
何时使用:想在访问一个类时做一些控制。
-
如何解决:增加中间层。
-
关键代码:实现与被代理类组合。
-
应用实例:
1️⃣ Windows 里面的快捷方式。
2️⃣ 猪八戒去找高翠兰结果是孙悟空变的,可以这样理解:把高翠兰的外貌抽象出来,高翠兰本人和孙悟空都实现了这个接口,猪八戒访问高翠兰的时候看不出来这个是孙悟空,所以说孙悟空是高翠兰代理类。
3️⃣ 买火车票不一定在火车站买,也可以去代售点。
4️⃣ 一张支票或银行存单是账户中资金的代理。支票在市场交易中用来代替现金,并提供对签发人账号上资金的控制。
5️⃣ Spring AOP -
优点:
1️⃣ 职责清晰
2️⃣ 高扩展性
3️⃣ 智能化 -
缺点:
1️⃣ 由于在客户端和真实主题之间增加了代理对象,因此有些类型的代理模式可能会造成请求的处理速度变慢。
2️⃣ 实现代理模式需要额外的工作,有些代理模式的实现非常复杂。 -
使用场景:按职责来划分,通常有以下使用场景:
1️⃣ 远程代理。
2️⃣ 虚拟代理。
3️⃣ Copy-on-Write 代理。
4️⃣ 保护(Protect or Access)代理。
5️⃣ Cache代理。
6️⃣ 防火墙(Firewall)代理。
7️⃣ 同步化(Synchronization)代理。
8️⃣ 智能引用(Smart Reference)代理。 -
注意事项:
1️⃣ 和适配器模式的区别:适配器模式主要改变所考虑对象的接口,而代理模式不能改变所代理类的接口。
2️⃣ 和装饰器模式的区别:装饰器模式为了增强功能,而代理模式是为了加以控制。
1.2 概述
由于某些原因需要给某对象提供一个代理以控制对该对象的访问。这时,访问对象不适合或者不能直接引用目标对象,代理对象作为访问对象和目标对象之间的中介。
Java中的代理按照代理类生成时机不同又分为静态代理和动态代理。静态代理代理类在编译期就生成,而动态代理代理类则是在Java运行时动态生成。动态代理又有JDK代理和CGLib代理两种。
1.3 代理模式的结构
- 代理(Proxy)模式分为三种角色:
1️⃣ 抽象主题(Subject)类: 通过接口或抽象类声明真实主题和代理对象实现的业务方法。
2️⃣ 真实主题(Real Subject)类: 实现了抽象主题中的具体业务,是代理对象所代表的真实对象,是最终要引用的对象。
3️⃣ 代理(Proxy)类 : 提供了与真实主题相同的接口,其内部含有对真实主题的引用,它可以访问、控制或扩展真实主题的功能。
2 静态代理
2.1 介绍
在静态代理中,代理类通常在编译时就已经确定,它会实现与被代理类相同的接口,并在内部持有被代理类的实例。代理类可以在调用被代理类的方法前后添加额外的行为,比如安全检查、日志记录或者其他的预处理和后处理操作。这种代理方式被称为“静态”的,因为代理类是在编译时就定义好的,而不是在运行时动态生成的。
具体来说,静态代理的特点包括:
- 接口实现:代理类和被代理类都实现相同的接口。
- 明确的代理关系:代理类和被代理类之间的关系在编译时就已经确定。
- 代码编写:需要为每一个被代理的类编写一个对应的代理类。
- 透明性:对于使用代理类的客户端来说,代理类和被代理类在接口层面上是一致的,客户端可以不感知代理的存在。
总的来说,静态代理是一种简单直接的代理实现方式,适用于代理关系比较明确且变化不大的场景。
2.2 案例——静态代理
【案例】火车站卖票
如果要买火车票的话,需要去火车站买票,坐车到火车站,排队等一系列的操作,显然比较麻烦。而火车站在多个地方都有代售点,我们去代售点买票就方便很多了。这个例子其实就是典型的代理模式,火车站是目标对象,代售点是代理对象。类图如下:
2.3 代码实现
/*** 卖火车票的接口 - 抽象主题类** @author LiaoYuXing-Ray**/
public interface SellTickets {void sell();
}
/*** 火车站类 - 具体主题类** @author LiaoYuXing-Ray**/
public class TrainStation implements SellTickets {// 火车站具有卖票功能,所以需要实现SellTickets接口public void sell() {System.out.println("火车站卖票");}
}
/*** 代售点类 - 代理类** @author LiaoYuXing-Ray**/
public class ProxyPoint implements SellTickets {// 声明火车站类对象private final TrainStation trainStation = new TrainStation();public void sell() {System.out.println("代售点收取一些服务费用");trainStation.sell();}}
/*** 测试类** @author LiaoYuXing-Ray**/
public class Client {public static void main(String[] args) {// 创建代售点类对象ProxyPoint proxyPoint = new ProxyPoint();// 调用方法进行买票proxyPoint.sell();}
}
测试类运行结果⬇️
代售点收取一些服务费用火车站卖票
从上面代码中可以看出测试类直接访问的是ProxyPoint类对象,也就是说ProxyPoint作为访问对象和目标对象的中介。同时也对sell方法进行了增强(代理点收取一些服务费用)。
3 JDK动态代理★★★
瑞:JDK必须定义接口才能动态代理,在没有接口的时候就可以使用CGLIB动态代理
3.1 介绍
JDK动态代理是利用Java反射机制在运行时动态生成代理类的代理模式。
JDK动态代理主要涉及两个类:java.lang.reflect.Proxy
和 java.lang.reflect.InvocationHandler
。其中,Proxy 类提供了用于创建动态代理的静态方法,InvocationHandler 接口则负责定义代理对象调用目标方法时的具体行为。
注意:Java中提供的动态代理类Proxy并不是结构章节中所说的代理对象的类,而是提供了一个创建代理对象的静态方法(
Proxy.newProxyInstance
方法)来获取代理对象。
JDK动态代理的特点包括:
- 接口实现:JDK动态代理要求被代理的目标对象必须实现一个或多个接口。这是因为动态代理是通过接口来统一不同类的相同行为的。
- 代理生成:通过Proxy.newProxyInstance方法可以创建一个实现了指定接口的代理对象。这个方法需要三个参数:一个类加载器、一个接口数组以及一个实现了InvocationHandler接口的调用处理器。
- 调用处理:当代理对象的方法被调用时,会转而调用InvocationHandler的invoke方法。在这个方法中,你可以进行前置处理,比如日志记录、权限校验等,然后调用目标对象的相应方法,最后执行后置处理。
- 透明性与限制:对于使用代理对象的客户端来说,代理对象和真实对象在使用上是透明的,因为它们都实现了相同的接口。但是,JDK动态代理的一个限制是它只能代理接口,不能代理没有实现接口的类。
- 性能考虑:由于JDK动态代理是基于反射机制的,可能会有一定的性能开销。在对性能要求极高的场景中,可能需要考虑其他代理方式或者优化策略。
总的来说,JDK动态代理是一种灵活且功能强大的代理技术,它允许在不修改原有代码的基础上,为对象的方法调用添加额外的行为。尽管它有一些限制,比如只能代理接口,但它仍然是Java开发中常用的一种动态代理方式。
3.2 代码实现
接下来我们使用动态代理实现静态代理中的案例
/*** 卖火车票的接口 - 抽象主题类** @author LiaoYuXing-Ray**/
public interface SellTickets {void sell();
}
/*** 火车站类 - 具体主题类** @author LiaoYuXing-Ray**/
public class TrainStation implements SellTickets {// 火车站具有卖票功能,所以需要实现SellTickets接口public void sell() {System.out.println("火车站卖票");}
}
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;/*** 获取代理对象的工厂类* 代理类也实现了对应的接口* ProxyFactory不是代理模式中所说的代理类,而代理类是程序在运行过程中动态的在内存中生成的类** @author LiaoYuXing-Ray**/
public class ProxyFactory {// 声明目标对象private final TrainStation station = new TrainStation();// 获取代理对象的方法public SellTickets getProxyObject() {// 返回代理对象/*ClassLoader loader : 类加载器,用于加载代理类。可以通过目标对象获取类加载器Class<?>[] interfaces : 代理类实现的接口的字节码对象InvocationHandler h : 代理对象的调用处理程序*/SellTickets proxyObject = (SellTickets) Proxy.newProxyInstance(station.getClass().getClassLoader(),station.getClass().getInterfaces(),new InvocationHandler() {/*Object proxy : 代理对象。和proxyObject对象是同一个对象,在invoke方法中基本不用Method method : 对接口中的方法进行封装的method对象Object[] args : 调用方法的实际参数返回值: 方法的返回值。*/@Overridepublic Object invoke(Object proxy, Method method, Object[] args) throws Throwable {// System.out.println("invoke方法执行了");System.out.println("代售点收取一定的服务费用(jdk动态代理)");// 执行目标对象的方法return method.invoke(station, args);}});return proxyObject;}
}
/*** 测试类** @author LiaoYuXing-Ray**/
public class Client {public static void main(String[] args) {// 获取代理对象// 1.创建代理工厂对象ProxyFactory factory = new ProxyFactory();// 2.使用factory对象的方法获取代理对象SellTickets proxyObject = factory.getProxyObject();// 3.调用卖调用的方法proxyObject.sell();}
}
测试类运行结果⬇️
代售点收取一定的服务费用(jdk动态代理)火车站卖票
3.3 解析代理类
3.3.1 思考
上一小节的代码实现使用了动态代理,但请思考:ProxyFactory是代理类吗?
❌ProxyFactory不是代理模式中所说的代理类❌,代理类是程序在运行过程中动态的在内存中生成的类。
3.3.2 使用 Arthas 解析代理类
下面我们通过阿里巴巴开源的 Java 诊断工具(Arthas【阿尔萨斯】)查看真正的代理类$Proxy0
的结构:
对测试类进行修改,方便解析,测试类修改后的代码如下:
/*** 测试类** @author LiaoYuXing-Ray**/
public class Client {public static void main(String[] args) {// 获取代理对象// 1.创建代理工厂对象ProxyFactory factory = new ProxyFactory();// 2.使用factory对象的方法获取代理对象SellTickets proxyObject = factory.getProxyObject();// 3.调用卖调用的方法proxyObject.sell();System.out.println("代理类的完全限定名:" + proxyObject.getClass()); // com.sun.proxy.$Proxy0// 让程序一直执行,是为了使用Arthas【阿尔萨斯】查看代理类的结构while (true) {try {Thread.sleep(1000);} catch (InterruptedException e) {e.printStackTrace();}}}
}
瑞:类.class.getName() 方法的作用是获取类的完全限定名(Fully Qualified Name)包名加上类名通常被称为类的完全限定名。在Java中,每个类都有一个完全限定名,它由包名和类名组成,包名和类名之间用.分隔。例如,如果一个类MyClass位于包com.example下,那么它的完全限定名就是com.example.MyClass。
运行测试类,启动 Arthas ,步骤如下图:
不会使用 Arthas 的小伙伴也没关系,可以参考下面博主代理类反编译的结果:
/** Decompiled with CFR.** Could not load the following classes:* com.ray.study.design_patterns.pattern.proxy.jdk_proxy.SellTickets*/
package com.sun.proxy;import com.ray.study.design_patterns.pattern.proxy.jdk_proxy.SellTickets;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
import java.lang.reflect.UndeclaredThrowableException;// 程序运行过程中动态生成的代理类
public final class $Proxy0
extends Proxy
implements SellTickets {private static Method m1;private static Method m2;private static Method m3;private static Method m0;public $Proxy0(InvocationHandler invocationHandler) {super(invocationHandler);}static {try {m1 = Class.forName("java.lang.Object").getMethod("equals", Class.forName("java.lang.Object"));m2 = Class.forName("java.lang.Object").getMethod("toString", new Class[0]);m3 = Class.forName("com.ray.study.design_patterns.pattern.proxy.jdk_proxy.SellTickets").getMethod("sell", new Class[0]);m0 = Class.forName("java.lang.Object").getMethod("hashCode", new Class[0]);return;}catch (NoSuchMethodException noSuchMethodException) {throw new NoSuchMethodError(noSuchMethodException.getMessage());}catch (ClassNotFoundException classNotFoundException) {throw new NoClassDefFoundError(classNotFoundException.getMessage());}}public final boolean equals(Object object) {try {return (Boolean)this.h.invoke(this, m1, new Object[]{object});}catch (Error | RuntimeException throwable) {throw throwable;}catch (Throwable throwable) {throw new UndeclaredThrowableException(throwable);}}public final String toString() {try {return (String)this.h.invoke(this, m2, null);}catch (Error | RuntimeException throwable) {throw throwable;}catch (Throwable throwable) {throw new UndeclaredThrowableException(throwable);}}public final int hashCode() {try {return (Integer)this.h.invoke(this, m0, null);}catch (Error | RuntimeException throwable) {throw throwable;}catch (Throwable throwable) {throw new UndeclaredThrowableException(throwable);}}public final void sell() {try {this.h.invoke(this, m3, null);return;}catch (Error | RuntimeException throwable) {throw throwable;}catch (Throwable throwable) {throw new UndeclaredThrowableException(throwable);}}
}
3.3.3 结论
从上面的类中,我们可以看到以下几个信息:
- 代理类($Proxy0)实现了SellTickets。这也就印证了我们之前说的真实类和代理类实现同样的接口。
- 代理类($Proxy0)将我们提供了的匿名内部类对象传递给了父类。
3.4 动态代理的执行流程
为了方便探究,先将动态代理类以及具体的代码类进行核心摘取⬇️
// 程序运行过程中动态生成的代理类
public final class $Proxy0 extends Proxy implements SellTickets {private static Method m3;public $Proxy0(InvocationHandler invocationHandler) {super(invocationHandler);}static {m3 = Class.forName("com.ray.study.design_patterns.pattern.proxy.jdk_proxy.SellTickets").getMethod("sell", new Class[0]);}public final void sell() {this.h.invoke(this, m3, null);}
}// Java提供的动态代理相关类
public class Proxy implements java.io.Serializable {protected InvocationHandler h;protected Proxy(InvocationHandler h) {this.h = h;}
}// 代理工厂类
public class ProxyFactory {private TrainStation station = new TrainStation();public SellTickets getProxyObject() {SellTickets sellTickets = (SellTickets) Proxy.newProxyInstance(station.getClass().getClassLoader(),station.getClass().getInterfaces(),new InvocationHandler() {public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {System.out.println("代理点收取一些服务费用(JDK动态代理方式)");Object result = method.invoke(station, args);return result;}});return sellTickets;}
}// 测试访问类
public class Client {public static void main(String[] args) {// 获取代理对象ProxyFactory factory = new ProxyFactory();SellTickets proxyObject = factory.getProxyObject();proxyObject.sell();}
}
执行流程如下:
1️⃣ 在测试类中通过代理对象调用sell()方法
2️⃣ 根据多态的特性,执行的是代理类($Proxy0)中的sell()方法
3️⃣ 代理类($Proxy0)中的sell()方法中又调用了InvocationHandler接口的子实现类对象的invoke方法
4️⃣ invoke方法通过反射执行了真实对象所属类(TrainStation)中的sell()方法
4 CGLIB动态代理★
瑞:在没有接口的时候就可以使用CGLIB动态代理
4.1 介绍
CGLIB动态代理是一种在运行时自动生成代理类的代理技术。它与JDK动态代理的主要区别在于:CGLIB不要求被代理的类实现接口。
CGLIB(Code Generation Library)是一个功能强大,高性能的第三方代码生成库,它能够在运行时生成新的类,并且这些类可以扩展原始类或实现一组接口。这种动态生成代理类的能力使得CGLIB在很多场景下比JDK动态代理更加灵活和强大。它为没有实现接口的类提供代理,为JDK的动态代理提供了很好的补充。
CGLIB动态代理的特点包括:
- 无需实现接口:CGLIB可以为任何类生成代理,不论它是否实现了接口。
- 性能优化:CGLIB使用FastClass机制来提升目标方法的执行速度,通过牺牲一定的空间来换取时间上的优化。
- 代理类命名:CGLIB生成的代理类名通常遵循一定的命名规则,如$Proxy0、$Proxy1等。
- 方法调用:CGLIB通过继承被代理类并重写其方法来实现代理,这种机制称为“继承方式”的代理。
- 适用场景:由于CGLIB不需要接口,它特别适合于代理没有实现接口的类,或者目标类需要代理的方法不是来自接口的情况。
总的来说,CGLIB动态代理提供了一种更加通用和高性能的方式来创建代理对象,尤其适用于那些不需要实现特定接口的代理场景。
4.2 代码实现
接下来我们使用CGLIB代理实现静态代理中的案例,如果没有定义SellTickets接口,只定义了TrainStation(火车站类)。很显然JDK动态代理是无法使用了,因为JDK动态代理要求必须定义接口,对接口进行代理。
由于CGLIB是第三方提供的包,所以需要引入jar包的坐标:
<dependency><groupId>cglib</groupId><artifactId>cglib</artifactId><version>2.2.2</version>
</dependency>
/*** 火车站类** @author LiaoYuXing-Ray**/
public class TrainStation {public void sell() {System.out.println("火车站卖票");}
}
import net.sf.cglib.proxy.Enhancer;
import net.sf.cglib.proxy.MethodInterceptor;
import net.sf.cglib.proxy.MethodProxy;import java.lang.reflect.Method;/*** 代理对象工厂,用来获取代理对象** @author LiaoYuXing-Ray**/
public class ProxyFactory implements MethodInterceptor {// 声明火车站对象private final TrainStation station = new TrainStation();public TrainStation getProxyObject() {// 创建Enhancer对象,类似于JDK代理中的Proxy类Enhancer enhancer = new Enhancer();// 设置父类的字节码对象。指定父类enhancer.setSuperclass(TrainStation.class);// 设置回调函数enhancer.setCallback(this);// 创建代理对象TrainStation proxyObject = (TrainStation) enhancer.create();return proxyObject;}public Object intercept(Object o, Method method, Object[] objects, MethodProxy methodProxy) throws Throwable {// System.out.println("方法执行了");System.out.println("代售点收取一定的服务费用(CGLib代理)");// 要调用目标对象的方法Object obj = method.invoke(station, objects);return obj;}
}
/*** 测试类** @author LiaoYuXing-Ray**/
public class Client {public static void main(String[] args) {// 创建代理工厂对象ProxyFactory factory = new ProxyFactory();// 获取代理对象TrainStation proxyObject = factory.getProxyObject();// 调用代理对象中的sell方法卖票proxyObject.sell();}
}
测试类运行结果⬇️
代售点收取一定的服务费用(CGLib代理)火车站卖票
5 总结
5.1 三种代理的对比
5.1.1 jdk代理 VS CGLIB代理
使用CGLib实现动态代理,CGLib底层采用ASM字节码生成框架,使用字节码技术生成代理类,在JDK1.6之前比使用Java反射效率要高。唯一需要注意的是,CGLib不能对声明为final的类或者方法进行代理,因为CGLib原理是动态生成被代理类的子类。
在JDK1.6、JDK1.7、JDK1.8逐步对JDK动态代理优化之后,在调用次数较少的情况下,JDK代理效率高于CGLib代理效率,只有当进行大量调用的时候,JDK1.6和JDK1.7比CGLib代理效率低一点,但是到JDK1.8的时候,JDK代理效率高于CGLib代理。所以如果有接口使用JDK动态代理,如果没有接口使用CGLIB代理。
5.1.2 动态代理 VS 静态代理
动态代理与静态代理相比较,最大的好处是接口中声明的所有方法都被转移到调用处理器一个集中的方法中处理(InvocationHandler.invoke)。这样,在接口方法数量比较多的时候,我们可以进行灵活处理,而不需要像静态代理那样每一个方法进行中转。
如果接口增加一个方法,静态代理模式除了所有实现类需要实现这个方法外,所有代理类也需要实现此方法。增加了代码维护的复杂度。而动态代理不会出现该问题。
5.2 代理模式的优缺点
5.2.1 优点
- 代理模式在客户端与目标对象之间起到一个中介作用和保护目标对象的作用;
- 代理对象可以扩展目标对象的功能;
- 代理模式能将客户端与目标对象分离,在一定程度上降低了系统的耦合度;
5.2.2 缺点
- 增加了系统的复杂度;
5.3 代理模式的使用场景
-
远程(Remote)代理(RPC思想,如Dubbo)
本地服务通过网络请求远程服务。为了实现本地到远程的通信,我们需要实现网络通信,处理其中可能的异常。为良好的代码设计和可维护性,我们将网络通信部分隐藏起来,只暴露给本地服务一个接口,通过该接口即可访问远程服务提供的功能,而不必过多关心通信部分的细节。 -
防火墙(Firewall)代理
当你将浏览器配置成使用代理功能时,防火墙就将你的浏览器的请求转给互联网;当互联网返回响应时,代理服务器再把它转给你的浏览器。 -
保护(Protect or Access)代理
控制对一个对象的访问,如果需要,可以给不同的用户提供不同级别的使用权限。
如果觉得这篇文章对您有所帮助的话,请动动小手点波关注💗,你的点赞👍收藏⭐️转发🔗评论📝都是对博主最好的支持~