一、代理模式
关于代理模式,以及代理模式的组成元素、类图关系、优点以及应用场景可以参考我的上一篇博文 代理模式简介
二、静态代理
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 返回的两个对象的引用其实是指向的同一个对象,因为这个方法内部实现时做了缓存机制,当类实现的接口和真实对象均是一致时,不会重复创建代理对象。
目前我的例子中只有一个 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
这样我们就解决了静态代理的缺点了。
四、CGLib代理
目标类不能为final
,目标对象的方法如果为final / static
,那么就不会被拦截,即不会执行目标对象额外的业务方法
a、引入依赖
Spring环境下不需要,因为Spring-Core里已经引入了
cglib
cglib
3.2.12
b、创建一个目标类
/**
* @author Gjing
* 真实对象
**/
public class Canteen {
public void sell() {
System.out.println("小卖部进行卖货");
}
}
c、创建CGLib的工厂类和测试类
/**
* @author Gjing
**/
public class CgLibProxy implements MethodInterceptor {
private Canteen canteen;
CgLibProxy(Canteen canteen) {
this.canteen = canteen;
}
Canteen proxy() {
// 创建Enhancer对象
Enhancer enhancer = new Enhancer();
// 设置代理的目标类
enhancer.setSuperclass(Canteen.class);
// 设置回调方法, this代表是当前类, 因为当前类实现了CallBack
enhancer.setCallback(this);
return (Canteen) enhancer.create();
}
//这个方法就是回调方法了
@Override
public Object intercept(Object o, Method method, Object[] objects, MethodProxy methodProxy) throws Throwable {
System.out.println("----------小卖部卖货前----------");
Object invoke = method.invoke(canteen, objects);
System.out.println("----------小卖部卖货后----------");
return invoke;
}
}
/**
* @author Gjing
*/
class TestCglibProxy{
public static void main(String[] args) {
Canteen canteen = new Canteen();
Canteen proxy = new CgLibProxy(canteen).proxy();
proxy.sell();
}
}
输出
[图片上传失败...(image-f4b6a9-1562740101020)]
五、三种代理方式的优缺点
1、静态代理:
可以做到在不修改目标对象的功能前提下,对目标功能扩展
缺点:
代理对象需要与目标对象实现一样的接口,所以会有很多代理类,类太多.同时,一旦接口增加方法,目标对象与代理对象都要维护
2、JDK动态代理
代理对象不需要实现接口, 利用JDK的API,动态的在内存中构建代理对象(需要我们指定创建代理对象/目标对象实现的接口的类型)
缺点:
目标对象一定要实现接口,否则不能用动态代理
3、CGLib代理
静态代理和动态代理模式都是要求目标对象是实现一个接口的目标对象,但是有时候目标对象只是一个单独的对象,并没有实现任何的接口,这个时候就可以使用以目标对象类实现代理
六、什么时候使用代理模式
1、当我们想要隐藏某个类时,可以为其提供代理。
2、当一个类需要对不同的调用者提供不同的调用权限时,可以使用代理类来实现(代理类不一定只有一个,我们可以建立多个代理类来实现,也可以在一个代理类中进行权限判断来进行不同权限的功能调用)。
3、当我们要扩展某个类的某个功能时,可以使用代理模式,在代理类中进行简单扩展(只针对简单扩展,可在引用委托类的语句之前与之后进行)。
六、JDK代理和CGLib代理的区别
JDK动态代理
使用Java的反射技术生成代理类,只能代理实现了接口的类,没有实现接口的类不能实现动态代理,CGLib
会在运行时动态的生成一个被代理类的子类,子类重写了被代理类中所有非final
的方法,在子类中采用方法拦截的技术拦截所有父类方法的调用,不需要被代理类对象实现接口,从而CGLIB
动态代理效率比Jdk动态代理反射技术效率要高