Java注解的Retention和RetentionPolicy

最新推荐文章于 2026-05-01 01:12:27 发布

原创最新推荐文章于 2026-05-01 01:12:27 发布 · 9.2k 阅读

7 ·

本内容遵循CC 4.0 BY-SA版权协议

标签

#Java

java 专栏收录该内容

779 篇文章

订阅专栏

本文详细解析了Java注解的不同保留策略，包括SOURCE、CLASS和RUNTIME，并通过具体实例展示了不同保留策略的应用场景。文章还介绍了如何使用@Retention和@Documented等元注解来自定义注解，并探讨了其在源代码、编译后的类文件及运行时环境中的表现。

一源码赏析

1 源码

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Retention {
    RetentionPolicy value();
}

public enum RetentionPolicy {
    //此注解类型的信息只会记录在源文件中，编译时将被编译器丢弃，也就是说
    //不会保存在编译好的类信息中
    SOURCE,

    //编译器将注解记录在类文件中，但不会加载到JVM中。如果一个注解声明没指定范围，则系统
    //默认值就是Class
    CLASS,

    //注解信息会保留在源文件、类文件中，在执行的时也加载到Java的JVM中，因此可以反射性的读取。
    RUNTIME
}

2 说明

Retention：（中文含义为“保留”）来定义一个注解的保存范围。

@Documented：将自定义注解设置为文档说明信息。

3 赏析内置注解的 Retention

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)  //注解信息只能在源文件中出现
public @interface Override {
}

@Documented
@Retention(RetentionPolicy.RUNTIME)    //注解信息在执行时出现
@Target(value={CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE, PARAMETER, TYPE})
public @interface Deprecated {
}

@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
@Retention(RetentionPolicy.SOURCE)    //注解信息在源文件中出现
public @interface SuppressWarnings {
    String[] value();
}

二自定义注解的保存范围

1 代码

//定义该自定义注解的保存范围是RUNTIME
@Retention(value = RetentionPolicy.RUNTIME)
@interface AnnoationRetention
{
    public String value();
}

2 说明

AnnoationRetention的注解信息会保留在源文件、类文件以及Java虚拟机中。