代理模式
代理模式的含义
给目标对象提供一个代理对象, 并由代理对象控制对目标对象的引用, 通俗的来讲,就是我们生活中的中介;
举个🌰: 假如我想买一辆二手车,虽然我可以自己去找车源,做质量检测等一系列的车辆过户流程, 但是确实太费时间和精力了. 于是我就找到了中介公司来买车,他们来给我找车源, 帮我办理车辆过户流程,我只负责选择自己喜欢的车,然后付钱就可以了. 用类图表示如下:
使用代理模式的目的:
1,通过引入代理对象的方式来间接访问目标对象, 防止直接访问目标对象给系统带来不必要的复杂性;(中介隔离作用)
2,代理类除了是客户类和委托类中介之外,我们还可以通过给代理类增加额外的功能来扩展委托类的功能(过户流程功能),这样做我们只需要修改代理类而不需要再修改委托类,符合代码设计的开闭原则. 例如我们想给项目加入缓存, 日志这些功能, 地图sdk切换,我们就可以使用代理类来完成, 而没必要打开已经封装好的委托类;(开闭原则,增加功能).
代理模式在项目中实际的运用
在实际项目中, 如果地图SDK 的API 耦合在项目程序中, 如果由于某些原因,需要切换地图sdk,这时候需要改动的范围特别大,这是在项目中切不可取的. 这时候我们需要一种模式去改变传统的代码设计思想, 这时候代理模式就响亮登场了, 根据下图, 红色区域是项目主体, 蓝色区域是我们重新封装的SDK, 如果这时候切换地图, 只需要换掉我们封装后的地图SDK,就行了,不用去过多去改动代码. 这图如果你能跟上面图的角色对应上,那你基本了解了代理模式.想更深层了解代理模式,请君继续往下看.
后期会出Retrofit在动态代理的那些事儿,请大家多多关注.
代理模式有哪几种?
按照代理创建的时期来进行分类,可以分为两种:静态代理,动态代理.
静态代理: 是由程序员创建或特定工具自动生成源代码,在编译期,程序员运行时之前,代理类.class文件就已经被创建了.
动态代理:是程序在运行时通过反射机制,动态创建的.class文件.后文会分析到动态创建的.class文件. 其中我们熟悉的Proxy,还有GBLIB框架.
概念终于说完了, 下面是我们的撸码环节,据上面的类图,进行具体实现.
静态代理
第一步:创建服务类接口.
File:Subject.java
/**
* 服务类接口
*/
package com.zyang.proxyexample;
public interface Subject {
UsedCar purchase(String colour);
}
File:UsedCar.java
/**
* 二手车
* @author zyang
*/
public class UsedCar {
private String colour;
public void setColour(String coloru) {
this.colour = coloru;
}
public String getColour() {
return colour;
}
}
第二步:实现服务接口
package com.zyang.proxyexample;
/**
* 真实对象
* 二手车公司
* @author zYang
*/
public class UsedCarCompany implements Subject{
@Override
public UsedCar purchase(String colour) {
//按照客户的要求, 搞了一辆二手车
UsedCar usedCar = new UsedCar();
usedCar.setColour(colour);
System.out.println("按照客户的要求搞了一辆二手车");
return usedCar;
}
}
第三步,创建代理类(中介公司)
package com.zyang.proxyexample;
/**
* 代理对象
* @author zYang
*/
public class IntermediaryProxy implements Subject{
private Subject subject;
public IntermediaryProxy(Subject subject) {
this.subject = subject;
}
@Override
public UsedCar purchase(String colour) {
UsedCar usedCar = subject.purchase(colour);//中介找二手公司买车
handleTransfer(usedCar);
return usedCar;
}
private void handleTransfer(UsedCar usedCar) {
System.out.println("这是中介办理的过户流程");
}
}
第四步,中介公司开始营业,这时候来个一个叫Zyang的靓仔,过来买二手车
package com.zyang.proxyexample;
/**
* 访问者
* @author zYang
*/
public class Zyang {
public static void main(String[] args) {
//中介公司向我推荐叫"UsedCarCompany"的公司, 二手车不错, 我看不错, 哎呀我就选他了.
Subject subject = new UsedCarCompany();
//这时候中介公司去找到二手车公司.
IntermediaryProxy intermediaryProxy = new IntermediaryProxy(subject);
//最后我喜提一辆红色的二手车
intermediaryProxy.purchase("红色");
}
}
静态代理总结:
优点: 可以做到在符合开闭原则的情况下对目标对象进行扩展.
缺点: 我们得为每一个服务都得创建代理类,工作量大,不易管理.同时接口一旦发生改变,代理类也得相应修改.
动态代理
动态代理中我们不需要再手动的创建代理,我们只需要编写一个动态处理器就可以. 真正的代理对象交给JDK为我们动态的来创建.
翌日我开着我心爱的小红车,去见朋友,在去朋友的路上突然来了一条新闻,买二手车的流程变了,变复杂了.我心想还好我早买了,不然得麻烦死了.心想二手车公司内部估计要比较大的改动了吧. 经过几个小时的颠簸,终于见到了朋友,朋友一脸惊讶,说我咋买的红色的车,这颜色真骚. 我觉得也是有道理, 于是我找到了中介公司, 我说你们能不能帮我把车喷成黑色. 中介公司说,我们只提供二手车买卖的服务,不提供车身喷漆服务,你得去找专门车身喷漆的公司. 我离开了中介公司,真麻烦还得去找车身喷漆公司,要是有一家万能服务公司就好了, 就不用到处跑来跑去了. 这时候朋友来了一个电话说,他知道有一家公司叫"Proxy",能提供买车,喷漆,换轮胎很多你想不到的服务..
上面的小故事主要说明静态代理存在的缺陷.为了解决上面的缺陷,动态代理就响亮登场了.
下面我们开始撸码环节
第一步:创建服务类接口.
package com.zyang.proxyexample;
/**
* 喷漆服务接口
* @author Zyang
*/
public interface IPainting {
UsedCar painting(UsedCar usedCar,String colour);
}
第二步:实现服务接口
package com.zyang.proxyexample;
package com.zyang.proxyexample;
/**
* 真实对象,喷漆公司
* @author Zyang
*/
public class PaintingCompany implements IPainting{
@Override
public UsedCar painting(UsedCar usedCar, String colour) {
System.out.println("将客户的车,喷成"+colour+"色");
usedCar.setColour(colour);
return usedCar;
}
}
第三步,"Proxy"中介公司这时候来个一个叫Zyang的靓仔,过来给小红车喷漆服务
package com.zyang.proxyexample;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
package com.zyang.proxyexample;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;import org.omg.CORBA.portable.InputStream;
import org.omg.CORBA.portable.InvokeHandler;
import org.omg.CORBA.portable.OutputStream;
import org.omg.CORBA.portable.ResponseHandler;
/**
* 访问者
* @author zYang
*/
public class Zyang {
public static UsedCar usedCar;
public static void main(String[] args) {
/*
* 第一天, 买车
*/
//IntermediaryProxy 中介公司向我推荐叫"UsedCarCompany"的公司, 二手车不错, 我看不错, 哎呀我就选他了.
Subject subject = new UsedCarCompany();
//这时候中介公司去找到二手车公司.
IntermediaryProxy intermediaryProxy = new IntermediaryProxy(subject);
//最后我喜提一辆红色的二手车
usedCar = intermediaryProxy.purchase("红色");
/*
* 第二天,喷漆, 你们也能提供买车服务呀
*/
//proxy 中介公司也向我推荐叫"UsedCarCompany"的公司, 二手车不错, 我看不错, 哎呀我就选他了.
//Subject proxySubject = new UsedCarCompany();
//proxy 中介公司向我推荐叫"PaintingCompany.java"的公司,喷漆工艺不错.
final IPainting iPainting = new PaintingCompany();
Object obj = Proxy.newProxyInstance(Zyang.class.getClassLoader(), new Class[] {Subject.class,IPainting.class}, new InvocationHandler() {
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
// return method.invoke(subject, args);
return method.invoke(iPainting, args);
}
});
// Subject poxySubject = (Subject)obj;
// poxySubject.purchase("黑色");
IPainting poxyPainting = (IPainting)obj;
poxyPainting.painting(usedCar, "黑色");
}
}
Proxy.newProxyInstance()方法接收三个参数:
ClassLoader loader: 指定当前目标对象使用的类加载器,获取加载器的方法是不变的
Class<?>[] interfaces: 指定目标对象实现的接口的类型,使用泛型方式确认类型
InVocationHandler: 指定动态处理器,执行目标对象的所有方法时,会触发处理的方法.
InvocationHandler中的invoke方法三个参数
Object proxy: 指被代理的对象,跟外面的obj是同一个对象
Method method: 指代理对象执行的方法对象(关于反射大家可以看java反射这篇文章)
Object[] args: 指被执行方法的参数列表
在使用Proxy时需要注意:
Object obj = Proxy.newProxyInstance(Zyang.class.getClassLoader(), new Class[] {Subject.class,IPainting.class}, new InvocationHandler() {
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
/*
这里直接打印proxy 会导致栈溢出,
上面介绍了proxy是被代理的对象,跟外面的obj是同一个对象 .
而打印proxy, proxy会默认执行toString()方法, proxy执行toString()方法
会触发invoke()方法. 最后不停的递归,最终导致栈溢出.
*/
System.out.println(proxy);
return method.invoke(iPainting, args);
}
});
这里直接打印proxy 会导致栈溢出,
上面介绍了proxy是被代理的对象,跟外面的obj是同一个对象 .
而打印proxy, proxy会默认执行toString()方法, proxy执行toString()方法
会触发invoke()方法. 最后不停的递归,最终导致栈溢出.
为什么会出现上面那种情况?让我们一起揭开proxy里面的真面目吧.
在跟源码揭晓之前,先说下java类的完整生命周期
Java源文件.java文件 编译成--->Java字节码文件.class 类加载器加载--->Class对象 实例化成---> 实例对象 --->卸载;这是java类完整的生命周期.
而字节码来源有两个, 一个是我们所知道.class文件, 还有一个存在内存byte[]数组里面. 那字节码如何在内存中生成? 生成的class文件结构是什么?后面会为大家揭晓
5FA137A20E26D142A66E0CE50502730C.png
1, 首先找到JDK1.8 里面的Proxy的源码,找到newProxyInstance(ClassLoader loader, Class<?>[] interfaces, InvocationHandler h)的方法.
2, 在这个行代码, final Class<?>[] intfs = interfaces.clone(); 把这个Interfece.class clone()一份字节码对象.
3, checkProxyAccess()这个方法主要是做了一些判断,如果条件不满足,直接回抛出异常,终止程序运行.
4, 这个行代码,特别重要, 把clone出来的一份接口的字节码对象,传递给getProxyClass0(loader,intfs) 的方法, 我简单的跟了一下这个方法,里面通过WeakCach类,最终会调用到ProxyClassFactory类的apply()方法.
public static Object newProxyInstance(ClassLoader loader,
Class<?>[] interfaces,
InvocationHandler h)
throws IllegalArgumentException
{
Objects.requireNonNull(h);
final Class<?>[] intfs = interfaces.clone();
final SecurityManager sm = System.getSecurityManager();
if (sm != null) {
checkProxyAccess(Reflection.getCallerClass(), loader, intfs);
}
/*
* Look up or generate the designated proxy class.
*/
Class<?> cl = getProxyClass0(loader, intfs);//这里获取到Class对象
/*
* Invoke its constructor with the designated invocation handler.
*/
try {
if (sm != null) {
checkNewProxyPermission(Reflection.getCallerClass(), cl);
}
final Constructor<?> cons = cl.getConstructor(constructorParams);
final InvocationHandler ih = h;
if (!Modifier.isPublic(cl.getModifiers())) {
AccessController.doPrivileged(new PrivilegedAction<Void>() {
public Void run() {
cons.setAccessible(true);
return null;
}
});
}
return cons.newInstance(new Object[]{h});
} catch (IllegalAccessException|InstantiationException e) {
throw new InternalError(e.toString(), e);
} catch (InvocationTargetException e) {
Throwable t = e.getCause();
if (t instanceof RuntimeException) {
throw (RuntimeException) t;
} else {
throw new InternalError(t.toString(), t);
}
} catch (NoSuchMethodException e) {
throw new InternalError(e.toString(), e);
}
}
5,applay()这个方法主要是生成装有代理对象字节码Class<?> 的byte[] 数组, 看下一个applay()方法的源码.
/**
* A factory function that generates, defines and returns the proxy class given
* the ClassLoader and array of interfaces.
*/
private static final class ProxyClassFactory
implements BiFunction<ClassLoader, Class<?>[], Class<?>>
{
// prefix for all proxy class names
private static final String proxyClassNamePrefix = "$Proxy";//字节码的类名
// next number to use for generation of unique proxy class names
private static final AtomicLong nextUniqueNumber = new AtomicLong();
@Override
public Class<?> apply(ClassLoader loader, Class<?>[] interfaces) {
Map<Class<?>, Boolean> interfaceSet = new IdentityHashMap<>(interfaces.length);
for (Class<?> intf : interfaces) {
/*
* Verify that the class loader resolves the name of this
* interface to the same Class object.
*/
Class<?> interfaceClass = null;
try {
interfaceClass = Class.forName(intf.getName(), false, loader);//通过反射,创建接口的字节码对象
} catch (ClassNotFoundException e) {
}
if (interfaceClass != intf) {
throw new IllegalArgumentException(
intf + " is not visible from class loader");
}
/*
* Verify that the Class object actually represents an
* interface.
*/
if (!interfaceClass.isInterface()) {//判断接口字节码是否为接口, 防止程序员,参数传的类字节码.
throw new IllegalArgumentException(
interfaceClass.getName() + " is not an interface");
}
/*
* Verify that this interface is not a duplicate.
*/
if (interfaceSet.put(interfaceClass, Boolean.TRUE) != null) {
throw new IllegalArgumentException(
"repeated interface: " + interfaceClass.getName());
}
}
String proxyPkg = null; // package to define proxy class in
int accessFlags = Modifier.PUBLIC | Modifier.FINAL;
/*
* Record the package of a non-public proxy interface so that the
* proxy class will be defined in the same package. Verify that
* all non-public proxy interfaces are in the same package.
*/
for (Class<?> intf : interfaces) {
int flags = intf.getModifiers();
if (!Modifier.isPublic(flags)) {
accessFlags = Modifier.FINAL;
String name = intf.getName();
int n = name.lastIndexOf('.');
String pkg = ((n == -1) ? "" : name.substring(0, n + 1));
if (proxyPkg == null) {
proxyPkg = pkg;
} else if (!pkg.equals(proxyPkg)) {
throw new IllegalArgumentException(
"non-public interfaces from different packages");
}
}
}
if (proxyPkg == null) {
// if no non-public proxy interfaces, use com.sun.proxy package
proxyPkg = ReflectUtil.PROXY_PACKAGE + ".";
}
/*
* Choose a name for the proxy class to generate.
*/
long num = nextUniqueNumber.getAndIncrement();
String proxyName = proxyPkg + proxyClassNamePrefix + num;
/*
* Generate the specified proxy class.
*/
byte[] proxyClassFile = ProxyGenerator.generateProxyClass(
proxyName, interfaces, accessFlags);//这个行代码很重要. 这里是生成装有代理对象的字节码的byte数组, 如果把它写入到文件中, 就能直接看到代理对象的结构了.
try {
return defineClass0(loader, proxyName,
proxyClassFile, 0, proxyClassFile.length);
} catch (ClassFormatError e) {
/*
* A ClassFormatError here means that (barring bugs in the
* proxy class generation code) there was some other
* invalid aspect of the arguments supplied to the proxy
* class creation (such as virtual machine limitations
* exceeded).
*/
throw new IllegalArgumentException(e.toString());
}
}
}
6,找到 byte[] proxyClassFile = ProxyGenerator.generateProxyClass( proxyName, interfaces, accessFlags);
这里是生成装有代理对象的字节码的byte数组, 如果把它写入到文件中, 就能直接看到代理对象的结构了.
7,找到 defineClass0(loader, proxyName, proxyClassFile, 0, proxyClassFile.length); defineClass0()方法, 把byte[]数组字节码传递给虚拟机处理, 这是一个本地方法, 具体实现是C/C++部分,就不往下跟踪了. 现在我们有更重要的事,就是看jdk 给我们生成的代理对象到底是怎么样的? 为什么代理对象每执行一个方法, 都会触发InvocationHandler的invoke方法?
首先如何查看proxy代理对象结构?
这是模拟ProxyClassFactory 类里面的apply()方法里面构造代理对象的byte[]数组数据,并把他写在本地.
package com.zyang.lib;
import java.io.FileOutputStream;
import sun.misc.ProxyGenerator;
public class MyClass {
public static void main(String[] args) throws Exception {
String name = IPainting.class.getName() +"$Proxy0";
//生成代理指定接口的Class数据
byte[] classBytes = ProxyGenerator.generateProxyClass(name, new Class[]{IPainting.class});
FileOutputStream fos = new FileOutputStream("lib/"+name +".class");
fos.write(classBytes);
fos.close();
}
}
最终生成的class文件的内容
//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//
package com.example.lib;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
import java.lang.reflect.UndeclaredThrowableException;
public final class IPainting$Proxy0 extends Proxy implements IPainting {
private static Method m1;
private static Method m3;
private static Method m2;
private static Method m0;
public IPainting$Proxy0(InvocationHandler var1) throws {
super(var1);
}
public final boolean equals(Object var1) throws {
try {
return (Boolean)super.h.invoke(this, m1, new Object[]{var1});
} catch (RuntimeException | Error var3) {
throw var3;
} catch (Throwable var4) {
throw new UndeclaredThrowableException(var4);
}
}
public final UsedCar painting(UsedCar var1, String var2) throws {
try {
return (UsedCar)super.h.invoke(this, m3, new Object[]{var1, var2});
} catch (RuntimeException | Error var4) {
throw var4;
} catch (Throwable var5) {
throw new UndeclaredThrowableException(var5);
}
}
public final String toString() throws {
try {
return (String)super.h.invoke(this, m2, (Object[])null);
} catch (RuntimeException | Error var2) {
throw var2;
} catch (Throwable var3) {
throw new UndeclaredThrowableException(var3);
}
}
public final int hashCode() throws {
try {
return (Integer)super.h.invoke(this, m0, (Object[])null);
} catch (RuntimeException | Error var2) {
throw var2;
} catch (Throwable var3) {
throw new UndeclaredThrowableException(var3);
}
}
static {
try {
m1 = Class.forName("java.lang.Object").getMethod("equals", Class.forName("java.lang.Object"));
m3 = Class.forName("com.example.lib.IPainting").getMethod("painting", Class.forName("com.example.lib.UsedCar"), Class.forName("java.lang.String"));
m2 = Class.forName("java.lang.Object").getMethod("toString");
m0 = Class.forName("java.lang.Object").getMethod("hashCode");
} catch (NoSuchMethodException var2) {
throw new NoSuchMethodError(var2.getMessage());
} catch (ClassNotFoundException var3) {
throw new NoClassDefFoundError(var3.getMessage());
}
}
}
1, 首先我们看到他重写了Object类里面的方法, 包含了toString(), 在toString()方法里面它调用super.h.invoke(this,m2,object[]) 方法, 从这个方法可以看出, 第一个参数是代理对象this, 跟前面所说吻合, m2 是 方法对象Method 在static代码块里面有初始化.
2,在代理对象的构造里面它有传递InvocationHandler象.
IPainting$Proxy0(InvocationHandler var1) 构造方法.
3, 在Proxy里面的newProxyInstance()方法里面, 通过cons.newInstance(new Object[]{h}); 把InvocationHandler通过构造传递进去的. 在我们调用painting方法里面,就默认给我们加了super.h.invoke()方法. 所以我们调用每个方法都会执行InvocationHandler 里面的invoke方法
public final UsedCar painting(UsedCar var1, String var2) throws {
try {
return (UsedCar)super.h.invoke(this, m3, new Object[]{var1, var2});
} catch (RuntimeException | Error var4) {
throw var4;
} catch (Throwable var5) {
throw new UndeclaredThrowableException(var5);
}
}
到这里Proxy我们介绍完了.后面我会用Proxy模仿一份针对Retrofit框架. 请大家关注! 有什么不懂可以下方给我留言
动态代理难道只能处理接口嘛?
答案肯定是不正确的. 如果我们代理抽象类怎么办? 这时候我们引入了GBLIB框架, 由于GBLIB 我了解比较少, 我只是简单介绍如何使用它.
CGLIB代理
CGLIB采用非常底层的字节码技术, 其原理是通过字节码技术为一个类创建子类, 并在子类中采用拦截的技术拦截所有父类方法的调用, 织入横切逻辑. 但是因为采用的是继承, 所以不能对final修饰的类进行代理. 因为final修饰的类不能被继承. 其实CGLIB动态代理模式是Java后端SpringAOP 的基础, 跟Android这边的字节码插桩类似, 都是操作字节码文件.. 都是运用了AOP的思想.
第一步:需导入cglib-nodep-2.1_3.jar包.
第二步:创建CGLIB 代理类
package com.zyang.proxycglib
import net.sf.cglib.proxy.Enhancer;
import net.sf.cglib.proxy.MethodInterceptor;
import net.sf.cglib.proxy.MethodProxy;
import java.lang.reflect.Method;
public class CglibProxy implements MethodInterceptor{
private object targetObject;
public Object getInstance(final Object tragetObject){
this.targetObject = tragetObject;
Enhancer enhancer = new Enhancer();
enhancer.setSuperclass(this.targetObject.getClass());
enhancer.setCallback(this);
return enhancer.create();
}
public Object intercept(Object obj,Method method,Object[] args,MethodProxy methodProxy) throws Throwable{
System.out.println("买车前,有很多存款")
Object result = methodProxy.invoke(obj,args);
System.out.println("买车后,没存款了");
return result;
}
}
第三步,创建测试类
public static void main(String[] args) {
Subject subjectCglib = new UsedCarCompany();
CglibProxy cglibProxy = new CglibProxy();
UsedCarCompany usedCarCompany = cglibProxy.getInstance(subjectCglib);
usedCarCompany.purchase("黑色");
}
CGLIB总结
1,CGLIB动态代理不要求目标对象一定要实现接口
2,代理逻辑的实际处理要实现MethodInterceptor接口, 在intercept()方法中对目标对象的方法进行增强
3,CGLIB通过Enhancer对象指定代理的目标对象, 实现处理逻辑的对象, 使用createa()在运行期间动态得到代理对象.
