该文章首发于GoF设计模式-代理模式
概述
- 代理模式(Proxy Pattern),为其他对象提供一种代理以控制对这个对象的访问。
- 代理模式其实就是在访问对象时引入一定程度的间接性,因为这种间接性,可以在目标对象实现的基础上,增强额外的功能操作,即扩展目标对象的功能。
- 被代理的对象可以是远程对象、创建开销大的对象或需要安全控制的对象
- 代理模式可以详细控制访问某个对象的方法,在调用这个方法前做前置处理,调用这个方法后做后置处理,从而实现将统一流程代码放到代理类中处理。(即:AOP的微观实现)
- 代理模式是AOP(Aspect Oriented Programming面向切面编程)的核心实现机制。
应用场景
- 安全代理:屏蔽对真实角色的直接访问。
- 远程代理:通过代理类处理远程方法调用(RMI,即Remote Method Invoke)
- 虚拟代理:先加载轻量级的代理对象,真正需要时再加载开销很大的真实对象,如浏览器页面中的图片的延时加载就是使用虚拟代理的。
- 智能指引:当调用真实的对象时,代理处理另外一些事情。
核心角色
抽象角色
定义代理角色和真实角色的公共对外方法
真实角色
- 即目标对象,实现抽象角色,定义真实角色所要实现的业务逻辑,供代理角色调用。
- 关注真正的业务逻辑。
代理角色
- 即代理对象,实现抽象角色或为真实角色的子类,是真实角色的代理,通过真实角色的业务逻辑方法来实现抽象方法,并可以附加字节的操作。
- 将统一的流程控制放到代理角色中处理。
分类
- 静态代理:静态定义代理类
- 动态代理:动态生成代理类
- JDK自带的动态代理,即JDK代理
- javaassist字节码操作库实现
- CgLib代理
- ASM(底层使用指令,可维护性较差)
静态代理
概述
静态代理,即Static Proxy,由开发者定义代理类,在使用时,被代理对象(即目标对象)与代理对象一起实现相同的接口或者是继承相同的父类。
场景
使用追求女神
的场景实现静态代理
- 追求者张三想要追求女神,认识女神的闺蜜代理工具人,但不认识女神,张三就通过女神的闺蜜送礼物给女神。
- 角色分析
- 抽象角色——送礼物接口,
GiveGift
。 - 真实角色——追求者张三,
Pursuer
。 - 代理角色——工具人闺蜜,
ToolPerson
- 抽象角色——送礼物接口,
UML类图
实例
抽象角色GiveGift
public interface GiveGift {
// 送鲜花
void giveFlowers();
}
真实角色``Pursuer`
public class Pursuer implements GiveGift{
private String name;
public Pursuer(String name) {
this.name = name;
}
public String getName() {
return name;
}
@Override
public void giveFlowers() {
System.out.println("送女神一束鲜花");
}
}
代理角色ToolPerson
public class ToolPerson implements GiveGift{
private Pursuer pursuer;
public ToolPerson(Pursuer pursuer) {
this.pursuer = pursuer;
}
@Override
public void giveFlowers() {
System.out.println("接收" + pursuer.getName() + "的代理");
pursuer.giveFlowers();
System.out.println("女神把花退回来了。。。");
}
}
测试类
public class Test {
public static void main(String[] args) {
// 创建目标对象(被代理对象)
Pursuer pursuer = new Pursuer("张三");
// 创建代理对象,同时将被代理对象传递给代理对象
ToolPerson toolPerson = new ToolPerson(pursuer);
// 通过代理对象,调用到被代理对象的方法
toolPerson.giveFlowers(); // 接收张三的代理 送女神一束鲜花 女神把花退回来了。。
}
}
优缺点
- 优点:在不修改目标对象即真实角色的功能的前提下,能通过代理对象对目标功能进行扩展。
- 缺点:由于代理对象需要与目标对象实现共同的接口,所以一旦接口增加方法,目标对象与代理对象都要维护。
JDK代理
概述
- 代理对象不需要实现接口,但是目标对象要实现接口,否则不能用动态代理。
- 代理对象的生成,是利用JDK的API动态地在内存中构建代理对象。
优点
抽象角色(接口)中声明的所有方法都被转移到调用处理器一个集中的方法中处理,这样,可以更加灵活和统一地处理众多的方法。
使用
Proxy
java.lang.reflect.Proxy
:提供了创建动态代理类和实例的静态方法,它也是由这些方法创建的所有动态代理类的超类。- JDK实现代理只需要实现
Proxy
的newProxyInstance
静态方法 public static Object newProxyInstance(ClassLoader loader, Class<?>[] interfaces, InvocationHandler h)
:返回指定接口的代理类的实例,该接口将方法调用分派给指定的调用处理程序。ClassLoader loader
:指定当前目标对象使用的类加载器,获取加载器的方法固定。Class<?>[] interfaces
:目标对象实现的接口类型,使用泛型的方式确认类型InvocationHandler h
:事件处理器,执行目标对象的方法时,会触发事件处理器的invoke
方法,会把当前执行的目标对象方法作为参数传入,可使用Lambda表达式
InvocationHandler
java.lang.reflect.InvocationHandler
:是代理实例的调用处理程序实现的处理器,每次通过Proxy
生成代理类对象时都要指定对应的处理器对象,通过invoke
方法实现对真实角色的代理访问。Object invoke(Object proxy, Method method, Object[] args)
:在代理实例上处理方法调用并返回结果Object proxy
:在其上调用方法的代理实例Method method
:对应于在代理实例上调用的接口方法的Method
实例Object[] args
:包含传入代理实例上方法调用的参数值的对象数组,如果接口方法不使用参数,则为null
,基本数据类会被转换为对应的包装类。
场景
使用追求女神
的场景实现JDK代理
- 追求者张三想要追求女神,认识女神的闺蜜代理工具人,但不认识女神,张三就通过女神的闺蜜送礼物给女神。
- 角色分析
- 抽象角色——送礼物接口,
GiveGift
。 - 真实角色——追求者张三,
Pursuer
。 - 代理角色——由代理工厂生成代理对象,
ProxyFactory.getProxyInstance()
- 抽象角色——送礼物接口,
UML类图
’
实例
抽象角色GiveGift
public interface GiveGift {
/**
* 送鲜花
*/
void giveFlowers();
}
真实角色Pursuer
public class Pursuer implements GiveGift{
private String name;
public Pursuer(String name) {
this.name = name;
}
public String getName() {
return name;
}
@Override
public void giveFlowers() {
System.out.println("送女神一束鲜花");
}
}
代理对象工厂ProxyFactory
public class ProxyFactory {
// 保护一个目标对象,target
private Pursuer target;
public ProxyFactory(Pursuer target) {
this.target = target;
}
// 生成代理对象
public Object getProxyInstance() {
return Proxy.newProxyInstance(target.getClass().getClassLoader(), target.getClass().getInterfaces(), new InvocationHandler() {
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
System.out.println("开始" + target.getName() + "的代理");
// 方式机制调用目标对象的方法
Object returnVal = method.invoke(target, args);
System.out.println("女神把花退回来了。。。");
return returnVal;
}
});
}
}
测试类Test
public class Test {
public static void main(String[] args) {
// 创建目标对象
Pursuer pursuer = new Pursuer("张三");
// 创建代理对象
GiveGift proxy = (GiveGift) new ProxyFactory(pursuer).getProxyInstance();
// proxy:class com.sun.proxy.$Proxy0,即内存中动态生成了代理对象
System.out.println("proxy:" + proxy.getClass());
proxy.giveFlowers();// 接收张三的代理 送女神一束鲜花 女神把花退回来了。。
}
}
Cglib代理
概述
- 静态代理和JDK代理都要求目标对象实现一个接口,但是有时候目标对象只是一个单独的对象,并没有实现任何的接口,这个时候可以使用目标对象子类来实现代理,这就是Cglib代理
- Cglib代理也叫做子类代理,它是在内存中构建一个子类对象从而实现对象目标对象功能扩展。
- Cglib是一个强大的高性能的代码生成包,它可以在运行期扩展Java类与实现Java接口,它广泛地被许多APO框架使用,例如Spring AOP,实现方法拦截。
- 在AOP编程中如何选择代理模式
- 目标对象需要实现接口,用JDK代理
- 目标对象不需要实现接口,用Cglib代理
- Cglib包的底层是通过使用字节码处理框架ASM来转换字节码并生成新的类,即依赖ASM,使用字节码技术生成代理类,比使用Java反射效率要高。
依赖
-
Cglib代理依赖第三方包
cglib.jar
,gitub仓库地址和下载地址- cglib-xxx.jar包没有集成ASM,故需要另外在项目中引入ASM包
- cglib-nodep-xxx.jar以集成ASM,故可以直接使用
-
注意:cglib包和asm包版本不匹配问题
-
cglib版本为 3.0 或 3.1 ,org.objectweb.asm版本为3.1.0时,版本冲突,报错
java.lang.IncompatibleClassChangeError: class net.sf.cglib.core.DebuggingClassWriter has interface org.objectweb.asm.ClassVisitor as super class
-
使用 cglib 2.2 或使用较新版本的 asm包 可解决此问题。
-
使用
- 通过
Enhacer
对象来获取目标对象的代理对象 - 通过实现
MethodInterceptor
拦截器接口并重写intercept
类来实现对目标对象的代理访问。 Object intercept(Object proxy, Method method, Object[] args, MethodProxy methodProxy)
:在代理实例上处理方法调用并返回结果Object proxy
:在其上调用方法的代理实例Method method
:对应于在代理实例上调用的接口方法的Method
实例Object[] args
:包含传入代理实例上方法调用的参数值的对象数组,如果接口方法不使用参数,则为null
,基本数据类会被转换为对应的包装类。MethodProxy methodProxy
:代理方法
注意
- 在内存中动态创建子类,注意代理的类不能使用
final
修饰,否则报错java.lang.IllegalArgumentException
- 目标对象的方法如果被
final
或static
修饰,那么就不会被拦截,即不会执行目标对象额外的业务方法。
场景
使用追求女神
的场景实现JDK代理
- 追求者张三想要追求女神,认识女神的闺蜜代理工具人,但不认识女神,张三就通过女神的闺蜜送礼物给女神。
- 角色分析
- 抽象角色——由Cglib在内存中生成
- 真实角色——追求者张三,
Pursuer
。 - 代理角色——由代理工厂生成代理对象,
ProxyFactory.getProxyInstance()
URL类图
实例
真实角色Pursuer
public class Pursuer implements GiveGift{
private String name;
public Pursuer(String name) {
this.name = name;
}
public String getName() {
return name;
}
@Override
public void giveFlowers() {
System.out.println("送女神一束鲜花");
}
}
代理对象工厂ProxyFactory
public class ProxyFactory implements MethodInterceptor{
// 目标对象
private Pursuer target;
public ProxyFactory(Pursuer target) {
this.target = target;
}
// 获取代理对象
public Object getProxyInstance() {
// 1.创建一个工具类
Enhancer enhancer = new Enhancer();
// 2.设置父类
enhancer.setSuperclass(target.getClass());
// 3.设置回调方法
enhancer.setCallback(this);
// 4.创建子类对象,即代理对象
return enhancer.create();
}
@Override
public Object intercept(Object proxy, Method method, Object[] args, MethodProxy methodProxy) throws Throwable {
System.out.println("开始" + target.getName() + "的代理");
Object returnVal = method.invoke(target, args);
System.out.println("女神把花退回来了。。。");
return returnVal;
}
}
测试类Test
public class Test {
public static void main(String[] args) {
// 创建目标对象
Pursuer pursuer = new Pursuer("张三");
// 创建代理对象
Pursuer proxy = (Pursuer) new ProxyFactory(pursuer).getProxyInstance();
// 调用代理方法
proxy.giveFlowers(); // 接收张三的代理 送女神一束鲜花 女神把花退回来了。。
}
}
结果可能会出现以下警告
WARNING: An illegal reflective access operation has occurred
WARNING: Illegal reflective access by net.sf.cglib.core.ReflectUtils$1 (file:/D:/Study/Code/Java/JavaSE_Code_Eclipse/22_GoF/lib/cglib-3.3.0.jar) to method java.lang.ClassLoader.defineClass(java.lang.String,byte[],int,int,java.security.ProtectionDomain)
WARNING: Please consider reporting this to the maintainers of net.sf.cglib.core.ReflectUtils$1
WARNING: Use --illegal-access=warn to enable warnings of further illegal reflective access operations
WARNING: All illegal access operations will be denied in a future release
该警告是因为jdk版本太高,将项目JDK降低到1.8或以下版本即可,也可以不处理,不影响正常运行。
参考资料: