检索和解析字段修饰符

原文： https://docs.oracle.com/javase/tutorial/reflect/member/fieldModifiers.html

有几个修饰符可能是字段声明的一部分：

  • 访问修饰符：public，protected和private
  • 控制运行时行为的字段特定修饰符：transient和volatile
  • 修饰符限制为一个实例：static
  • 修饰符禁止修改值：final
  • 注释

方法 Field.getModifiers() 可用于返回表示该字段的声明修饰符集的整数。表示该整数中的修饰符的位在 java.lang.reflect.Modifier 中定义。

FieldModifierSpy 示例说明了如何搜索具有给定修饰符的字段。它还通过分别调用 Field.isSynthetic() 和 Field.isEnumCostant() 来确定所定位的字段是合成的（编译器生成的）还是枚举常量。

  1. import java.lang.reflect.Field;
  2. import java.lang.reflect.Modifier;
  3. import static java.lang.System.out;
  5. enum Spy { BLACK , WHITE }
  7. public class FieldModifierSpy {
  8.     volatile int share;
  9.     int instance;
  10.     class Inner {}
  12.     public static void main(String... args) {
  13.     try {
  14.         Class<?> c = Class.forName(args[0]);
  15.         int searchMods = 0x0;
  16.         for (int i = 1; i < args.length; i++) {
  17.         searchMods |= modifierFromString(args[i]);
  18.         }
  20.         Field[] flds = c.getDeclaredFields();
  21.         out.format("Fields in Class '%s' containing modifiers:  %s%n",
  22.                c.getName(),
  23.                Modifier.toString(searchMods));
  24.         boolean found = false;
  25.         for (Field f : flds) {
  26.         int foundMods = f.getModifiers();
  27.         // Require all of the requested modifiers to be present
  28.         if ((foundMods & searchMods) == searchMods) {
  29.             out.format("%-8s [ synthetic=%-5b enum_constant=%-5b ]%n",
  30.                    f.getName(), f.isSynthetic(),
  31.                    f.isEnumConstant());
  32.             found = true;
  33.         }
  34.         }
  36.         if (!found) {
  37.         out.format("No matching fields%n");
  38.         }
  40.         // production code should handle this exception more gracefully
  41.     } catch (ClassNotFoundException x) {
  42.         x.printStackTrace();
  43.     }
  44.     }
  46.     private static int modifierFromString(String s) {
  47.     int m = 0x0;
  48.     if ("public".equals(s))           m |= Modifier.PUBLIC;
  49.     else if ("protected".equals(s))   m |= Modifier.PROTECTED;
  50.     else if ("private".equals(s))     m |= Modifier.PRIVATE;
  51.     else if ("static".equals(s))      m |= Modifier.STATIC;
  52.     else if ("final".equals(s))       m |= Modifier.FINAL;
  53.     else if ("transient".equals(s))   m |= Modifier.TRANSIENT;
  54.     else if ("volatile".equals(s))    m |= Modifier.VOLATILE;
  55.     return m;
  56.     }
  57. }

示例输出如下：

  1. $ java FieldModifierSpy FieldModifierSpy volatile
  2. Fields in Class 'FieldModifierSpy' containing modifiers:  volatile
  3. share    [ synthetic=false enum_constant=false ]
  5. $ java FieldModifierSpy Spy public
  6. Fields in Class 'Spy' containing modifiers:  public
  7. BLACK    [ synthetic=false enum_constant=true  ]
  8. WHITE    [ synthetic=false enum_constant=true  ]
  10. $ java FieldModifierSpy FieldModifierSpy\$Inner final
  11. Fields in Class 'FieldModifierSpy$Inner' containing modifiers:  final
  12. this$0   [ synthetic=true  enum_constant=false ]
  14. $ java FieldModifierSpy Spy private static final
  15. Fields in Class 'Spy' containing modifiers:  private static final
  16. $VALUES  [ synthetic=true  enum_constant=false ]

请注意，即使它们未在原始代码中声明，也会报告某些字段。这是因为编译器将生成运行时所需的一些合成字段。为了测试字段是否是合成的，该示例调用 Field.isSynthetic() 。合成字段集依赖于编译器;但是常用的字段包括this$0用于内部类（即非静态成员类的嵌套类）以引用最外层的封闭类和枚举用于实现隐式定义的静态方法values()的$VALUES。未指定合成类成员的名称，并且在所有编译器实现或发行版中可能不相同。这些和其他合成字段将包括在 Class.getDeclaredFields() 返回的阵列中，但未被 Class.getField() 鉴定，因为合成成员通常不是public。

因为 Field 实现了接口 java.lang.reflect.AnnotatedElement ，所以可以使用 java.lang.annotation.RetentionPolicy.RUNTIME 检索任何运行时注释。有关获取注释的示例，请参见检查类修饰符和类型部分。