Java 中冷门的 synthetic 关键字原理解读

Java 中冷门的 synthetic 关键字原理解读

看JAVA的反射时，看到有个synthetic ，还有一个方法isSynthetic() 很好奇，就了解了一下：

1.定义

Any constructs introduced by a Java compiler that do not have a corresponding construct in the source code must be marked as synthetic, except for default constructors, the class initialization method, and the values and valueOf methods of the Enum class.

大意为：由java编译器生成的（除了像默认构造函数这一类的）方法，或者类

2.实例

既然知道synthetic方法和synthetic类是由编译器生成的，那到底编译器会怎么生成这些东西，又在什么情况下会生成这些东西呢？

先看一段代码：

import static java.lang.System.out;

public final class DemonstrateSyntheticMethods

{

   public static void main(final String[] arguments)

   {

      DemonstrateSyntheticMethods.NestedClass nested =

         new DemonstrateSyntheticMethods.NestedClass();

      out.println("String: " + nested.highlyConfidential);

   }

   private static final class NestedClass

   {

      private String highlyConfidential = "Don't tell anyone about me";

      private int highlyConfidentialInt = 42;

      private Calendar highlyConfidentialCalendar = Calendar.getInstance();

      private boolean highlyConfidentialBoolean = true;

   }

}

编译之后，可以看到三个文件：

其中，最下面的这个类文件很好解释，就是我们的主class，中间的文件，是我们的内部类，上面的文件，后面再讲，我们先看一下中间这个内部类

2.1 内部类的反编译结果

用javap 反编译DemonstrateSyntheticMethods$NestedClass.class，得到如下结果：

javap DemonstrateSyntheticMethods\$NestedClass.class

Compiled from "DemonstrateSyntheticMethods.java"

final class DemonstrateSyntheticMethods$NestedClass {

  DemonstrateSyntheticMethods$NestedClass(DemonstrateSyntheticMethods$1);

  static java.lang.String access0(DemonstrateSyntheticMethods$NestedClass);

}

先把构造函数放一边，我们来看这个标黑的方法access$100 这个是怎么回事呢？我们的源文件里找不到这个access方法啊？

2.2 synthetic方法

这个方法就是编译器生成的synthetic方法，读者不信的话，可以用method.isSynthetic() 去验证一下。

为何要生成这样一个方法呢？

可以看到，我们的NestedClass类中，highConfidential是一个私有属性，而我们在外部类DemonstrateSyntheticMethods中，直接引用了这个属性。

作为一个内部类，NestedClass的属性被外部类引用，在语义上毫无问题，但是这却苦了编译器。

为了能让一个private的变量被引用到，编译器生成了一个package scope的access方法，这个方法就是一个get方法，在外部类使用highConfidential这个属性时，实际是使用了这个access方法。

在javap中可以看到直接的证据：

图中红框的位置，可以很清楚的看到main方法实际上调用了access$100这个方法。

所以，结论很清楚了，编译器为了方便内部类的私有成员被外部类引用，生成了一个get方法，这可以被理解为一个trick，绕开了private成员变量的限制。

2.3 synthetic类

定义已经提到，编译器不仅仅会生成方法，也会生成synthetic类。

我们回过头来看2.1提到的最后一个类DemonstrateSyntheticMethods$1.class

这个类是一个完全的空类，反编译后是这个样子：

// $FF: synthetic class

class DemonstrateSyntheticMethods$1 {

}

这个类只出场了一次，作为内部类NestedClass的package scope的构造函数，如图所示：

那么，这个类的作用呢？笔者查了很多资料，都没有明确的说明这个类的用途，只能根据代码做推测如下：

NestedClass作为一个private类，其默认构造函数也是private的。

那么，事实上，作为外部类的DemonstrateSyntheticMethods类，没有办法new这个内部类的对象，而这和我们需要的语义相违背。

那么，为了实现语义，编译器又用了一个trick，悄悄的生成了一个构造函数NestedClass(DemonstrateSyntheticMethods$1 obj), 这个构造函数是包可见的。

那么，外部类则可以通过new NestedClass(null)的方式，得到内部类的对象。

如果读者检查一下main方法的话，可以看到这个方法的调用如下图所示。

这就是这个synthetic类的作用。

如果我们给我们的NestedClass 增加一个public级别的默认构造函数的话，则可以看到编译器不会再生成这个synthetic类。

3.结论

编译器通过生成一些在源代码中不存在的synthetic方法和类的方式，实现了对private级别的字段和类的访问，从而绕开了语言限制，这可以算是一种trick。

在实际生产和应用中，基本不存在程序员需要考虑synthetic的地方。

PS: 在此提一个的常见的存在synthetic的案例。

如果同时用到了Enum和switch，如先定义一个enum枚举，然后用switch遍历这个枚举，java编译器会偷偷生成一个synthetic的数组，数组内容是enum的实例。

对于这种情况，笔者找到了一个资料，可供参考：

Java动态修改Enum实例

---

完。