闲话元注解@Retention

2020-01-15 15:48:54 浏览数 (1)

元注解@Retention

元注解是用来描述注解的。@Retention用来描述注解将会在哪个层次存在,有三个值:

  1. RetentionPolicy.SOURCE:只会在java文件中存在,class文件中就不可见了。可以被编译器使用
  2. RetentionPolicy.CLASS:会在class中可见,不需要被虚拟机加载。编译时可见
  3. RetentionPolicy.RUNTIME:在class中可见,会被虚拟机加载。编译时可见,运行时可见

下面以一个例子来区分三个值。

Demo

定义一个注解:

代码语言:javascript复制
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.XXX)
public @interface MyTest {
}

一个类使用了这个注解:

代码语言:javascript复制
public class MyClass {

    @MyTest
    int val;

}

一个类来获取Field然后获取注解,输出,

代码语言:javascript复制
try {
            Field field = MyClass.class.getDeclaredField("val");
            Annotation[] annos = field.getAnnotations();
            for (int i = 0; i < annos.length; i  ) {
                System.out.println(annos[i].toString());
            }
        } catch (NoSuchFieldException e) {
            e.printStackTrace();
        }

RetentionPolicy.SOURCE

当@Retention注解的值是这个时,编译MyClass得到的class文件如下:

代码语言:javascript复制
public class MyClass {
    int val;

    public MyClass() {
    }
}

可以看到class文件中没有注解的信息。那这种有什么应用场景呢?

答案是APT(Annotation Process Tool),这个工具的输入是java源文件,因此对于APT而言,是可以看到注解的。 这种情况下,执行程序,输出为空,因为class文件中连注解都没有,肯定是拿不到的。

RetentionPolicy.CLASS

修改为这个后,编译后的class如下:

代码语言:javascript复制
public class MyClass {
    @MyTest
    int val;

    public MyClass() {
    }
}

可以看到,这个时候,出现了@MyTest注解。但是执行程序,依然输出为空,这是因为java虚拟机加载该类时,没把注解加载进去。

此种的场景使用参考自:

这里很重要的一点是编译多个Java文件时的情况:假如要编译A.java源码文件和B.class文件,其中A类依赖B类,并且B类上有些注解希望让A.java编译时能看到,那么B.class里就必须要持有这些注解信息才行。同时我们可能不需要让它在运行时对反射可见(例如说为了减少运行时元数据的大小之类),所以会选择CLASS而不是RUNTIME。–知乎:RednaxelaFX

RetentionPolicy.RUNTIME

修改为这个后,编译后的class和RetentionPolicy.CLASS一样,执行程序,输出为:

代码语言:javascript复制
@MyTest()

可以看到,RetentionPolicy.RUNTIME这种情况下是可以通过反射拿到注解的。

参考

  • Java注解理解
  • Java注解处理器

0 人点赞