文章目录
一、简介
JDK动态代理是使用Java内部的反射机制来实现动态代理的方式。
实现原理：被代理类和代理类实现同一个接口，代理对象持有被代理对象来达到拦截方法并进行代理的作用。
限制：
- 被代理类必须实现了接口
- 无法代理接口中未声明的方法
二、 JDK动态代理Demo
1. 被代理类实现的接口
package com.dotwait.proxy.service;
public interface UserService {
void printUserInfo();
}
2. 实现UserService接口的被代理类
package com.dotwait.proxy.service;
public class UserServiceImpl implements UserService{
public void printUserInfo() {
System.out.println("打印用户信息");
}
}
3. 实现InvocationHandler接口
package com.dotwait.proxy.handler;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
public class ProxyHandler implements InvocationHandler {
// 被代理对象
private Object target;
public ProxyHandler(Object target) {
this.target = target;
}
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
doBefore();
// 调用target的实际方法
Object result = method.invoke(target, args);
doAfter();
return result;
}
// 创建代理对象
public <T> T getProxy(){
return (T) Proxy.newProxyInstance(target.getClass().getClassLoader(), target.getClass().getInterfaces(), this);
}
// 调用target实际方法之前执行
private void doBefore(){
System.out.println("JDK动态代理：方法执行前");
}
// 调用target实际方法之后执行
private void doAfter(){
System.out.println("JDK动态代理：方法执行后");
}
}
4. 测试
package com.dotwait.proxy;
import com.dotwait.proxy.handler.ProxyHandler;
import com.dotwait.proxy.service.UserService;
import com.dotwait.proxy.service.UserServiceImpl;
public class JDKProxyApp {
public static void main(String[] args) {
// 保存生成的代理类的字节码文件
System.getProperties().put("sun.misc.ProxyGenerator.saveGeneratedFiles", "true");
// 创建被代理对象
UserServiceImpl userService = new UserServiceImpl();
// 创建代理对象
UserService proxy = new ProxyHandler(userService).getProxy();
// 执行代理方法
proxy.printUserInfo();
}
}
5. 执行结果
JDK动态代理：方法执行前
打印用户信息
JDK动态代理：方法执行后
三、 分析
（1）JDK动态代理的关键代码是Proxy.newProxyInstance(ClassLoader loader,Class<?>[] interfaces,InvocationHandler h)，它会创建代理对象。它的实现如下：
@CallerSensitive
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对象
Class<?> cl = getProxyClass0(loader, intfs);
try {
if (sm != null) {
checkNewProxyPermission(Reflection.getCallerClass(), cl);
}
// 获取代理类参数为InvocationHandler的构造器
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);
}
}
（2）newProxyInstance方法中最关键的是获取代理类的Class对象，拿到Class对象后获取构造器调用newInstance方法便能创建出代理对象，获取代理类的Class对象调用了getProxyClass0方法，实现如下
private static Class<?> getProxyClass0(ClassLoader loader,
Class<?>... interfaces) {
if (interfaces.length > 65535) {
throw new IllegalArgumentException("interface limit exceeded");
}
// JDK对代理进行了缓存，如果已经存在相应的代理类，则直接返回，否则才会通过ProxyClassFactory来创建代理
return proxyClassCache.get(loader, interfaces);
}
（3）proxyClassCache对象用于代理缓存，对象声明如下
// 代理缓存由WeakCache实现
private static final WeakCache<ClassLoader, Class<?>[], Class<?>>
proxyClassCache = new WeakCache<>(new KeyFactory(), new ProxyClassFactory());
（4）ProxyClassFactory是Proxy的一个静态内部类，定义了代理类的一些规范，包括代理类的包名和类名的生成规则，对接口进行了验证，最后生成代理类的字节码，并通过字节码获取代理类的Class对象，实现如下
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) {
// 验证指定的类加载器(loader)加载接口所得到的Class对象(interfaceClass)是否与intf对象相同
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");
}
// 验证该Class对象是不是接口
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; // package to define proxy class in
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) {
// 如果都是public接口，那么生成的代理类就在com.sun.proxy包下
proxyPkg = ReflectUtil.PROXY_PACKAGE + ".";
}
// nextUniqueNumber 是一个原子类，确保多线程安全，防止类名重复，类似于：$Proxy0，$Proxy1....
long num = nextUniqueNumber.getAndIncrement();
// 代理类的完全限定名，如com.sun.proxy.$Proxy0.calss
String proxyName = proxyPkg + proxyClassNamePrefix + num;
// 生成代理类的字节码
byte[] proxyClassFile = ProxyGenerator.generateProxyClass(
proxyName, interfaces, accessFlags);
try {
// 将byte字节数组转为java.lang.Class对象
return defineClass0(loader, proxyName,
proxyClassFile, 0, proxyClassFile.length);
} catch (ClassFormatError e) {
throw new IllegalArgumentException(e.toString());
}
}
}
（5）其中比较关键的是Generator.generateProxyClass方法生成了代理类的字节码，该方法实现如下
public static byte[] generateProxyClass(final String var0, Class<?>[] var1, int var2) {
ProxyGenerator var3 = new ProxyGenerator(var0, var1, var2);
// 真正生成代理类字节码的方法
final byte[] var4 = var3.generateClassFile();
// saveGeneratedFiles为true则生成字节码文件，上面测试时设置为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;
}
（6）调用了ProxyGenerator.generateClassFile方法生成代理类字节码，generateClassFile方法是最终代理类字节码生成的核心，根据class文件的规范生成，具体实现如下
private byte[] generateClassFile() {
// 添加hashCode、equals、toString方法
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 {
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);
}
}
}
四、代理类反编译
生成的代理对象com.sun.proxy.$Proxy0.class字节码反编译
package com.sun.proxy;
import com.dotwait.proxy.service.UserService;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
import java.lang.reflect.UndeclaredThrowableException;
public final class $Proxy0 extends Proxy implements UserService {
private static Method m1;
private static Method m3;
private static Method m2;
private static Method m0;
// 代理类的构造函数，其参数正是是InvocationHandler实例，Proxy.newInstance方法就是通过通过这个构造函数来创建代理实例的
public $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 void printUserInfo() throws {
try {
/**
* 父类Proxy中定义了：protected InvocationHandler h;
* 此处调用的InvocationHandler的invoke方法，就是自己定义的ProxyHandler的invoke方法
* h指Proxy.newProxyInstance方法传入的自定义ProxyHandler对象
* this指$Proxy0对象
* m3指m3 = Class.forName("com.dotwait.proxy.service.UserService").getMethod("printUserInfo");根据全路径名获取真实方法
* null指printUserInfo无参数
*/
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);
}
}
// 静态代码块对变量进行一些初始化工作，每个方法对象绑定类的实际方法
static {
try {
m1 = Class.forName("java.lang.Object").getMethod("equals", Class.forName("java.lang.Object"));
m3 = Class.forName("com.dotwait.proxy.service.UserService").getMethod("printUserInfo");
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());
}
}
}
五、流程
- Proxy.newProxyInstance，传入被代理对象的类加载器、接口以及自定义的InvocationHandler实现类
- Class<?> cl = getProxyClass0(loader, intfs);获取代理类的Class对象
- proxyClassCache.get(loader, interfaces);从WeakCache的缓存中获取代理类的Class对象，没有则由ProxyClassFactory创建
- ProxyGenerator.generateProxyClass(proxyName, interfaces, accessFlags);此方法中调用ProxyGenerator.generateClassFile生成代理类的字节码，并调用defineClass0方法生成代理类的Class对象
- final Constructor<?> cons = cl.getConstructor(constructorParams);根据代理类的Class对象，获取参数为InvocationHandler的构造器
- cons.newInstance(new Object[]{h});使用构造器创建代理类实例
六、总结
- JDK动态代理生成的代理类继承了Proxy类并实现了被代理的接口，Java只支持单继承，代理类已经继承了Proxy类，无法通过继承被代理类的方式去实现代理，因此选择了实现接口的方式
- 使用JDK动态代理的关键是实现InvocationHandler接口，重写invoke方法，代理类通过调用自定义的InvocationHandler实现类的invoke方法完成代理
255
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
