1.7 元注解作用及使用
元注解是负责对其它注解进行说明的注解,自定义注解时可以使用元注解
。Java 5 定义了 4 个注解,分别是 @Documented
、@Target
、@Retention
和 @Inherited
。Java 8 又增加了 @Repeatable
和 @Native
两个注解。这些注解都可以在 java.lang.annotation 包中找到。下面主要介绍每个元注解的作用及使用。
@Documented
@Documented 是一个标记注解,没有成员变量。用 @Documented 注解修饰的注解类会被 JavaDoc 工具提取成文档
。默认情况下,JavaDoc 是不包括注解的,但如果声明注解时指定了 @Documented,就会被 JavaDoc 之类的工具处理,所以注解类型信息就会被包括在生成的帮助文档中。
下面通过示例来了解它的用法,代码如下所示。
例 1
@Documented
@Target({ ElementType.TYPE, ElementType.METHOD })
public @interface MyDocumented {public String value() default "这是@Documented注解";
}
测试类:
@MyDocumented
public class DocumentedTest {/*** 测试document*/@MyDocumentedpublic String Test() {return "C语言中文网Java教程";}
}
打开 Java 文件所在的目录,分别输入如下两条命令行:
javac MyDocumented.java DocumentedTest.java javadoc -d doc
MyDocumented.java DocumentedTest.java
运行成功后,打开生成的帮助文档,可以看到在类和方法上都保留了 MyDocument 的注解信息。如下图所示:
@Target
@Target 注解用来指定一个注解的使用范围,即被 @Target 修饰的注解可以用在什么地方
。@Target 注解有一个成员变量(value)用来设置适用目标,value 是 java.lang.annotation.ElementType 枚举类型的数组,下表为 ElementType 常用的枚举常量。
名称 | 说明 |
---|---|
CONSTRUCTOR | 用于构造方法 |
FIELD | 用于成员变量(包括枚举常量) |
LOCAL_VARIABLE | 用于局部变量 |
METHOD | 用于方法 |
PACKAGE | 用于包 |
PARAMETER | 用于类型参数(JDK 1.8新增) |
TYPE | 用于类、接口(包括注解类型)或 enum 声明 |
例 2
自定义一个 MyTarget 注解,使用范围为方法,代码如下所示。
@Target({ ElementType.METHOD })
public @interface MyTarget {}
class Test {6 @MyTargetString name;
}
如上代码第 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 注解。
@Inherited
@Inherited 是一个标记注解,用来指定该注解可以被继承。使用 @Inherited 注解的 Class 类,表示这个注解可以被用于该 Class 类的子类。就是说如果某个类使用了被 @Inherited 修饰的注解,则其子类将自动具有该注解。
例 3
创建一个自定义注解,代码如下所示:
@Target({ ElementType.TYPE })
@Inherited
@Retention(RetentionPolicy.RUNTIME)
public @interface MyInherited {}
测试类代码如下:
@MyInherited
public class TestA {public static void main(String[] args) {System.out.println(TestA.class.getAnnotation(MyInherited.class));System.out.println(TestB.class.getAnnotation(MyInherited.class));System.out.println(TestC.class.getAnnotation(MyInherited.class));}
}
class TestB extends TestA {}
class TestC extends TestB {}
运行结果为:
@MyInherited()
@MyInherited()
@MyInherited()
@Repeatable
@Repeatable 注解是 Java 8 新增加的,它允许在相同的程序元素中重复注解
,在需要对同一种注解多次使用时,往往需要借助 @Repeatable 注解。Java 8 版本以前,同一个程序元素前最多只能有一个相同类型的注解,如果需要在同一个元素前使用多个相同类型的注解,则必须使用注解“容器”。
例 4
Java 8 之前的做法:
public @interface Roles {Role[] roles();
}
public @interface Roles {Role[] value();
}
public class RoleTest {@Roles(roles = {@Role(roleName = "role1"), @Role(roleName = "role2")})public String doString(){return "歪比巴卜";}
}
Java 8 之后增加了重复注解,使用方式如下:
public @interface Roles {Role[] value();
}
@Repeatable(Roles.class)
public @interface Role {String roleName();
}
public class RoleTest {@Role(roleName = "role1")@Role(roleName = "role2")public String doString(){return "歪比巴卜";}
}
不同的地方是,创建重复注解 Role 时加上了 @Repeatable 注解,指向存储注解 Roles,这样在使用时就可以直接重复使用 Role 注解。从上面例子看出,使用 @Repeatable 注解更符合常规思维,可读性强一点。
两种方法获得的效果相同。重复注解只是一种简化写法,这种简化写法是一种假象,多个重复注解其实会被作为“容器”注解的 value 成员的数组元素处理。
@Native
使用 @Native 注解修饰成员变量,则表示这个变量可以被本地代码引用,常常被代码生成工具使用。对于 @Native 注解不常使用,了解即可。
1.7 元注解作用及使用相关推荐
- c JAVA 注解,Java元注解作用及使用
元注解是负责对其它注解进行说明的注解,自定义注解时可以使用元注解.Java 5 定义了 4 个注解,分别是 @Documented.@Target.@Retention 和 @Inherited.Ja ...
- Java元注解作用及使用
元注解是负责对其它注解进行说明的注解,自定义注解时可以使用元注解.Java 5 定义了 4 个注解,分别是 @Documented.@Target.@Retention 和 @Inherited.Ja ...
- Java获取元注解_Java 元注解
一.介绍 元注解的作用就是负责注解其他注解,Java5.0定义了4个标准的meta-annotation类型,它们被用来提供对其它 annotation类型作说明.Java5.0定义的元注解: @Ta ...
- 注解整理 - 元注解,lombok注解,spring 注解,springboot注解,springmvc注解
注解大全 java四种元注解 @Target @Retention @Documented @Inherited lombok注解 lombok注解为什么强大 lombok注解的使用方式 1.安装lo ...
- 【Java 注解】自定义注解 ( 元注解 )
文章目录 一.元注解 二.常用的元注解类型 三.@Target 元注解 四.@Retention 元注解 五.@Documented 元注解 六.@Documented 元注解 一.元注解 元注解 是 ...
- 深入理解java注解,java的4个元注解,注解三要素——定义、使用及读取执行,深入了解注解的底层本质,通过反射自动、动态获取注解所有属性以及属性值
1. 注解的定义 注解也是一种引用类型,编译后会生成 .class 字节码文件,作用就是为程序进行标识,不同注解能实现不同功能. 2. 注解的使用 3. 注解的读取执行 3.1 得不到注解信息,得到的 ...
- @retention注解作用_分分钟带你玩转SpringBoot自定义注解
在工作中,我们有时候需要将一些公共的功能封装,比如操作日志的存储,防重复提交等等.这些功能有些接口会用到,为了便于其他接口和方法的使用,做成自定义注解,侵入性更低一点.别人用的话直接注解就好.下面就来 ...
- 注解_自定义注解_元注解
* 元注解:用于描述注解的注解 * @Target:描述注解能够作用的位置* ElementType取值:* TYPE:可以作用于类上* METHOD:可以作用于方法上* FIELD:可以作用于成员变 ...
- @retention注解作用_Spring 最核心的注解,都是干货!
Spring中的注解大概可以分为两大类: spring的bean容器相关的注解,或者说bean工厂相关的注解: springmvc相关的注解. spring的bean容器相关的注解有:@Require ...
最新文章
- Winform中将Bitmap对象通过pictureBox显示图片
- SQL注入绕过登录验证
- 设计模式的C语言应用-非典型模式-第十章
- liunx服务器数据库文件大小,linux如何查看数据库服务器大小
- raid5坏了一块盘怎么办_如果你的硬盘坏了 你的照片还能找回来吗?
- C++11新特性 - 侯捷
- 区块链技术应用场景之政务链
- VB中的ByVal和ByRef的区别
- Win10 0x80190001错误解决
- 梯度下降及python实现
- 基于SpringBoot+Vue20小时打造高考志愿填报辅助系统
- 图片asp木马的制作方法[转]
- 软件测试工程师常见面试题
- 读取和博客可视化分析
- 24系列服务器,产品技术-H3C UniServer R4950 G5服务器-新华三集团-H3C
- 程序员都有些什么企业文化?
- 【笔记】网易微专业-Web安全工程师-01.WEB基础知识
- JAVA 游戏分享 - “是男人就下100层”
- treesize professional(硬盘文件整理工具) v8.0.3.1507
- amr音频格式手机录音音频转MP3的方法