对于代理,在面向切面时会接触到,比如aop底层就是运用到了代理技术,有针对于接口的jdk动态代理,也有使用继承的cglib代理。
这里介绍jdk动态代理
代理角色构成有三种,分别是抽象角色,真实角色和代理角色。
抽象角色:一般为接口
真实角色:真实对象
代理角色:帮助真实角色完成任务,是对真实对象的增强。类似于中介,比如买房租房时,需要借助中介,帮我们寻找信息,我们只要去查看房子是否满意即可,不需要自己一个个去找。
关于静态代理和动态代理的使用可以参考https://www.cnblogs.com/LCcnblogs/p/6823982.html
下面分析源码
抽象类代码
public interface ISubject {
void doThings();
}
真实角色类代码
public class RealSubject implements ISubject{
@Override
public void doThings() {
System.out.println("真实方法");
}
}
场景类Client 代码
public class Client {
/**
* 获取生成的代理对象
* 这个方法可以单独封装起来,这里为了方便就放在这里
* @param c 真实对象Class
* @param invocationHandler
* @param <T>
* @return
*/
public static <T>T getProxyObj(Class c, InvocationHandler invocationHandler){
ClassLoader classLoader = c.getClassLoader();
Class<?>[] interfaces = c.getInterfaces();
return (T) Proxy.newProxyInstance(classLoader,interfaces,invocationHandler);
}
public static void main(String[] args) {
SubjectIvHandler handler = new SubjectIvHandler(new RealSubject());
//将InvocationHandler对象传递到代理对象中,
//代理对象调用每一个方法实际上都是调用handler对象的invoke方法,
// 包括toString,hashcode,equals这三个方法,其他的Object方法就没有
ISubject proxyObj = getProxyObj(RealSubject.class,handler);
System.out.println("proxyObj 的 Class 对象: "+proxyObj.getClass());
//执行结果
//proxyObj 的 Class 对象: class com.sun.proxy.$Proxy0
proxyObj.doThings();
//执行结果
// before
//真实方法
// after
}
}
SubjectIvHandler 类(实现InvocationHandler 接口)
public class SubjectIvHandler implements InvocationHandler {
//真实对象的引用
private Object realobj;
public SubjectIvHandler(Object object){
this.realobj = object;
}
/**
* 对真实对象内的方法进行增强
* @param proxy 生成的代理对象
* @param method 方法对象
* @param args 方法参数
* @return 方法返回值
* @throws Throwable
*/
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
Object o;
System.out.println("before");
o=method.invoke(realobj,args);
System.out.println("after");
return o;
}
}
在这里面,有两个东西十分重要,分别是Proxy类 和 InvocationHandler 接口。
Proxy类为我们创建代理对象提供了方法,jdk动态代理生成的类都会继承于Proxy类,并实现我们提供的抽象接口。
InvocationHandler 接口:代理对象调用处理程序实现的接口。在Proxy内部会有一个InvocationHandler的成员变量,用于接收并调用增强方法。
在场景类main方法中,我们使用生成出来的代理对象,调用doThings()方法,结果为
// before
//真实方法
// after
可以看到,代理对象对真实对象进行了增强,查看代理对象的Class类型,发现是class com.sun.proxy.$Proxy0 类。
使用Proxy类提供的方法,将代理类生成出来
String path = "D:/$Proxy0.class";
byte[] classFile = ProxyGenerator.generateProxyClass("$Proxy0",RealSubject.class.getInterfaces());
FileOutputStream out = null;
try {
out = new FileOutputStream(path);
out.write(classFile);
out.flush();
} catch (Exception e) {
e.printStackTrace();
} finally {
try {
out.close();
} catch (IOException e) {
e.printStackTrace();
}
}
对$Proxy进行反编译,如下
public final class $Proxy0 extends Proxy implements ISubject {
private static Method m1;
private static Method m3;
private static Method m2;
private static Method m0;
public $Proxy0(InvocationHandler var1) throws {
super(var1);
}
static {
try {
m1 = Class.forName("java.lang.Object").getMethod("equals", Class.forName("java.lang.Object"));
m3 = Class.forName("com.zzzz.jvm.dynamic.ISubject").getMethod("doThings");
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());
}
}
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 void doThings() throws {
try {
super.h.invoke(this, m3, (Object[])null);
} catch (RuntimeException | Error var2) {
throw var2;
} catch (Throwable var3) {
throw new UndeclaredThrowableException(var3);
}
}
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);
}
}
}
可以看到,代理类继承了Proxy类,并实现类ISubject接口,在代理类中,除了对接口中的doThings()做增强外,还默认包括了三个方法,即toString()、hashCode()、equals()方法。
调用代理类的doThings()方法,实际上会使用传递进来的InvocationHandler 实现类(即SubjectIvHandler)的invoke()方法。
查看Proxy类源码,可以看到InvocationHandler 成员变量
进一步源码分析
在这里面,Proxy.newProxyInstance(classLoader,interfaces,invocationHandler)
这行代码可以生成一个代理对象,生成过程大致如下
在newProxyInstance方法中,getProxyClass0方法会返回生成的代理类的Class对象,之后便是通过反射,构造出具体的对象并返回
可以看到,调用了代理对象的有参构造函数,将InvocationHandler 实现类传递进去
接下来看看getProxyClass0方法,主要是如下代码
其中,proxyClassCache是一个WeakCache类对象,用于做代理类缓存
进一步查看get方法,里面都是一些跟缓存和懒加载相关的内容
public synchronized V get() { // serialize access
// re-check
Supplier<V> supplier = valuesMap.get(subKey);
if (supplier != this) {
// something changed while we were waiting:
// might be that we were replaced by a CacheValue
// or were removed because of failure ->
// return null to signal WeakCache.get() to retry
// the loop
return null;
}
// else still us (supplier == this)
// create new value
V value = null;
try {
value = Objects.requireNonNull(valueFactory.apply(key, parameter));
} finally {
if (value == null) { // remove us on failure
valuesMap.remove(subKey, this);
}
}
// the only path to reach here is with non-null value
assert value != null;
// wrap value with CacheValue (WeakReference)
CacheValue<V> cacheValue = new CacheValue<>(value);
// put into reverseMap
reverseMap.put(cacheValue, Boolean.TRUE);
// try replacing us with CacheValue (this should always succeed)
if (!valuesMap.replace(subKey, this, cacheValue)) {
throw new AssertionError("Should not reach here");
}
// successfully replaced us with new CacheValue -> return the value
// wrapped by it
return value;
}
}
在这其中,生成了一个WeakCache内部类Factory的实例,进一步调用其内部的get方法,在这个方法中,可以看到这样一行代码
value = Objects.requireNonNull(valueFactory.apply(key, parameter));
这里的valueFactory是WeakCache类中的成员变量,在Proxy类的初始化阶段,就已经创建好一个WeakCache对象,并将ProxyClassFactory传递给valueFactory,如下所示
其实兜了一圈,就是调用类Proxy类中的内部类ProxyClassFactory中的apply方法,查看apply方法
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) {
// 如果没有非公共代理接口,就使用 com.sun.proxy 包
proxyPkg = ReflectUtil.PROXY_PACKAGE + ".";
}
/*
* 生成代理类的名称
*/
long num = nextUniqueNumber.getAndIncrement();
String proxyName = proxyPkg + proxyClassNamePrefix + num;
/*
* Generate the specified proxy class.
*/
byte[] proxyClassFile = ProxyGenerator.generateProxyClass(
proxyName, interfaces, accessFlags);
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());
}
}
}
在这里面就可以清楚地看到,生成了代理类的名称,并生成了二进制的字节码文件,之后再将加载代理类的二进制文件,并返回Class对象
byte[] proxyClassFile = ProxyGenerator.generateProxyClass(
proxyName, interfaces, accessFlags);
return defineClass0(loader, proxyName,proxyClassFile, 0, proxyClassFile.length);
*ProxyGenerator.generateProxyClass( proxyName, interfaces, accessFlags)*这个方法可以根据接口和名称生成代理类的二进制文件,再往下看就要开始涉及到字节码的内容了,这里简单查看一下,通过debug,可以看到,此时生成了一个代理生成器,并真正地开始生成字节码的二进制文件。
再往下,可以看到,代理类默认添加了hashCode,equals和toString这三个方法,这也是我们在生成的代理类中看到这三个方法的原因。
再往下,就是通过接口循环添加要增强的方法,接下去就是和字节码的内部细节有关,这里就不再深入。