【Java】元注解

举报
兮动人 发表于 2022/04/25 13:51:12 2022/04/25
【摘要】 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. 元注解的分类

  1. Retention 指定注解的作用范围,三种 SOURCE,CLASS,RUNTIME
  2. Target 指定注解可以在哪些地方使用
  3. Documented 指定该注解是否会在 javadoc 体现
  4. Inherited 子类会继承父类注解

2.1 @Retention 注解

  • 只能用于修饰一个 Annotation 定义, 用于指定该 Annotation 可以保留多长时间,@Rentention 包含一个 RetentionPolicy类型的成员变量,使用 @Rentention 时必须为该 value 成员变量指定值
  • @Retention 的三种值
  1. RetentionPolicy.SOURCE: 编译器使用后,直接丢弃这种策略的注释
  2. RetentionPolicy.CLASS: 编译器将把注解记录在 class 文件中. 当运行 Java 程序时, JVM 不会保留注解。 这也是默认值。
  3. 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

0/1000
抱歉,系统识别当前为高风险访问,暂不支持该操作

全部回复

上滑加载中

设置昵称

在此一键设置昵称,即可参与社区互动!

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。