今天在学习java的Proxy代理的过程中遇到一个诡异的问题,网上查找了很多资料,最终通过抽丝剥茧终于找出了问题所在,由于感觉比较坑,因此记录一下。
问题描述:
首先简单描述一下我遇到的问题,直接上代码
public class TestProxy {
public static void main(String[] args) {
HelloService helloService = new HelloServiceImp();
HelloService proxy = (HelloService) Proxy.newProxyInstance(helloService.getClass().getClassLoader(), helloService.getClass().getInterfaces(), new InvocationHandler() {
@Override
public Object invoke(Object o, Method method, Object[] objects) throws Throwable {
System.out.println("调用自定义invoke");
System.out.println(method.getName());
method.invoke(new HelloServiceImp(), objects);
return null;
}
});
proxy.sayHello("test");
}
}
代码本身并不复杂,就是Proxy代理的基本使用。首先实例化一个接口helloService,接口有方法sayHello,然后通过Proxy类下的newProxyInstance方法进行代理绑定,这里不详细说明这个方法的原理,我们看这个方法的最后一个参数,我使用了一个匿名类,在类中实现InvocationHandler接口的invoke方法。这样就可以使用代理的类动态调用接口的方法。按照预想,执行这个程序的结果应该是:
调用自定义invoke
sayHello
test
可是当我启用debug模式执行程序后,控制台打印的结果是:
调用自定义invoke
toString
调用自定义invoke
sayHello
test
调用自定义invoke
toString
为什么前后多打印了两句话?也就是说proxy中的invoke莫名多执行了两次,而且还是两次toString方法。
我在sayHello前添加了断点,执行后发现控制台打印了:
调用自定义invoke
toString
这让我更疑惑了,因为我在这里还没有执行sayHello方法,为什么代理已经执行了一次invoke方法,并且还调用了toString方法?
问题原因:
之后我通过查找相关资料加上自己的分析,终于找出了原因,这要从两个方面来解释:
第一个方面
Proxy代理动态生成的类有一些默认的方法,这里参考知乎大神的一个回答:
作者:木女孩
链接:https://www.zhihu.com/question/334461425/answer/745490744
来源:知乎
著作权归作者所有。商业转载请联系作者获得授权,非商业转载请注明出处。
import java.lang.reflect.*;
public final class $Proxy12 extends Proxy implements AInterface {
private static Method m1;
private static Method m2;
private static Method m3;
private static Method m0;
public $Proxy12(final InvocationHandler invocationHandler) {
// Proxy类的其中一个构造器
// protected Proxy(InvocationHandler h) {
// Objects.requireNonNull(h);
// this.h = h;
// }
super(invocationHandler);
}
public final boolean equals(final Object o) {
try {
// h就是传入的InvocationHandler对象
return (boolean) super.h.invoke(this, $Proxy12.m1, new Object[]{o});
} catch (Error | RuntimeException error) {
throw error;
} catch (Throwable t) {
throw new UndeclaredThrowableException(t);
}
}
//注意这个toString方法,调用了invoke方法
public final String toString() {
try {
return (String) super.h.invoke(this, $Proxy12.m2, null);
} catch (Error | RuntimeException error) {
throw error;
} catch (Throwable t) {
throw new UndeclaredThrowableException(t);
}
}
public final String func() {
try {
return (String) super.h.invoke(this, $Proxy12.m3, null);
} catch (Error | RuntimeException error) {
throw error;
} catch (Throwable t) {
throw new UndeclaredThrowableException(t);
}
}
public final int hashCode() {
try {
return (int) super.h.invoke(this, $Proxy12.m0, null);
} catch (Error | RuntimeException error) {
throw error;
} catch (Throwable t) {
throw new UndeclaredThrowableException(t);
}
}
static {
try {
$Proxy12.m1 = Class.forName("java.lang.Object").getMethod("equals", Class.forName("java.lang.Object"));
$Proxy12.m2 = Class.forName("java.lang.Object").getMethod("toString", (Class>[]) new Class[0]);
$Proxy12.m3 = Class.forName("cc.logirl.abc.AInterface").getMethod("func", (Class>[]) new Class[0]);
$Proxy12.m0 = Class.forName("java.lang.Object").getMethod("hashCode", (Class>[]) new Class[0]);
} catch (NoSuchMethodException ex) {
throw new NoSuchMethodError(ex.getMessage());
} catch (ClassNotFoundException ex2) {
throw new NoClassDefFoundError(ex2.getMessage());
}
}
}
上面的代码中最关键的地方在于他的toString方法
//注意这个toString方法,调用了invoke方法
public final String toString() {
try {
return (String) super.h.invoke(this, $Proxy12.m2, null);
} catch (Error | RuntimeException error) {
throw error;
} catch (Throwable t) {
throw new UndeclaredThrowableException(t);
}
}
我们可以注意到,toString方法首先调用了h的invoke方法,而这个h就是一开始通过newProxyInstance方法传入的第三个参数InvocationHandler的匿名类实例。这个invoke方法就是我们在匿名类中定义的invoke方法,因此,当调用的Proxy类的toString方法时,就会自动调用与他绑定的InvocationHandler实例的invoke方法。
到这里,我们知道invoke方法是通过什么方式调用的了。然而另一个问题又出现了,我们又是在哪里调用了Proxy的toString方法呢?
第二个方面
我通过断点调试发现我的程序中并没有调用Proxy的toString方法,这让我感到很奇怪。这时我突然想到,既然我自己没有调用,会不会是IDE做了什么?于是我朝着idea调用toString这个方向查找了相关信息,果然不出我所料。
在debug模式下,我们可以看到idea会在对象的后面用灰色的字体显示当前对象的一些基本信息,而默认情况下,这些信息实际上是通过调用对象的toString方法实现的!
知道了这点就,问题就迎刃而解了。通过设置(具体可以参考 IDEA debug模式下默认会调用变量的toString()方法),可以将这个选项关闭。
我首先用run模式运行了一下我的程序,发现结果是正确的,这坚定了我的想法。然后我将idea的自动toString功能关闭,运行debug模式,果然一切恢复了正常。
总结:
这次的问题一方面是在于java的Proxy类在实现的过程中隐藏了一些很细小的点,其实不单单是toString,包括eaqual,func,hascode这些方法都默认会调用InvocationHandler的invoke方法,在学习的过程中对这些问题也是需要总结的。另外就是idea的使用,IDE很多时候给我们的提供了方便,不过IDE的功能的一些实现原理,我们有时候也得有一些了解,这样遇到问题了可能更有效率的解决。