【Java】元注解
【摘要】 1. 元注解的基本介绍 2. 元注解的分类 2.1 @Retention 注解 2.2 @Target 注解 2.3 @Documented 注解 2.4 @Inherited 注解 1. 元注解的基本介绍JDK 的元 Annotation 用于修饰其他 Annotation元注解: 本身作用不大,看源码时,可以知道是干什么用的 2. 元注解的分类Retention 指定注解的作用范围,三...
1. 元注解的基本介绍
- JDK 的元 Annotation 用于修饰其他 Annotation
- 元注解: 本身作用不大,看源码时,可以知道是干什么用的
2. 元注解的分类
Retention指定注解的作用范围,三种SOURCE,CLASS,RUNTIMETarget指定注解可以在哪些地方使用Documented指定该注解是否会在javadoc体现Inherited子类会继承父类注解
2.1 @Retention 注解
- 只能用于修饰一个
Annotation定义, 用于指定该Annotation可以保留多长时间,@Rentention包含一个RetentionPolicy类型的成员变量,使用@Rentention时必须为该value成员变量指定值 @Retention的三种值
RetentionPolicy.SOURCE: 编译器使用后,直接丢弃这种策略的注释RetentionPolicy.CLASS: 编译器将把注解记录在 class 文件中. 当运行 Java 程序时, JVM 不会保留注解。 这也是默认值。RetentionPolicy.RUNTIME:编译器将把注解记录在 class 文件中. 当运行 Java 程序时, JVM 会保留注解,程序可以通过反射获取该注解
-
三种值注入的时间如下:

-
演示案例:
Override注解源码

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE) //这个就是 RetentionPolicy.SOURCE 的取值
public @interface Override {
}
-
说明:
Override的作用域在SOURCE,当编译器编译时生效,不会写入到.class文件,也不会再runtime(运行时)生效 -
Override 只在编译器层面生效,或在源码的时候生效,过了就不生效了

2.2 @Target 注解
- 用于修饰
Annotation定义,用于指定被修饰的Annotation能用于修饰哪些程序元素 @Target也包含一个名为value的成员变量。- @Target源码说明:
@Documented
@Retention(RetentionPolicy.RUNTIME) //它的作用是:RUNTIME
@Target(ElementType.ANNOTATION_TYPE) //这里的 ANNOTATION_TYPE 说明 @Target 只能修饰注解
public @interface Target { //说明它是注解
/**
* Returns an array of the kinds of elements an annotation type
* can be applied to.
* @return an array of the kinds of elements an annotation type
* can be applied to
*/
ElementType[] value(); // 可以简单看下 ElementType 的取值
}
- 演示案例:
@Deprecated源码

- 可以看到 @Deprecated 注解 Target 上的注解范围有:构造器、字段、局部变量、方法、包、参数、类型。

2.3 @Documented 注解
-
@Documented:用于指定被该元 Annotation修饰的Annotation类将被javadoc工具提取成文档,即在生成文档时,可以看到该注解。 -
说明:定义为
Documented的注解必须设置Retention值为RUNTIME。 -
案例演示:
@Deprecated注解源码如下

-
可以看到文档上的
@Deprecated注解被保留了,就是因为@Deprecated注解上有@Documented,在 javadoc 的时候就会保留@Deprecated这个注解


@Documented源码如下
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Documented {
}
2.4 @Inherited 注解
-
被它修饰的 Annotation 将具有继承性,如果某个类使用了被
@Inherited修饰的Annotation,则其子类将自动具有该注解 -
说明:实际应用中,使用较少,了解即可。
-
元注解:本身作用不大,看源码时,可以知道是干什么的就行了
【声明】本内容来自华为云开发者社区博主,不代表华为云及华为云开发者社区的观点和立场。转载时必须标注文章的来源(华为云社区)、文章链接、文章作者等基本信息,否则作者和本社区有权追究责任。如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱:
cloudbbs@huaweicloud.com
- 点赞
- 收藏
- 关注作者






评论(0)