Java语法规定了可以自定义注解类。这里说一下如何定义注解类,以及相关参数说明。
1. 基本情况
Java 注解类申明 采用 @interface来申明注解类。一个注解可以有多个成员。
成员以无入参、无抛出异常的方式申明, 成员申明以接口申明方法类似
例如: boolean value() default true;
可以指定默认值 也可以不指定。如果指定 使用 default 后面接默认值
如果注解只有一个成员变量 必须取名为value() ,在使用时 可以忽略 成员名称 和 = 号 例如 @Test(“test”)
如果多个成员,也可以这样使用,但是如果同时对多个成员进行赋值,必须使用赋值符号
例如 @Test(value = “12”, method = “12”)
2. 元注解
元注解(Meta-Annotation)是Java预定义的注解, 他们被编译器使用。元注解的作用就是注解其他注解
Java 5.0定义了 4个标准的元注解,它们被用来提供对其它 annotation类型作说明
- @Target
- @Retention
- @Documented
- @Inherited
1.1 @Target
用于描述注解的范围,即注解在哪使用。取值类型(ElementType)有:
- CONSTRUCTOR 用于描述构造器
- METHOD 用于描述方法
- PARAMETER 用于描述参数
- FIELD 用于描述域(成员变量)
- LOCAL_VARIABLE 用于描述局部变量
- PACKAGE 用于描述包
- TYPE 用于描述类、接口(包括注解类型) 或enum声明
- TYPE_PARAMETER 1.8版本开始,描述类、接口或enum参数的声明 很少见到
- TYPE_USE:1.8版本开始,描述一种类、接口或enum的使用声明
@Target({ElementType.METHOD, ElementType.FIELD})
public @interface Test{
}
1.2 @Retention
用于描述注解的声明周期,表示在什么级别保存该注解。保留的时间长短,取值(RetentionPolicy)有以下几种:
- SOURCE 即注解信息仅保留在目标类的源码文件中,编译后不在保存
- CLASS 即注解信息保存在编译后的字节码文件中,但类加载器加载字节码文件时不会将注解加载到JVM虚拟机中。即运行期间不能获取注解信息
- RUNTIME 即猪脚信息在目标类加载到JVM后依然保留,在运行期间通过反射机制获取类中的注解信息
@Retention(RetentionPolicy.RUNTIME)
public @interface Test{
}
1.3 @Documented
用于描述其它类型的annotation应该被作为被标注的程序成员的公共API,因此可以被例如javadoc此类的工具文档化。它是一个标记注解,没有成员。
1.4 Inherited
用于表示某个被标注的类型是被继承的,如果一个使用了@Inherited修饰的annotation类型被用于一个class,则这个annotation将被用于该class的子类。