Android 源码系列之《二十二》从源码的角度深入理解Java的动态代理机制(下)

转载请注明出处：https://blog.csdn.net/llew2011/article/details/85928756

在上篇文章Android 源码系列之《二十二》从源码的角度深入理解Java的动态代理机制(上)中我们讲解了如何通过动态代理解决在HuaWei手机Android 9.0版本中注册BroadcastReceiver超过1000引发应用crash的问题，但这种解决方式并不太合理，正确的做法是在注册完BroadcastReceiver后当不需要使用BroadcastReceiver时应及时反注册从而保证应用注册的BroadcastReceiver数量没有超过阀值。这篇文章我们就从源码的角度深入学习一下Java的动态代理机制。

通过上篇文章我们知道使用Java的动态代理功能有两个前提条件：一个是有接口的存在；另一个是必须有接口的实现类和实例。只有满足了这两个条件，我们才能使用Java的动态代理功能对接口中的方法做代理。使用Java的动态代理功能就是使用Proxy和InvocationHandler这两个API，入口就是使用Proxy的newProxyInstance()方法，newProxyInstance()方法源码如下：

public static Object newProxyInstance(ClassLoader loader, Class<?>[] interfaces, InvocationHandler h) throws IllegalArgumentException {
    // h必须参数，为null就抛异常
    if (h == null) {
        throw new NullPointerException();
    }
    // 备份传递进来的interfaces数组
    final Class<?>[] intfs = interfaces.clone();
    final SecurityManager sm = System.getSecurityManager();
    // 权限检查，可忽略
    if (sm != null) {
        checkProxyAccess(Reflection.getCallerClass(), loader, intfs);
    }

    /*
     * getProxyClass0()方法是重点，功能是从缓存中查找或者生成目标类，
     */
    Class<?> cl = getProxyClass0(loader, intfs);

    try {
        // 获取指定参数constructorParams的构造方法类
        final Constructor<?> cons = cl.getConstructor(constructorParams);
        final InvocationHandler ih = h;
        // 权限检查，最终也是调用newInstance()方法
        if (sm != null && ProxyAccessHelper.needsNewInstanceCheck(cl)) {
            return AccessController.doPrivileged(new PrivilegedAction<Object>() {
                public Object run() {
                    // 调用newInstance()方法，注意ih参数最终传递给了cons
                    return newInstance(cons, ih);
                }
            });
        } else {
            // 调用newInstance()方法，注意ih参数最终传递给了cons
            return newInstance(cons, ih);
        }
    } catch (NoSuchMethodException e) {
        throw new InternalError(e.toString());
    }
}

Proxy的newProxyInstance()方法需要三个参数，分别表示如下：

• loader
       待生成代理类的类加载器
• interfaces
       待生成代理类需要实现的接口
• h
       执行代理类中的方式时对外提供的回调

newProxyInstance()方法的流程先校验参数h是否为null，如果为null就直接抛异常，接着对参数interfaces做备份，最后调用getProxyClass0()方法获取一个Class类型的cl对象，获取到cl后调用cl含有一个InvocationHandler参数的构造方法并赋值给cons，最后调用newInstance(cons, ih)方法通过反射生成一个代理类对象并返回，根据以上流程我们可以得出生成代理对象的一些简单结论：该代理对象有一个带有InvocationHandler参数的构造方法，在生成代理对象的时候我们把外界的InvocationHandler实例ih传递给了该代理类。

Proxy的newProxyInstance()方法流程很简单，重点在其内部的getProxyClass()方法，源码如下：

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);
}

getProxyClass0()方法先对参数interfaces数组做了长度校验，如果超过65535就抛异常(也就是说使用Java的动态代理功能一次性最多只能代理65535个接口)，最后通过proxyClassCache的get()方法获取到代理Class，proxyClassCache是Proxy的内部静态属性，它是WeakCache类型，核心功能是提供缓存来提高效率，proxyClassCache的定义如下所示：

// proxyClassCache的初始化
private static final WeakCache<ClassLoader, Class<?>[], Class<?>>
    proxyClassCache = new WeakCache<>(new KeyFactory(), new ProxyClassFactory());

// WeakCache构造方法
public WeakCache(BiFunction<K, P, ?> subKeyFactory,
                 BiFunction<K, P, V> valueFactory) {
    // subKeyFactory是KeyFactory实例
    this.subKeyFactory = Objects.requireNonNull(subKeyFactory);
    // valueFactory是ProxyClassFactory实例
    this.valueFactory = Objects.requireNonNull(valueFactory);
}

WeakCache对外提供的构造方法WeakCache(BiFunction<K, P, ?> subKeyFactory, BiFunction<K, P, V> valueFactory)需要两个BiFunction类型的参数，其中subKeyFactory的作用是生成缓存key，valueFactory的作用是当缓存中不存在目标Class时则负责创建Class(从源码可知proxyClassCache在初始化的时候传递了KeyFactory和ProxyClassFactory实例对象)。接下来我们看一下WeakCache的get()方法，如下所示：

public V get(K key, P parameter) {
    // 对参数parameter做非空校验
    Objects.requireNonNull(parameter);

    expungeStaleEntries();
    // 生成一个特殊的key：cacheKey
    Object cacheKey = CacheKey.valueOf(key, refQueue);

    // 根据cacheKey从缓冲中查找
    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;
        }
    }


    Object subKey = Objects.requireNonNull(subKeyFactory.apply(key, parameter));
    Supplier<V> supplier = valuesMap.get(subKey);
    Factory factory = null;

    while (true) {
        if (supplier != null) {
            // 调用supplier的get()方法
            V value = supplier.get();
            if (value != null) {
                return value;
            }
        }

        // 初始化factory
        if (factory == null) {
            factory = new Factory(key, parameter, subKey, valuesMap);
        }

        // 初始化supplier
        if (supplier == null) {
            supplier = valuesMap.putIfAbsent(subKey, factory);
            if (supplier == null) {
                supplier = factory;
            }
        } else {
            if (valuesMap.replace(subKey, supplier, factory)) {
                supplier = factory;
            } else {
                supplier = valuesMap.get(subKey);
            }
        }
    }
}

WeakCache的get()方法核心就是从缓冲中查找目标Class对象，如果找到就返回，否则就调用ProxyClassFactory实例创建，ProxyClassFactory的源码如下：

private static final class ProxyClassFactory implements BiFunction<ClassLoader, Class<?>[], Class<?>> {
    // 生成代理Class的前缀
    private static final String proxyClassNamePrefix = "$Proxy";

    // 通过序列号确保生成的代理Class名字唯一
    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 {
                // 通过loader加载传递进来的接口Class
                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());
            }
        }

        // 待生成代理Class的包名
        String proxyPkg = null;

        // 确定代理Class的包路径，如果接口数组中只有一个包访问权限的接口，则生成代理Class的包路径就是该接口的包路径，如果包含多个包访问权限的接口，则抛异常
        for (Class<?> intf : interfaces) {
            int flags = intf.getModifiers();
            if (!Modifier.isPublic(flags)) {
                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");
                }
            }
        }

        // 验证结束如果没有包权限的接口，则生成代理Class的包名为com.sun.proxy.
        if (proxyPkg == null) {
            proxyPkg = ReflectUtil.PROXY_PACKAGE + ".";
        }

        // 生成代理类的名字，格式为：com.sun.proxy.$Proxy0 ... com.sun.proxy.$ProxyN等
        long num = nextUniqueNumber.getAndIncrement();
        String proxyName = proxyPkg + proxyClassNamePrefix + num;

        // 调用ProxyGenerator的generateProxyClass()方法生成二进制文件
        byte[] proxyClassFile = ProxyGenerator.generateProxyClass(proxyName, interfaces);
        try {
            // 调用native方法defineClass0()生成代理Class对象并返回
            return defineClass0(loader, proxyName, proxyClassFile, 0, proxyClassFile.length);
        } catch (ClassFormatError e) {
            throw new IllegalArgumentException(e.toString());
        }
    }
}

ProxyClassFactory的apply()方法注解写的很详细，该方法的流程是先遍历数组参数判断接口类的合法性，然后确定待生成Class的包路径和名字，准备就绪之后调用ProxyGenerator的generateProxyClass()方法生成一个byte[]数组(byte[]数组内容就是待生成代理类的二进制文件)，最后调用native方法defineClass0()生成一个Class对象并返回。

ProxyGenerator类在sun.misc包下，其源码可参照这里http://www.docjar.com/html/api/sun/misc/ProxyGenerator.java.html，它的功能就是根据JVM规范生成Class类的二进制文件，ProxyGenerator类中的具体流程就不再分析了，有感兴趣的可以自行分析，由于没法直接调用该方法，我通过反射方式调用了ProxyGenerator的generateProxyClass()方法后得到了byte[]数组并将该byte[]数组内容直接保存在.class文件中，最后反编译该文件并重写排版后，结果如下所示：

public final class $Proxy0 extends Proxy implements IActivityManager {

	// 基础方法
	private static Method m0;	// hashCode()方法
	private static Method m1;	// equals()  方法
	private static Method m2;	// toString()方法

	// 以下是IActivityManager接口中定义的方法
	private static Method m3;	// registerReceiver()方法
	private static Method m4;	// unregisterReceiver()方法
	// ......                    

	static {
		try {
			// 基础方法
			m0 = Class.forName("java.lang.Object").getMethod("hashCode", new Class[0]);
			m1 = Class.forName("java.lang.Object").getMethod("equals", new Class[] { Class.forName("java.lang.Object") });
			m2 = Class.forName("java.lang.Object").getMethod("toString", new Class[0]);

			// 接口中定义的方法
			m3 = Class.forName("android.app.IActivityManager").getMethod("registerReceiver", new Class[] { Class.forName("android.content.BroadcastReceiver"), Class.forName("android.content.IntentFilter") });
			m4 = Class.forName("android.app.IActivityManager").getMethod("unregisterReceiver", new Class[] { Class.forName("android.content.BroadcastReceiver") });
			
			// ......

		} catch (NoSuchMethodException var2) {
			throw new NoSuchMethodError(var2.getMessage());
		} catch (ClassNotFoundException var3) {
			throw new NoClassDefFoundError(var3.getMessage());
		}
	}

	public Proxy0(InvocationHandler var1) {
		super(var1);
	}

	public final int hashCode() {
		try {
			return ((Integer) super.h.invoke(this, m0, (Object[]) null)).intValue();
		} catch (RuntimeException | Error var2) {
			throw var2;
		} catch (Throwable var3) {
			throw new UndeclaredThrowableException(var3);
		}
	}

	public final boolean equals(Object var1) {
		try {
			return ((Boolean) super.h.invoke(this, m1, new Object[] { var1 })).booleanValue();
		} catch (RuntimeException | Error var3) {
			throw var3;
		} catch (Throwable var4) {
			throw new UndeclaredThrowableException(var4);
		}
	}

	public final String toString() {
		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 Intent registerReceiver(BroadcastReceiver var1, IntentFilter var2) {
		try {
			return (Intent) super.h.invoke(this, m3, new Object[] { var1, var2 });
		} catch (RuntimeException | Error var4) {
			throw var4;
		} catch (Throwable var5) {
			throw new UndeclaredThrowableException(var5);
		}
	}

	public final void unregisterReceiver(BroadcastReceiver var1) {
		try {
			super.h.invoke(this, m4, new Object[] { var1 });
		} catch (RuntimeException | Error var3) {
			throw var3;
		} catch (Throwable var4) {
			throw new UndeclaredThrowableException(var4);
		}
	}
	
	// 省略部分方法

}

根据反编译的结果，我们发现ProxyGenerator生成的$Proxy0类和它的内部方法都有final修饰符，它继承了Proxy且实现了从外界传递进来的接口类IActivityManger。$Proxy0类中定义了一系列Method对象，这些Method对象是在static语句块中进行的初始化(放在static语句块中确保这些Method对象仅且仅初始化一次)，通过这些Method的初始化我们发现它们分别代表了接口中定义的方法和toString()、equals()、hashCode()方法，我们拿registerReceiver()方法举例：

public final Intent registerReceiver(BroadcastReceiver var1, IntentFilter var2) {
	try {
		return (Intent) super.h.invoke(this, m3, new Object[] { var1, var2 });
	} catch (RuntimeException | Error var4) {
		throw var4;
	} catch (Throwable var5) {
		throw new UndeclaredThrowableException(var5);
	}
}

registerReceiver()方法中调用的是父类的super.h的invoke()方法，h是父类Proxy类中定义的属性，它是InvocationHandler类型(根据前边$Proxy0的初始化可知h就是我们调用Proxy的newProxyInstance()方法时传递的第三个参数)。在调用invoke(Object proxy, Method method, Object[] args)方法时第一个参数proxy传递的this(也就是说把当前$Proxy0对象本身传递给了super.h的invoke()方法中)，第二个参数method传递的是m3，简单理解就是把当前方法名传递进去了(可以看m3的初始化代码)，第三个args参数把当前方法的参数作为新的参数传递给了invoke()方法中，之后把invoke()方法执行的结果返回了。这就是生成代理类对方法的处理，其它方法也是同样逻辑就不再叙述了。

接下来我们看一下InvocationHandler的源码，如下：

public interface InvocationHandler {

    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable;
}

InvocationHandler接口只定义了一个invoke()方法，该方法接收三个参数，其参数分别表示如下：

• proxy
       proxy表示通过ProxyGenerator类动态创建出来的代理类的实例：$Proxy0、$Proxy1...$ProxyN
• method
       method表示将要执行的方法，一般是接口中定义的方法或是toString(),equals(),hashCode()方法
• args
       args表示执行method方法所需要的参数，如果method没有参数那么args为null

分析到这里已经可以回答在上篇文章末尾遗留的问题了，调用Proxy的newProxyInstance(ClassLoader loader, Class<?>[] interfaces, InvacationHandler h)方法返回一个Object对象，该对象就是$Proxy0、$Proxy1......$ProxyN，它们继承了Proxy类并且实现了参数interfaces中的接口，当调用这些代理对象的方法时又委托给我们从外界传递的InvocationHandler类型参数h从而允许我们有一个入口来对interfaces接口中的方法做拦截操作，仔细回味一下这种代码设计，真的很棒！！！

好了，到这里已经分析完了Java的动态代理机制，由于篇幅原因部分细节没有做分析(特别是调用ProxyGenerator的generateProxyClass()方法)，但这并不影响我们主流程的分析，有感兴趣的小伙伴可以自行分析，最后感谢收看(*^__^*) ……