JDK动态代理源码分析
4.1 JDK动态代理的实现
需要动态代理的接口
/**
需要动态代理的接口
*/
public interface Movie {
void player();
void speak();
需要动态代理的接口的真实实现
/**
需要动态代理接口的真实实现
*/
public class RealMovie implements Movie {
@Override
public void player() {
System.out.println("看个电影");
}
@Override
public void speak() {
System.out.println("说句话");
}
}
动态代理处理器
/**
* 动态代理处理类
*/
public class MyInvocationHandler implements InvocationHandler {
//需要动态代理接口的真实实现类
private Object object;
//通过构造方法去给需要动态代理接口的真实实现类赋值
public MyInvocationHandler(Object object) {
this.object = object;
}
/**
* 对真实实现的目标方法进行增强
* 当代理对象调用真实实现类的方法时，就会执行动态代理处理器中的该invoke方法
*
* @param proxy 生成的代理对象
* @param method 代理对象调用的方法
* @param args 调用的方法中的参数
* @return
* @throws Throwable
*/
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
//方法增强
System.out.println("卖爆米花");
//object是真实实现，args是调用方法的参数
//当代理对象调用真实实现的方法，那么这里就会将真实实现和方法参数传递过去，去调用真实实现的方法
method.invoke(object,args);
//方法增强
System.out.println("扫地");
return null;
}
}
创建代理对象
public class DynamicProxyTest {
public static void main(String[] args) {
// 保存生成的代理类的字节码文件
//由于设置sun.misc.ProxyGenerator.saveGeneratedFiles 的值为true,所以代理类的字节码内容保存在了项目根目录下，文件名为$Proxy0.class
System.getProperties().put("sun.misc.ProxyGenerator.saveGeneratedFiles", "true");
//需要动态代理接口的真实实现
RealMovie realMovie = new RealMovie();
//动态代理处理类
MyInvocationHandler handler = new MyInvocationHandler(realMovie);
//获取动态代理对象
//第一个参数：真实实现的类加载器
//第二个参数：真实实现类它所实现的所有接口的数组
//第三个参数：动态代理处理器
Movie movie = (Movie) Proxy.newProxyInstance(realMovie.getClass().getClassLoader(),
realMovie.getClass().getInterfaces(),
handler);
movie.player();
}
}
结果
由于设置 sun.misc.ProxyGenerator.saveGeneratedFiles 的值为true,所以代理类的字节码内容保存在了项目根目录下，文件名为$Proxy0.class
生成的代理对象字节码文件
public final class $Proxy0 extends Proxy implements Movie {
private static Method m1;
private static Method m3;
private static Method m2;
private static Method m4;
private static Method m0;
static {
try {
m1 = Class.forName("java.lang.Object").getMethod("equals", Class.forName("java.lang.Object"));
m3 = Class.forName("com.eayon.dynamic.Movie").getMethod("player");
m2 = Class.forName("java.lang.Object").getMethod("toString");
m4 = Class.forName("com.eayon.dynamic.Movie").getMethod("speak");
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 $Proxy0(InvocationHandler var1) throws {
super(var1);
}
/**
* 重写被代理接口的方法
* 因为生成的代理对象会实现被代理接口，所以我们在外部可以直接通过代理对象嗲偶哦那个被代理接口中的方法
*/
public final void speak() throws {
try {
//当外部通过代理对象调用被代理接口的方法时，其实是通过invocationHandler中的invoke()方法去调用的。
//这个h就是invocationHandler（我们之前创建的MyInvocationHandler代理处理器）
//this就是当前这个Proxy0代理对象
//m4则具体要调用的方法
super.h.invoke(this, m4, (Object[])null);
} catch (RuntimeException | Error var2) {
throw var2;
} catch (Throwable var3) {
throw new UndeclaredThrowableException(var3);
}
}
//与上面的speak方法同理，都是重写的被代理接口中的方法
public final void player() 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);
}
}
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);
}
}
}
代理对象的特点
1、代理类继承了Proxy类并且代理对象和真实实现一样都实现了要代理的接口
2、重写了equals、hashCode、toString
3、有一个静态代码块，通过反射或者代理类的所有方法
4、通过invoke执行代理类中的目标方法doSomething
4.2 源码分析
从上述代码中不难看出，创建代理对象的关键代码为：
//获取动态代理对象
//第一个参数：真实实现的类加载器
//第二个参数：真实实现类它所实现的所有接口的数组
//第三个参数：动态代理处理器
Movie movie = (Movie) Proxy.newProxyInstance(realMovie.getClass().getClassLoader(),
realMovie.getClass().getInterfaces(),
handler);
然后当执行如下代码的时候，也就是当代理对象调用真实实现的方法时，会自动跳转到动态代理处理器的invoke方法来进行调用。
movie.player();
这是为什么呢？
那其实归根结底都在Proxy.newProxyInstance()方法创建代理对象的源码中，我们一起来看看做了些什么
Proxy.newProxyInstance()
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);
}
//生成接口的代理对象的字节码文件（主要方法）
Class<?> cl = getProxyClass0(loader, intfs);
/*
* 使用自定义的InvocationHandler作为参数，调用构造函数获取代理对象示例
*/
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;
}
});
}
//通过代理对象的构造器调用newInstance()反射获取代理对象实例
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);
}
}
由上述代码我们发现，主要是通过getProxyClass0()方法去获取或者创建代理对象的字节码文件，通过代理对象字节码文件获取其构造器并通过反射生成代理对象实例。
那现在的重点就是如何获取或者创建代理对象的字节码文件，我们继续往下。
getProxyClass0(loader, intfs)
那其实真正生成代理对象字节码文件的是这个方法，他会传入真实实现的类加载器和他所实现的接口数组。
private static Class<?> getProxyClass0(ClassLoader loader,
Class<?>... interfaces) {
//限制真实实现所实现的接口数量不能大于65535个
if (interfaces.length > 65535) {
throw new IllegalArgumentException("interface limit exceeded");
}
// 首先从缓存中获取该接口对于的代理对象，如果有则返回，没有则通过ProxyClassFactory创建
return proxyClassCache.get(loader, interfaces);
}
ProxyClassFactory
缓存中获取我们比较好理解，但是我们并没有在上述方法中发现proxyClassFactory
我们可以点击进入proxyClassCache.get()方法看看是如何从缓存中获取的
public V get(K key, P parameter) {
Objects.requireNonNull(parameter);
expungeStaleEntries();
// 这里我们就理解成将真实实现的类加载器作为缓存key即可
Object cacheKey = CacheKey.valueOf(key, refQueue);
// 从缓存中获取代理对象
ConcurrentMap<Object, Supplier<V>> valuesMap = map.get(cacheKey);
if (valuesMap == null) {
ConcurrentMap<Object, Supplier<V>> oldValuesMap
= map.putIfAbsent(cacheKey,
valuesMap = new ConcurrentHashMap<>());
if (oldValuesMap != null) {
valuesMap = oldValuesMap;
}
}
// 缓存中不存在则根据subKeyFactory.apply(key, parameter)方法进行创建
Object subKey = Objects.requireNonNull(subKeyFactory.apply(key, parameter));
Supplier<V> supplier = valuesMap.get(subKey);
.......省略无用代码........
}
subKeyFactory.apply(key, parameter)
我们点击进入apply方法发现其实是BiFunction接口，我们找到它的实现
此时我们发现，我们进入的这个apply方法所在的位置是Proxy类下ProxyClassFactory这个静态内部类中
所以当缓存中没有相应的代理对象，则会调用ProxyClassFactory类的apply方法来创建代理类。
ProxyClassFactory.apply()
private static final class ProxyClassFactory
implements BiFunction<ClassLoader, Class<?>[], Class<?>>
{
// 生成代理对象的字节码文件名的前缀，用于组装文件名
private static final String proxyClassNamePrefix = “$Proxy”;
// 生成代理对象字节码文件名的计数器，用于组装文件名(计数器默认从0开始)
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) {
//校验类加载器是否能通过接口名称加载该类
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");
}
//校验该类是否是接口类型
if (!interfaceClass.isInterface()) {
throw new IllegalArgumentException(
interfaceClass.getName() + " is not an interface");
}
//校验接口是否重复
if (interfaceSet.put(interfaceClass, Boolean.TRUE) != null) {
throw new IllegalArgumentException(
"repeated interface: " + interfaceClass.getName());
}
}
String proxyPkg = null; // 代理对象包名
int accessFlags = Modifier.PUBLIC | Modifier.FINAL;
/*
* 用于生成代理对象需要使用的包名
* 非public接口，代理类的包名与接口的包名相同
*/
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) {
// 如果代理接口是public修饰的，则使用默认的com.sun.proxy package作为包名
proxyPkg = ReflectUtil.PROXY_PACKAGE + ".";
}
/*
* 为代理对象生成字节码文件名
* 文件名格式：proxyName = 之前生成的包名 + $Proxy + 当前计数器的值(计数器默认从0开始)
* 比如 proxyName = com.sun.proxy.$Proxy0
*/
long num = nextUniqueNumber.getAndIncrement();
String proxyName = proxyPkg + proxyClassNamePrefix + num;
/*
* 真正生成代理对象字节码文件的地方
*/
//生成代理对象字节码数组
byte[] proxyClassFile = ProxyGenerator.generateProxyClass(
proxyName, interfaces, accessFlags);
try {
// 将代理对象字节码数组生成字节码文件，并使用类加载器将代理对象的字节码文件加载到JVM内存中
return defineClass0(loader, proxyName,
proxyClassFile, 0, proxyClassFile.length);
} catch (ClassFormatError e) {
throw new IllegalArgumentException(e.toString());
}
}
}
我们可以看出它是通过ProxyGenerator.generateProxyClass()先生成代理对象字节码数组，
然后通过defineClass0()方法将代理对象的字节码数组生成字节码文件，并将该字节码通过类加载器加载到JVM中。
但是defineClass0()方法底层是通过native调用的C++，我们看不了，知道有这个事就行
ProxyGenerator.generateProxyClass(proxyName, interfaces, accessFlags)
这个方法随便看看就行，不用过多理解
public static byte[] generateProxyClass(final String var0, Class<?>[] var1, int var2) {
ProxyGenerator var3 = new ProxyGenerator(var0, var1, var2);
final byte[] var4 = var3.generateClassFile();
// 是否要将生成代理对象的字节码文件保存到磁盘中
// 该步骤也就是为什么之前我们在测试生成代理对象的时候使用System.getProperties().put("sun.misc.ProxyGenerator.saveGeneratedFiles", "true");来将代理对象字节码文件保存下来
if (saveGeneratedFiles) {
AccessController.doPrivileged(new PrivilegedAction<Void>() {
public Void run() {
try {
int var1 = var0.lastIndexOf(46);
Path var2;
if (var1 > 0) {
Path var3 = Paths.get(var0.substring(0, var1).replace('.', File.separatorChar));
Files.createDirectories(var3);
var2 = var3.resolve(var0.substring(var1 + 1, var0.length()) + ".class");
} else {
var2 = Paths.get(var0 + ".class");
}
Files.write(var2, var4, new OpenOption[0]);
return null;
} catch (IOException var4x) {
throw new InternalError("I/O exception saving generated file: " + var4x);
}
}
});
}
return var4;
}
4.3 总结
创建代理对象的核心方法就是Proxy.newProxyInstance()。该方法首先会调用getProxyClass0() 从缓存中获取或者创建代理对象字节码文件，拿到代理对象字节码文件后调用getConstructor()方法获取代理对象的构造器，最后通过cons.newInstance() 根据代理对象的构造器反射生成代理对象实例并返回。
我们回过头来看getProxyClass0()方法，该方法首先判断真实实现所实现的接口数量是否超限，没有超限则proxyClassCache.get()从缓存中获取代理实例。如果缓存中没有，则去创建代理对象。那么是如何创建的呢？首先会根据：包名 + $proxy0 + 当前计数器的值(默认从0开始) 生成代理对象的名称，其次根据名称和代理对象需要实现的被代理接口去生成代理对象字节码数组。拿到字节码数组之后，就可以通过调用的native方法去生成代理对象字节码文件，最后进行返回。
