Java动态代理源码分析及知识点总结
什么是动态代理
为了实现代理模式，在不破坏面向对象的开闭原则上，进行功能的组合。代理模式：某一个对象提供一个代理或者占位符，并由代理对象控制原对象的访问。静态代理就是需要给每个接口实现一个代理类。
动态代理是代理类的对象自动生成。
所以，代理类不同于其他的普通类，其字节码不存在于.class文件中，而是自动生成的。
动态代理的具体作用：
- Proxy类的代码量被固定下来，不会因为业务的逐渐庞大而庞大；
- 可以实现AOP编程，实际上静态代理也可以实现，总的来说，AOP可以算作是代理模式的一个典型应用；
- 解耦，通过参数就可以判断真实类，不需要事先实例化，更加灵活多变。
动态代理的应用
动态代理在Java中有着广泛的应用，比如Spring AOP、Hibernate数据查询、测试框架的后端mock、RPC远程调用、Java注解对象获取、日志、用户鉴权、全局性异常处理、性能监控，甚至事务处理等。
动态代理的原理
Java动态代理是基于反射机制实现的。
动态代理的主要类和接口有：java.lang.reflect.Proxy、java.lang.reflect.InvocationHandler、 java.lang.ClassLoader。
- java.lang.reflect.Proxy
动态代理机制的主类，提供一组静态方法为一组接口动态的生成对象和代理类。 - java.lang.reflect.InvocationHandler
调用处理器接口，自定义invoke方法，用于实现对于真正委托类的代理访问。 - java.lang.ClassLoader
将类的字节码装载到 Java 虚拟机（JVM）中并为其定义类对象，然后该类才能被使用。Proxy类与普通类的唯一区别就是其字节码是由 JVM 在运行时动态生成的而非预存在于任何一个 .class 文件中。
一般的动态代理步骤如下：
- 创建需要被代理类的实例；
- 创建InvocationHandler与实例关联
- 创建代理对象；
- 代理对象执行被代理对象的方法。
下面从Proxy类中的方法开始分析源码：
1.newProxyInstance()方法
这个方法的主要步骤就是通过getProxyClass0()方法生成代理类。然后调用代理类的构造器，以之前创建的InvocationHandler实例 为参数创建代理对象实例。
@CallerSensitive
// 这里需要传入被代理类的类加载器，被代理类对象和InvocationHandler 处理器接口
public static Object newProxyInstance(ClassLoader loader,
Class<?>[] interfaces,
InvocationHandler h)
throws IllegalArgumentException
{
// 检查传入的InvocationHandler 是不是空的
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);
/*
* Invoke its constructor with the designated invocation handler.
*/
try {
if (sm != null) {
// 检查调用者的权限
checkNewProxyPermission(Reflection.getCallerClass(), cl);
}
// 获取InvocationHandler的构造器
// private static final Class<?>[] constructorParams = { InvocationHandler.class };
final Constructor<?> cons = cl.getConstructor(constructorParams);
final InvocationHandler ih = h;
// 通过反射的方法检查InvocationHandler的构造器是否可访问
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);
}
}
2.getProxyClass0()方法
代理类的类对象就是通过这个方法生成的，它需要传入被代理类的类加载器和类对象。
private static Class<?> getProxyClass0(ClassLoader loader,
Class<?>... interfaces) {
// 被代理类对象的数量上限
if (interfaces.length > 65535) {
throw new IllegalArgumentException("interface limit exceeded");
}
// 如果缓存中能够命中代理对象，那么直接返回缓存
// 缓存中没有的话就要通过调用ProxyClassFactory新创建一个代理类
return proxyClassCache.get(loader, interfaces);
}
下面来看看这个proxyClassCache，就是一个弱引用的缓存，应该是通过字典实现的，字典的键就是类加载器实例，这里传入了ProxyClassFactory，用于创建代理类对象。
private static final WeakCache<ClassLoader, Class<?>[], Class<?>>
proxyClassCache = new WeakCache<>(new KeyFactory(), new ProxyClassFactory());
3.ProxyClassFactory类
ProxyClassFactory是Proxy的一个内部类。
private static final class ProxyClassFactory
implements BiFunction<ClassLoader, Class<?>[], Class<?>>
{
// 代理类的名字的前缀
private static final String proxyClassNamePrefix = "$Proxy";
// 用源自类来生成代理类的序号，保证序号的唯一
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) {
}
// intf是否可以让这个类加载器加载
if (interfaceClass != intf) {
throw new IllegalArgumentException(
intf + " is not visible from class loader");
}
// 检查intf是否是一个接口
if (!interfaceClass.isInterface()) {
throw new IllegalArgumentException(
interfaceClass.getName() + " is not an interface");
}
// intf是否有重复
if (interfaceSet.put(interfaceClass, Boolean.TRUE) != null) {
throw new IllegalArgumentException(
"repeated interface: " + interfaceClass.getName());
}
}
// 生成代理类的包名
String proxyPkg = null; // package to define proxy class in
// 代理类的访问标志，是public的
int accessFlags = Modifier.PUBLIC | Modifier.FINAL;
// 验证所有的非公共代理类接口都在一个包中
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;
// 利用ProxyGenerator的generateProxyClass()方法来生产代理类的字节码，并放到指定目录下
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());
}
}
}
这里的IdentityHashMap是什么？
大致上和HashMap是一样的，区别在于，它们对于键的哈希方法，IdentityHashMap的hash是基于对象本身，而HashMap是基于对象的值。什么意思呢，就是说如果不同对象中值相等，HashMap还是会认为是同一个键，而IdentityHashMap相反。
4.ProxyGenerator.generateProxyClass()方法
这个方法用于生成代理类字节码文件和保存文件
public static byte[] generateProxyClass(final String var0, Class<?>[] var1, int var2) {
// 构造代理类生成器对象
ProxyGenerator var3 = new ProxyGenerator(var0, var1, var2);
// 生成代理类字节码文件
final byte[] var4 = var3.generateClassFile();
// 是否需要将字节码文件进行保存
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;
}
5.ProxyGenerator.generateClassFile()方法
这个方法才是正常产生代理类文件字节码的核心方法。大致流程就是组装对象的字段和方法信息等，再将对象写入成class文件的字节码形式。
private byte[] generateClassFile() {
// 将Object下的基本方法都放到代理类中
this.addProxyMethod(hashCodeMethod, Object.class);
this.addProxyMethod(equalsMethod, Object.class);
this.addProxyMethod(toStringMethod, Object.class);
Class[] var1 = this.interfaces;
int var2 = var1.length;
int var3;
Class var4;
// 遍历接口的所有方法，然后放到代理类中
for(var3 = 0; var3 < var2; ++var3) {
var4 = var1[var3];
Method[] var5 = var4.getMethods();
int var6 = var5.length;
for(int var7 = 0; var7 < var6; ++var7) {
Method var8 = var5[var7];
this.addProxyMethod(var8, var4);
}
}
Iterator var11 = this.proxyMethods.values().iterator();
List var12;
while(var11.hasNext()) {
var12 = (List)var11.next();
checkReturnTypes(var12);
}
// 将类的字段和方法信息进行写入
Iterator var15;
try {
// 添加构造方法
this.methods.add(this.generateConstructor());
var11 = this.proxyMethods.values().iterator();
// 比那里缓存中的代理方法
while(var11.hasNext()) {
var12 = (List)var11.next();
var15 = var12.iterator();
while(var15.hasNext()) {
ProxyGenerator.ProxyMethod var16 = (ProxyGenerator.ProxyMethod)var15.next();
// 添加静态字段
this.fields.add(new ProxyGenerator.FieldInfo(var16.methodFieldName, "Ljava/lang/reflect/Method;", 10));
// 添加代理类的代理方法
this.methods.add(var16.generateMethod());
}
}
// 添加代理类的静态字段初始化方法
this.methods.add(this.generateStaticInitializer());
} catch (IOException var10) {
throw new InternalError("unexpected I/O Exception", var10);
}
// 方法和字段数量上限
if (this.methods.size() > 65535) {
throw new IllegalArgumentException("method limit exceeded");
} else if (this.fields.size() > 65535) {
throw new IllegalArgumentException("field limit exceeded");
} else {
// 验证常量池中存在代理类的全限定名
this.cp.getClass(dotToSlash(this.className));
// 验证常量池中代理类父类的全限定名
this.cp.getClass("java/lang/reflect/Proxy");
var1 = this.interfaces;
var2 = var1.length;
// 验证常量池存在代理类接口的全限定名
for(var3 = 0; var3 < var2; ++var3) {
var4 = var1[var3];
this.cp.getClass(dotToSlash(var4.getName()));
}
// 设置常量池只读
this.cp.setReadOnly();
ByteArrayOutputStream var13 = new ByteArrayOutputStream();
// 通过流的方法获得常量池字节信息
DataOutputStream var14 = new DataOutputStream(var13);
try {
// 写入class文件
// 魔数
var14.writeInt(-889275714);
// 次版本号
var14.writeShort(0);
// 主版本号
var14.writeShort(49);
// 写入常量池
this.cp.write(var14);
// 访问修饰符
var14.writeShort(this.accessFlags);
// 写入类索引
var14.writeShort(this.cp.getClass(dotToSlash(this.className)));
// 写入父类索引
var14.writeShort(this.cp.getClass("java/lang/reflect/Proxy"));
// 写入接口计数值
var14.writeShort(this.interfaces.length);
Class[] var17 = this.interfaces;
int var18 = var17.length;
// 写入接口
for(int var19 = 0; var19 < var18; ++var19) {
Class var22 = var17[var19];
var14.writeShort(this.cp.getClass(dotToSlash(var22.getName())));
}
// 写入字段计数值
var14.writeShort(this.fields.size());
var15 = this.fields.iterator();
// 写入字段
while(var15.hasNext()) {
ProxyGenerator.FieldInfo var20 = (ProxyGenerator.FieldInfo)var15.next();
var20.write(var14);
}
// 写入方法计数值
var14.writeShort(this.methods.size());
var15 = this.methods.iterator();
// 写入方法
while(var15.hasNext()) {
ProxyGenerator.MethodInfo var21 = (ProxyGenerator.MethodInfo)var15.next();
var21.write(var14);
}
// 写入属性计数值
var14.writeShort(0);
return var13.toByteArray();
} catch (IOException var9) {
throw new InternalError("unexpected I/O Exception", var9);
}
}
}
动态代理的使用例子
//创建一个实例对象，这个对象是被代理的对象
Person person = new Student("lippon");
//创建一个与代理对象相关联的InvocationHandler
InvocationHandler stuHandler = new StuInvocationHandler<Person>(person );
//创建一个代理对象stuProxy来代理zhangsan，代理对象的每个执行方法都会替换执行Invocation中的invoke方法
Person stuProxy = (Person) Proxy.newProxyInstance(Person.class.getClassLoader(), new Class<?>[]{Person.class}, stuHandler);
//代理执行上交班费的方法
stuProxy.giveMoney();
class StuInvocationHandler<T> implements InvocationHandler {
//invocationHandler持有的被代理对象
T target;
public StuInvocationHandler(T target) {
this.target = target;
}
/**
* proxy:代表动态代理对象
* method：代表正在执行的方法
* args：代表调用目标方法时传入的实参
*/
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
System.out.println("代理执行" +method.getName() + "方法");
//代理过程中插入监测方法,计算该方法耗时
MonitorUtil.start();
Object result = method.invoke(target, args);
MonitorUtil.finish(method.getName());
return result;
}
}
class MonitorUtil {
private static ThreadLocal<Long> tl = new ThreadLocal<>();
public static void start() {
tl.set(System.currentTimeMillis());
}
//结束时打印耗时
public static void finish(String methodName) {
long finishTime = System.currentTimeMillis();
System.out.println(methodName + "方法耗时" + (finishTime - tl.get()) + "ms");
}
}
interface Person {
//上交班费
void giveMoney();
}
class Student implements Person {
private String name;
public Student(String name) {
this.name = name;
}
@Override
public void giveMoney() {
System.out.println(name + "上交班费100元");
}
}
