Java那些不为人知的特殊方法

原文链接，译文链接，原文作者： peter verhas，译者：有孚，本文最早发表于deepinmind

如果你用过反射并且执行过getdeclaredmethods方法的话，你可能会感到很吃惊。你会发现出现了很多源代码里没有的方法。如果你看一下这些方法的修饰符的话，可能会发现里面有些方法是volatile的。顺便说一句，如果在java面试里问到“什么是volatile方法？”，你可能会吓出一身冷汗。正确的答案是没有volatile方法。但同时，getdeclaredmethods()或者getmethods()返回的这些方法，modifier.isvolatile(method.getmodifiers())的结果却是true。

immutator的一些用户遇到过这样的问题。他们发现，使用immutator（这个项目探索了java的一些不为人知的细节）生成的java代码使用volatile了作为方法的关键字，而这样的代码没法通过编译。结果就是这根本没法用。

这是怎么回事？syntethic和bridge方法又是什么？

当你创建一个嵌套类的时候，它的私有变量和方法对上层的类是可见的。这个在不可变嵌套式builder模式中用到了。这是java语言规范里已经定义好的一个行为。

<code>package</code> <code>synthetic;</code>

<code>public</code> <code>class</code> <code>syntheticmethodtest1 {</code>

<code> </code><code>private</code> <code>a aobj =</code><code>new</code> <code>a();</code>

<code> </code><code>public</code> <code>class</code> <code>a {</code>

<code> </code><code>private</code> <code>int</code> <code>i;</code>

<code> </code><code>private</code> <code>class</code> <code>b {</code>

<code> </code><code>private</code> <code>int</code> <code>i = aobj.i;</code>

<code> </code><code>public</code> <code>static</code> <code>void</code> <code>main(string[] args) {</code>

<code> </code><code>syntheticmethodtest1 me =</code><code>new</code> <code>syntheticmethodtest1();</code>

<code> </code><code>system.out.println(bobj.i);</code>

jvm是如何处理这个的？它可不知道什么是内部类或者嵌套类的。jvm对所有的类都一视同仁，它都认为是顶级类。所有类都会被编译成顶级类，而那些内部类编译完后会生成…$… class的类文件。

<code>../ syntheticmethodtest2$a.</code><code>class</code> <code>myclass.java syntheticmethodtest4.java syntheticmethodtest2.java</code>

<code>syntheticmethodtest2.</code><code>class</code> <code>syntheticmethodtest3.java ./ myclassson.java syntheticmethodtest1.java</code>

如果你创建一个内部类的话，它会被彻底编译成一个顶级类。

那这些私有变量又是如何被外部类访问的呢？如果它们是个顶级类的私有变量（它们的确也是），那为什么别的类还能直接访问这些变量？

javac是这样解决这个问题的，对于任何private的字段，方法或者构造函数，如果它们也被其它顶层类所使用，就会生成一个synthetic方法。这些synthetic方法是用来访问最初的私有变量/方法/构造函数的。这些方法的生成也很智能：只有确实被外部类用到了，才会生成这样的方法。

<code>import</code> <code>java.lang.reflect.constructor;</code>

<code>import</code> <code>java.lang.reflect.method;</code>

<code>public</code> <code>class</code> <code>syntheticmethodtest2 {</code>

<code> </code><code>public</code> <code>static</code> <code>class</code> <code>a {</code>

<code> </code><code>private</code> <code>a(){}</code>

<code> </code><code>private</code> <code>int</code> <code>x;</code>

<code> </code><code>private</code> <code>void</code> <code>x(){};</code>

<code> </code><code>system.out.println(a.x);</code>

<code> </code><code>for</code> <code>(method m : a.</code><code>class</code><code>.getdeclaredmethods()) {</code>

<code> </code><code>system.out.println(string.format(</code><code>"%08x"</code><code>, m.getmodifiers()) +</code><code>" "</code> <code>+ m.getname());</code>

<code> </code><code>system.out.println(</code><code>"--------------------------"</code><code>);</code>

<code> </code><code>for</code> <code>(method m : a.</code><code>class</code><code>.getmethods()) {</code>

<code> </code><code>system.out.println(string.format(</code><code>"%08x"</code><code>, m.getmodifiers()) +</code><code>" "</code> <code>+ m.getreturntype().getsimplename() +</code><code>" "</code> <code>+ m.getname());</code>

<code> </code><code>for</code><code>( constructor<?> c : a.</code><code>class</code><code>.getdeclaredconstructors() ){</code>

<code> </code><code>system.out.println(string.format(</code><code>"%08x"</code><code>, c.getmodifiers()) +</code><code>" "</code> <code>+ c.getname());</code>

这些生成的方法的名字取决于具体的实现，最后叫什么也不好说。我只能说在我运行的这个平台上，上述程序的输出是这样的：

<code>00001008</code> <code>access$</code><code>1</code>

<code>00001008</code> <code>access$</code><code>2</code>

<code>00001008</code> <code>access$</code><code>3</code>

<code>00000001</code> <code>boolean</code> <code>equals</code>

<code>00000001</code> <code>string tostring</code>

<code>00000101</code> <code>int</code> <code>hashcode</code>

<code>00000111</code> <code>class getclass</code>

<code>00000111</code> <code>void</code> <code>notify</code>

<code>00000111</code> <code>void</code> <code>notifyall</code>

<code>00000002</code> <code>synthetic.syntheticmethodtest2$a</code>

<code>00001000</code> <code>synthetic.syntheticmethodtest2$a</code>

在上面这个程序中，我们给变量x赋值，然后又调用了一个同名的方法。这会触发编译器生成对应的synthetic方法。你会看到它生成了三个方法，应该是x变量的setter和getter方法，以及x()方法对应的一个synthetic方法。这些方法并不存在于getmethods方法里返回的列表中，因为它们是synthetic方法，是不能直接被调用的。从这点来看，它们和私有方法差不多。

看一下java.lang.reflect.modifier里面定义的常量，可以明白这些十六进制的数字代表的是什么：

<code>00001008</code> <code>synthetic|static</code>

<code>00000002</code> <code>private</code>

<code>00000111</code> <code>native|final|public</code>

<code>00000011</code> <code>final|public</code>

<code>00000001</code> <code>public</code>

<code>00001000</code> <code>synthetic</code>

列表中有两个是构造方法。还有一个私有方法以及一个synthetic方法。存在这个私有方法是因为我们确实定义了它。而synthetic方法的出现是因为我们从外部类调用了它内部的私有成员。到目前为止，还没有出现过bridge方法。

到目前为止，看起来还不错。不过我们还没有看到”volatile”方法。

看一下java.lang.reflect.modifier的源码你会发现0x00000040这个常量被定义了两次。一次是定义成volatile，还有一次是bridge（后者是包内部私有的，并不对外开放）。

想出现volatile方法的话，写个简单的程序就行了：

<code>import</code> <code>java.util.linkedlist;</code>

<code>public</code> <code>class</code> <code>syntheticmethodtest3 {</code>

<code> </code><code>public</code> <code>static</code> <code>class</code> <code>mylink</code><code>extends</code> <code>linkedlist {</code>

<code> </code><code>@override</code>

<code> </code><code>public</code> <code>string get(</code><code>int</code> <code>i) {</code>

<code> </code><code>return</code> <code>""</code><code>;</code>

<code> </code><code>for</code> <code>(method m : mylink.</code><code>class</code><code>.getdeclaredmethods()) {</code>

这个链表有一个返回string的get(int)方法。先别讨论代码整不整洁的问题了。这只是段示例代码而已。整洁的代码当然也会出现同样的问题，不过越复杂的代码越难定位问题罢了。

输出的结果是这样的：

<code>00000001</code> <code>string get</code>

<code>00001041</code> <code>object get</code>

这里有两个get方法。一个是代码里的那个，另外一个是synthetic和bridge方法。用javap反编译后会是这样的：

<code>public</code> <code>java.lang.string get(</code><code>int</code><code>);</code>

<code> </code><code>stack=</code><code>1</code><code>, locals=</code><code>2</code><code>, args_size=</code><code>2</code>

<code> </code><code>0</code><code>: ldc #</code><code>2</code><code>;</code><code>//string</code>

<code> </code><code>2</code><code>: areturn</code>

<code> </code><code>linenumbertable:</code>

<code>public</code> <code>java.lang.object get(</code><code>int</code><code>);</code>

<code> </code><code>stack=</code><code>2</code><code>, locals=</code><code>2</code><code>, args_size=</code><code>2</code>

<code> </code><code>0</code><code>: aload_0</code>

<code> </code><code>1</code><code>: iload_1</code>

<code> </code><code>2</code><code>: invokevirtual #</code><code>3</code><code>;</code><code>//method get:(i)ljava/lang/string;</code>

<code> </code><code>5</code><code>: areturn</code>

有趣的是，两个方法的签名是一模一样的，只有返回类型不同。这个在jvm里面是合法的，不过在java语言里可不允许。bridge的这个方法不干别的，就只是去调用了下原始的那个方法。

为什么我们需要这个synthetic方法呢，谁会调用它？比如现在有段代码想要调用一个非mylink类型变量的get(int)方法：

<code>list<?> a =</code><code>new</code> <code>mylink();</code>

<code> </code><code>object z = a.get(</code><code>0</code><code>);</code>

它不能调用返回string的方法，因为list里没这样的方法。为了解释的更清楚一点，我们重写下add方法而不是get方法：

<code>import</code> <code>java.util.list;</code>

<code>public</code> <code>class</code> <code>syntheticmethodtest4 {</code>

<code> </code><code>public</code> <code>boolean</code> <code>add(string s) {</code>

<code> </code><code>return</code> <code>true</code><code>;</code>

<code> </code><code>list a =</code><code>new</code> <code>mylink();</code>

我们会发现这个bridge方法

<code>public</code> <code>boolean</code> <code>add(java.lang.object);</code>

<code> </code><code>1</code><code>: aload_1</code>

<code> </code><code>2</code><code>: checkcast #</code><code>2</code><code>;</code><code>//class java/lang/string</code>

<code> </code><code>5</code><code>: invokevirtual #</code><code>3</code><code>;</code><code>//method add:(ljava/lang/string;)z</code>

<code> </code><code>8</code><code>: ireturn</code>

它不仅调用了原始的方法，它还进行了类型检查。这个检查是在运行时进行的，并不是由jvm自己来完成。正如你所想，在18行的地方会抛出一个异常：

<code>exception in thread</code><code>"main"</code> <code>java.lang.classcastexception: java.lang.integer cannot be cast to java.lang.string</code>

<code> </code><code>at synthetic.syntheticmethodtest4$mylink.add(syntheticmethodtest4.java:</code><code>1</code><code>)</code>

<code> </code><code>at synthetic.syntheticmethodtest4.main(syntheticmethodtest4.java:</code><code>18</code><code>)</code>

下次如果你在面试中被问到volatile方法的话，说不定面试官知道的还没你多:-)

译者注：其实作者说到最后也没讲完到底什么是volatile方法，其实volatile方法如篇首所说，是不存在的，所谓的volatile方法就是指bridge方法。由于在修饰符中volatile和bridge是同一个值，在之前版本的javap中存在一个bug，一个bridge方法在反编译后会显示成volatile，所以存在”volatile方法”的说法。

Java那些不为人知的特殊方法

继续阅读

关于Gradle配置的小结

Java小案例——随机数猜测随机数猜测

nginx location中斜线的位置的重要性

27 Best Free Eclipse Plug-ins for Java Developer to be ProductiveCode Quality PluginsText Editor PluginsDependency ManagementVersion Control Integration PluginsFramework Development Continuous Integration Related PluginsOther Utility Plugins

Java String.format方法的简单使用

neo4j之cypher使用文档

GitHub连夜封杀！这份阿里 10W 字内部 Java 字面试手册到底有多强？

spark/scala关于【资源文件】加载方法概述外部文件加载方案测试资源文件打包入jar包中小结

mybatis_入门程序Mybatis入门

AOP编程_Android优雅权限框架(1)概念基础，2021金三银四前言正文大纲正文

Effective Java 8:通用程序设计

OOM三种类型

工厂模式-三种类型

【递归】高效率求2的n次幂

win10本地scala和spark安装安装scala安装spark

scala (3) Function 和 Method