@Deprecated 注解（@Documented 、@Retention、@Target）

本是古典何须时尚 2023-07-15 03:57 118阅读 0赞

[前些天发现了一个巨牛的人工智能学习网站，通俗易懂，风趣幽默，忍不住分享一下给大家。点击跳转到教程。][Link 1]

// 在看 Unsafe 类源码时看到一个注解：@Deprecated，似曾相识...

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70][]

# @Deprecated  #

用在类或者方法上，表示对应代码不推荐使用、已经过时。

通常是因为它是危险的，或者是因为存在更好的替代方案。编译器在非弃用代码中使用或重写弃用的程序元素时发出警告。

**调用时可能会出现删除线。**

补充：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 1][]

### **@Documented ** ###

有此注解的内容将由javadoc和类似工具记录。如果用文档对类型声明进行了注释，则其注释将成为注释元素的公共API的一部分。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 2][]

### **@Retention** ###

**@Retention 是一个**元注解，即注解上的注解。  
它只有一个 RetentionPolicy 类型的属性，RetentionPolicy是一个枚举，共有3个值：SOURCE、CLASS、RUNTIME。

这 3 个值决定了被**@Retention**所注解的注解（即@Deprecated ）被保留的方式。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 3][]

1、RetentionPolicy.SOURCE：注解只保留在源文件，当Java文件编译成class文件的时候，注解被遗弃；  
2、RetentionPolicy.CLASS：注解被保留到class文件，但jvm加载class文件时候被遗弃，这是默认的生命周期；  
3、RetentionPolicy.RUNTIME：注解不仅被保存到class文件中，jvm加载class文件之后，仍然存在；  
这3个生命周期分别对应于：Java源文件(.java文件) ---> .class文件 ---> 内存中的字节码。  
那怎么来选择合适的注解生命周期呢？  
首先要明确生命周期长度 SOURCE < CLASS < RUNTIME ，所以前者能作用的地方后者一定也能作用。  
一般如果需要在运行时去动态获取注解信息，那只能用 RUNTIME 注解，比如@Deprecated使用RUNTIME注解  
如果要在编译时进行一些预处理操作，比如生成一些辅助代码（如 ButterKnife），就用 CLASS注解；  
如果只是做一些检查性的操作，比如 @Override 和 @SuppressWarnings，使用SOURCE 注解。

以上 9 行出自：[https://www.cnblogs.com/liufei1983/p/9987084.html][https_www.cnblogs.com_liufei1983_p_9987084.html]

## ##

### **@Target** ###

限制注解可以应用于哪种Java元素类型。只有一个枚举数组类型的属性：value。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 4][]

用法如：

@Target(value={CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE, PARAMETER, TYPE})

数组中的值为注解的作用目标。在此，即：CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE, PARAMETER, TYPE。
    目标范围枚举值有：接口、类、枚举、注解、字段、枚举的常量、方法、方法参数、构造函数、局部变量、包等。

public enum ElementType {
        /** Class, interface (including annotation type), or enum declaration */
        TYPE,
    
        /** Field declaration (includes enum constants) */
        FIELD,
    
        /** Method declaration */
        METHOD,
    
        /** Formal parameter declaration */
        PARAMETER,
    
        /** Constructor declaration */
        CONSTRUCTOR,
    
        /** Local variable declaration */
        LOCAL_VARIABLE,
    
        /** Annotation type declaration */
        ANNOTATION_TYPE,
    
        /** Package declaration */
        PACKAGE,
    
        /**
         * Type parameter declaration
         *
         * @since 1.8
         */
        TYPE_PARAMETER,
    
        /**
         * Use of a type
         *
         * @since 1.8
         */
        TYPE_USE
    }

参考：

[https://blog.csdn.net/fengcai0123/article/details/90544338][https_blog.csdn.net_fengcai0123_article_details_90544338]

[https://www.cnblogs.com/liufei1983/p/9987084.html][https_www.cnblogs.com_liufei1983_p_9987084.html]

[Link 1]: https://www.captainai.net/jiangyu1013/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70]: /images/20230529/be77ba8c56ce4af79b945621b2277a4e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 1]: /images/20230529/46c6f735b7c74355b7f0080682de978e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 2]: /images/20230529/3aed171937814b439899358f49f3eeff.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 3]: /images/20230529/e519813eb1e14e2f89abaea3aae6a48c.png
[https_www.cnblogs.com_liufei1983_p_9987084.html]: https://www.cnblogs.com/liufei1983/p/9987084.html
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 4]: /images/20230529/0e68c2be0db142cf986e9801e1adbfa0.png
[https_blog.csdn.net_fengcai0123_article_details_90544338]: https://blog.csdn.net/fengcai0123/article/details/90544338