Java注解Annotation

Posted 2020-08-22 Aaron

Java注解Annotation（一）——简介

这一章首先简单介绍一下注解，下一章会给出一个注解应用的DEMO。

1. 元注解

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

JDK1.5中，定义了4个标准的meta-annotation元注解类型，他们被用来提供对其它annotation注解类型作说明。

1. @Target
2. @Retention
3. @Documented
4. @Inherited

这些类型和它们所支持的类在java.lang.annotation包中可以找到。

@Target

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

作用：用于描述注解的使用范围，即被描述的注解可以用在什么地方。

取值（ElementType）：

1. CONSTRUCTOR，用于描述构造器

2. FIELD：用于描述域

3. LOCAL_VARIABLE：用于描述局部变量

4. METHOD：用于描述方法

5.PACKAGE：用于描述包

6. PARAMETER：用于描述参数

7. TYPE：用于描述类，接口或枚举等类型

@Retention

@Retention定义了该Annotation注解被保留的时间擦汗你高端，某些Annotation仅出现在源码中，而被编译器丢弃，而另一些却被编译在class文件中；编译在class文件中的Annotation可能会被虚拟机忽略，而另一些在class被装载时将被读取（请注意并不影响class的执行，因为Annotation与class在使用上是被分离的）。

作用：表示需要在什么级别保存该注释信息，用于描述注解的生命周期，即被描述的注解在什么范围内有效。

取值（RetentionPoicy）：

1. SOURCE：在源文件中有效

2. CLASS：在class文件中有效

3. RUNTIME：在运行时有效

注解的RetentionPolicy的属性值是RUNTIME，这样注解处理器可以通过反射，获取到该注解的属性值，从而去做一些运行时的逻辑处理。

@Documented

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

@Inherited

@Inherited元注解是一个标记注解，@Inherited阐述了某个被标注的类型是被继承的，注解类型被自动继承。如果一个使用了@Inherited修饰的annotation类型被用于一个class，则这个annotation将被用于该class的子类

注意：@Inherited annotation类型是被标注过的class的子类所继承。类并不从它所实现的接口继承annotation，方法并不从它所重载的方法继承annotatiaon。

2.自定义注解

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

自定义注解的格式：

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interfaces Demo {
  public String value() default "demo";
}

 

上面的代码，说明了@Demo这个自定义注解在使用的时候，只能注解FIELD，即类的属性，只能在运行时才会起作用。其中注解中的方法默认会返回字符串"demo"。

参数的可支持的数据类型：

• 所有基本数据类型
• String类型
• Class类型
• enum类型
• Annotation类型
• 以上所有类型的数组

Annotation类型里面的参数的设定：

1. 只能用public或者默认default这两个访问权修饰
2. 参数成员的类型只能是上述几种。
3. 如果只有一个参数成员，最好把参数名称设为"value"，如上述代码。

注解元素的默认值：

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

3.注解处理器

在声明了注解hiro，我们要对注解注释的方法进行处理。

注解处理器类库：

java.lang.reflect.AnnotatedElement