Java自定义注解 Annotation

时间:2021-11-07 05:48:10

Java注解是附加在代码中的元信息,用于一些工具在编译、运行时进行解析和使用,起到说明、配置的功能。注解不会也不能影响代码的实际逻辑,仅仅起到辅助作用。

元注解:

元注解的作用是负责注解其他注解。

@Target:说明Annotation所修饰的对象范围,Annotation可被用于packages/、types(类、接口、枚举、Annotation类型)、类型成员(方法、构造方法、成员变量、枚举值)、方法参数和本地变量(如循环变量、catch参数)。在Annotation类型的声明中使用target可更加明确其修饰的目标。

constructor:描述构造器

Field:描述域

Local_variable:描述局部变量

Method:描述方法

Package:描述包

Parameter:描述参数

Type:描述类、接口(包括注解类型)、enum声明

@Retention 定义该Annotation被保留的时间长短;某些Annotation 仅出现在源代码中,而被编译器丢弃;另一些被编译在class文件中;编译在class文件中的Annotation会被虚拟机忽略,另一些在class装载时被读取(Annotation与class在使用上是被分离的,互不影响)。

source:源文件中有效

class:class文件中有效

runtime:运行时有效

@Documented:用于描述其他类型的Annotation应该被作为被标注的程序成员的公共API,因此可以被例如javadoc类的工具文档化。是一个标记注解,没有成员。

@Inherited 元注解是一个标记注解,阐述了某个被标注的类型是被继承的。如果使用一个@Inherited 修饰的Annotation 类型被用于一个class,则这个 Annotation 将被用于该class的子类。@Inherited annotation 类型是被标注过的class的子类所继承。类并不从他所实现的接口继承 annotation ,方法并不从它所重载的方法继承annotation。

当@inherited annotation 类型标注的 annotation 的retention 是 runtime ,则反射api 增强了这种继承性。如果我们使用java.lang.reflect 去查询一个@inherited annotation 类型的 annotation 时,反射代码检查将展开工作:检查class 和起父类,直到发现制定的 annotation 类型,或者到达类继承结构的顶层。

自定义注解:

使用@interface 自定义注解时,自动继承 java.lang.annotation.Annotation 接口,由编译程序自动完成其他细节。在定义注解时,不能继承其他的注解或接口。@interface用来声明一个注解,其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称,返回值的类型就是参数的类型(返回值类型只能是基本类型、class、String、enum)。可以通过default 来声明参数的默认值。

public @interface 注解名{定义体}

所有基本数据类型(int、float、boolean、byte、double、char、long、short)

String类型

Class类型

enum类型

Annotation类型

以上所有类型的数组

Annotation类型的参数设定:

1、只能用public 或默认 default 两个访问权修饰符,例如String value();这里为default 默认类型

2、参数成员只能用基本类型 byte short char int long float double boolean八种基本数据类型和String enum class annotation 等数据类型,以及这些类型的数组。

3、如果只有一个参数成员,最好把参数名称设为 value 加小括号。

注解元素的默认值:

注解元素必须有确定的值,要么在定义注解的默认值中指定,要么在使用注解时指定,非基本类型的注解元素的值不可为null。因此,使用空字符串或0作为默认值是一种常用的做法。这个约束使得处理器很难表现一个元素的存在或缺失的状态,因为每个注解的声明中,所有元素都存在,并且都具有相应的值,为了绕开这个约束,我们只能定义一些特殊的值,例如空字符串或者负数,一次表示某个元素不存在,是定义注解时的习惯用法。