一、代理模式
关于代理模式,以及代理模式的组成元素、类图关系、优点以及应用场景可以参考我的上一篇博文 代理模式简介
二、静态代理
1.定义
所谓静态代理,即是代码编译时已经写好了代理类。例如我们上一章介绍的例子就是静态代理。
2.举个例子
现在又一个共有接口如下
public interface ActionA {
void action1();
void action2(String str);
}
真实对象实现这个接口并完成真实逻辑
public class RealObject implements ActionA {
public void action1() {
System.out.println("RealObject do action1");
}
public void action2(String str) {
System.out.println("RealObject do action2, str is: " + str);
}
}
代理对象实现这个接口完成扩展功能并使用真实对象完成真实逻辑
public class StaticProxy implements ActionA {
private ActionA mRealObject; // 代理对象
public StaticProxy(ActionA realObject) {
this.mRealObject = realObject;
}
public void action1() {
System.out.println("我是静态代理,执行了方法 action1"); // 扩展功能
mRealObject.action1(); // 使用真实对象完成真实逻辑
}
public void action2(String str) {
System.out.println("我是静态代理,执行了方法 action2"); // 扩展功能
mRealObject.action2(str); // 使用真实对象完成真实逻辑
}
}
于是,我们可以模拟一个场景并输出
public class Main {
public static void main(String[] args) {
RealObject realObject = new RealObject();
StaticProxy staticProxy = new StaticProxy(realObject);
staticProxy.action1();
staticProxy.action2("afei");
}
}
输出结果为
我是静态代理,执行了方法 action1
RealObject do action1
我是静态代理,执行了方法 action2
RealObject do action2, str is: afei
3.继续前行
我们看到,通过静态代理实现的代理模式,我们已经可以做到很优雅的扩展一个类的功能了。但是,当我们有越来越多的 RealObject ,例如十个不同的 RealObject,他们实现的接口五花八门,同时代理的方法也不同,那么我们的 Proxy 类也随之越来越多,我们几乎要为每一个 RealObject 创建一个对应的代理类。于是,动态代理的出现,就是为了解决这一问题。
三、动态代理
1.定义
所谓动态代理,即是编写代码时并不存在这个代理类(不需要你自己写代理类),而是在代码运行时,自动生成对应的代理类。
2.举个例子
从 jdk 1.5 开始,Java 官方就添加了一个 InvocationHandler 接口,专门用于动态代理的使用。
首先我们增加一个共有接口,即
public interface ActionA {
void action1();
void action2(String str);
}
public interface ActionB {
void action3();
}
其次真实对象实现接口并完成真实逻辑
public class RealObject implements ActionA, ActionB {
public void action1() {
System.out.println("RealObject do action1");
}
public void action2(String str) {
System.out.println("RealObject do action2, str is: " + str);
}
public void action3() {
System.out.println("RealObject do action3");
}
}
然后我们需要写一个类,实现 InvocationHandler 接口
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
public class DynamicProxyHandler implements InvocationHandler {
private Object mObject;
public DynamicProxyHandler(Object realObject) {
this.mObject = realObject;
}
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
// 执行代理的扩展逻辑,例如输出一些log信息
System.out.println("我是动态代理,执行了方法:" + method.getName());
if(args != null) {
System.out.println(method.getName() + " 有输入参数");
for (int i = 0; i < args.length; i++) {
System.out.println(String.format("输入参数为:args[%d]: %s", i, args[i]));
}
}
// 执行被代理的真实对象的逻辑
return method.invoke(mObject, args);
}
}
最后,就是模拟一个场景实际使用
import java.lang.reflect.Proxy;
public class Main {
public static void main(String[] args) {
RealObject realObject = new RealObject();
DynamicProxyHandler dynamicProxyHandler = new DynamicProxyHandler(realObject);
ActionA actionA = (ActionA) Proxy.newProxyInstance(ActionA.class.getClassLoader(), new Class[] {
ActionA.class , ActionB.class}, dynamicProxyHandler);
ActionB actionB = (ActionB) Proxy.newProxyInstance(ActionB.class.getClassLoader(), new Class[] {
ActionA.class , ActionB.class}, dynamicProxyHandler);
actionA.action1(); // 执行 方法1
actionA.action2("afei"); // 执行 方法2
actionB.action3(); // 执行 方法3
System.out.println("---------分割线---------");
// actionA 和 actionB 其实是同一个对象
System.out.println("actionA: " + actionA);
System.out.println("actionB: " + actionB);
}
}
运行结果为
我是动态代理,执行了方法:action1
RealObject do action1
我是动态代理,执行了方法:action2
action2 有输入参数
输入参数为:args[0]: afei
RealObject do action2, str is: afei
我是动态代理,执行了方法:action3
RealObject do action3
---------分割线---------
我是动态代理,执行了方法:toString
actionA: com.afei.dynamic.RealObject@45ee12a7
我是动态代理,执行了方法:toString
actionB: com.afei.dynamic.RealObject@45ee12a7
备注:
这里 Proxy.newProxyInstance 返回的两个对象的引用其实是指向的同一个对象,因为这个方法内部实现时做了缓存机制,当类实现的接口和真实对象均是一致时,不会重复创建代理对象。
3.写在最后
目前我的例子中只有一个 RealObject 对象,但是当存在越来越多不同的 RealObject 时,我们也不需要编写越来越多的 Proxy 类,而是动态地生成。
例如我们新增一个接口和真实对象
public interface ActionC {
void doSomething();
}
public class OtherRealObject implements ActionC {
public void doSomething() {
System.out.println("OtherRealObject doSomething");
}
}
这时我们并不需要新增一个代理类,而是直接在场景中如下使用
public class Main {
public static void main(String[] args) {
OtherRealObject realObject = new OtherRealObject();
DynamicProxyHandler dynamicProxyHandler = new DynamicProxyHandler(realObject);
ActionC actionC = (ActionC) Proxy.newProxyInstance(ActionC.class.getClassLoader(),
new Class[] { ActionC.class }, dynamicProxyHandler);
actionC.doSomething();
}
}
运行结果为
我是动态代理,执行了方法:doSomething
OtherRealObject doSomething
这样我们就解决了静态代理的缺点了。
查看更多:设计模式分类以及六大设计原则