Java自定义注解反射校验数据
Java: 自定义注解
元注解:
元注解的作用就是负责注解其他注解。
Java 定义了 4 个标准的 meta-annotation 类型,它们被用来提供对其他的 annotation 类型做说明。
@Target:
@Target 说明了 Annatation 所修饰的对象范围:Annotation 可以被用于 packages、types(类、接口、枚举、Annation 类型)、
类型成员 (方法、构造方法、成员变量、枚举值)、方法参数和本地变量 (如循环变量、catch 参数)。在 Annotation 类型的声明中使用了 target 可更加明晰其修饰的目标。
作用: 用于描述注解的使用范围 (即: 被描述的注解可以用在什么地方)。
取值 (ElementType.):
1、CONSTRUCTOR 用于描述构造器
2、FIELD 用于描述域
3、LOCAL_VARIABLE 用于描述局部变量
4、METHOD 用于描述方法
5、PACKAGE 用于描述包
6、PARMETER 用于描述参数
7、TYPE 用于描述类、接口 (包括注解类型) 或 enum 声明
@Retention
@Retention 定义了该 Annotation 被保留的时间长短: 某些 Annotation 仅出现在源代码中,而被编译器丢弃;
而另一些被却被编译在 class 文件中;编译在 class 文件中的 Annotation 可能会被虚拟机忽略,而另外一些 class 被装载是将被读取。
使用这个 meta-Annotation 可以对 Annotation 的生命周期限制。
作用: 表示需要什么级别保存该注释信息,用于描述注解的生命周期(即: 被描述的注解在什么范围内有效)
取值 (RetentionPoicy):
1、SOURCE: 编译器要丢弃的注释,在源文件中有效 (即源文件保留)。
2、CLASS: 编译器将把注释记录在类文件中,但在运行时 VM 不需要保留注释。
3、RUNTIME: 编译器将把注释记录在类文件中,在运行时 VM 将保留注释,因此可以反射性地读取。
Retention meta-annotation 类型有唯一的 value 作为成员,它的取值来自 java.lang.annotation.RetentionPolicy 的枚举类型值。
RetentionPolicy 的属性值是 RUTIME, 这样注解处理器可以通过反射,获取到该注解的属性值,从而去做一些运行时的逻辑处理
@Documented
@Documented 如果类型声明是用 Documented 来注释的,则其注释将成为注释元素的公共 API 的一部分。 Documented 是一个标记注解,没有成员。
@Inherited
@Inherited 元注解是一个标记注解,@Inherited 阐述了某个被标注的类型是被继承的。如果一个使用了 @Inherited 修饰的 annotation 类型被用于一个 class,则这个 annotation 将被用于该 class 的子类。
自定义注解
使用 @interface 自定义注解时,自动继承了 java.lang.annotation.Annotation 接口,由编译程序自动完成其他细节。在定义注解时,不能继承其他的注解或接口。
@interface 用来声明一个注解,其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称,返回值类型就是参数的类型(返回值类型只能是基本类型、Class、String、enum)。可以通过 default 来声明参数的默认值。
定义注解格式:
public @interface 注解名 {定义体}
注解参数的可支持数据类型:
1. 所有基本数据类型(int,float,boolean,byte,double,char,long,short)
2.String 类型
3.Class 类型
4.enum 类型
5.Annotation 类型
6. 以上所有类型的数组
Annotation 类型里面的参数该怎么设定:
第一, 只能用 public 或默认 (default) 这两个访问权修饰. 例如,String value(); 这里把方法设为 defaul 默认类型;
第二, 参数成员只能用基本类型 byte,short,char,int,long,float,double,boolean 八种基本数据类型和 String,Enum,Class,annotations 等数据类型, 以及这一些类型的数组. 例如,String value(); 这里的参数成员就为 String;
第三, 如果只有一个参数成员, 最好把参数名称设为 "value", 后加小括号。
注解元素的默认值:
注解元素必须有确定的值,要么在定义注解的默认值中指定,要么在使用注解时指定,非基本类型的注解元素的值不可为 null。
因此, 使用空字符串或 0 作为默认值是一种常用的做法。这个约束使得处理器很难表现一个元素的存在或缺失的状态,因为每个注解的声明中,
所有元素都存在,并且都具有相应的值,为了绕开这个约束,我们只能定义一些特殊的值,
例如空字符串或者负数,一次表示某个元素不存在,在定义注解时,这已经成为一个习惯用法
注解处理器