Java那些事： @Retention 的含义

「爱情、让人受尽委屈。」 2022-11-09 11:29 168阅读 0赞

下面是一个java 注解的例子

@Documented
    @Target(ElementType.METHOD)
    @Inherited
    @Retention(RetentionPolicy.RUNTIME)
    public @interface MethodInfo{
        String author() default "Pankaj";
        String date();
        int revision() default 1;
        String comments();
    }

其中注解@Retention值得研究一下它的取值含义。

它可以用来修饰注解，是注解的注解，称为元注解。  
Retention注解有一个属性value，是RetentionPolicy类型的，Enum RetentionPolicy是一个枚举类型，  
这个枚举决定了Retention注解应该如何去保持，也可理解为Rentention 搭配 RententionPolicy使用。  
RetentionPolicy有3个值：

1.  CLASS 
2.  RUNTIME 
3.  SOURCE

按生命周期来划分可分为3类：  
1、SOURCE：注解只保留在源文件，当Java文件编译成class文件的时候，注解被遗弃；  
2、CLASS：注解被保留到class文件，但jvm加载class文件时候被遗弃，这是默认的生命周期；  
3、RUNTIME：注解不仅被保存到class文件中，jvm加载class文件之后，仍然存在；  
这3个生命周期分别对应于：Java源文件(.java文件) —> .class文件 —> 内存中的字节码。

那怎么来选择合适的注解生命周期呢？  
首先要明确生命周期长度 SOURCE < CLASS < RUNTIME ，所以前者能作用的地方后者一定也能作用。  
一般如果需要在运行时去动态获取注解信息，那只能用 RUNTIME 注解，比如@Deprecated使用RUNTIME注解  
如果要在编译时进行一些预处理操作，比如生成一些辅助代码（如 ButterKnife），就用 CLASS注解；  
如果只是做一些检查性的操作，比如 @Override 和 @SuppressWarnings，使用SOURCE 注解。

注解@Override用在方法上，当我们想重写一个方法时，在方法上加@Override，当我们方法的名字出错时，编译器就会报错  
注解@Deprecated，用来表示某个类或属性或方法已经过时，不想别人再用时，在属性和方法上用@Deprecated修饰  
注解@SuppressWarnings用来压制程序中出来的警告，比如在没有用泛型或是方法已经过时的时候

参考文档

1. 关于如何用AOP去使用注解，见这里的[AOP+Annotation例子][AOP_Annotation]。

2. Spring boot里面继承 AOP ，见[例子1][1]和[例子2][2]

[AOP_Annotation]: https://blog.csdn.net/weixin_43972157/article/details/108087021
[1]: https://www.php.cn/java-article-372137.html
[2]: https://blog.csdn.net/LuQiaoYa/article/details/88233846