资讯教程
Java 元注解用来给其它的注解添加注解,就像C语言中的二级指针,用来指向其它指针的指针。如果现有的注解不够用,您也可以自定义注解,此时就可以使用元注解。
IT热点新闻
Java基础教程:元注解(1)
来源:易牛云朗沃
  |  
发布时间:2022-04-19 17:20
  |  
关键词:java基础知识入门
  |  
阅读量:

Java 元注解用来给其它的注解添加注解,就像C语言中的二级指针,用来指向其它指针的指针。如果现有的注解不够用,您也可以自定义注解,此时就可以使用元注解。

Java 5 定义了 4 个元注解,分别是 @Documented、@Target、@Retention 和 @Inherited,Java 8 又增加了 @Repeatable 和 @Native 两个元注解,它们都可以在 java.lang.annotation 包中找到。

@Documented

@Documented 是一个标记注解,没有成员变量。用 @Documented 注解修饰的注解类会被 JavaDoc 工具提取成文档。默认情况下,JavaDoc 是不包括注解的,但如果声明注解时指定了 @Documented,就会被 JavaDoc 之类的工具处理,所以注解类型信息就会被包括在生成的帮助文档中。

下面通过示例来了解它的用法,代码如下所示。

示例 1

java基础知识入门

测试类:

java基础知识入门

打开 Java 文件所在的目录,分别输入如下两条命令行:

java基础知识入门

运行成功后,打开生成的帮助文档,可以看到在类和方法上都保留了 MyDocument 的注解信息。如下图所示:

java基础知识入门

@Target

@Target 注解用来指定一个注解的使用范围,即被 @Target 修饰的注解可以用在什么地方。@Target 注解有一个成员变量(value)用来设置适用目标,value 是 java.lang.annotation.ElementType 枚举类型的数组,下表为 ElementType 常用的枚举常量。

java基础知识入门

示例 2

自定义一个 MyTarget 注解,使用范围为方法,代码如下所示。

java基础知识入门

如上代码第 6 行会编译错误,错误信息为:

The annotation @MyTarget is disallowed for this location

提示此位置不允许使用注解 @MyDocumented,@MyTarget 不能修饰成员变量,只能修饰方法。

@Retention

@Retention 用于描述注解的生命周期,也就是该注解被保留的时间长短。@Retention 注解中的成员变量(value)用来设置保留策略,value 是 java.lang.annotation.RetentionPolicy 枚举类型,RetentionPolicy 有 3 个枚举常量,如下所示。

SOURCE:在源文件中有效(即源文件保留)

CLASS:在 class 文件中有效(即 class 保留)

RUNTIME:在运行时有效(即运行时保留)

生命周期大小排序为 SOURCE < CLASS < RUNTIME,前者能使用的地方后者一定也能使用。如果需要在运行时去动态获取注解信息,那只能用 RUNTIME 注解;如果要在编译时进行一些预处理操作,比如生成一些辅助代码(如 ButterKnife),就用 CLASS 注解;如果只是做一些检查性的操作,比如 @Override 和 @SuppressWarnings,则可选用 SOURCE 注解。

点击知道更多编程知识

文章来源于网络