自定义注解(Annotation)详解

什么是注解

Annotation（注解）就是Java提供了一种元程序中的元素关联任何信息和着任何元数据（metadata）的途径和方法。Annotion(注解)是一个接口，程序可以通过反射来获取指定程序元素的 Annotion对象，然后通过 Annotion对象 来获取注解里面的元数据。

Annotation（注解）是JDK5.0及以后版本引入的。它可以用于创建文档，跟踪代码中的依赖性，甚至执行基本编译时检查。从某些方面看，annotation 就像修饰符一样被使用，并应用于包、类 型、构造方法、方法、成员变量、参数、本地变量的声明中。这些信息被存储在 Annotation 的 “name=value” 结构对中。

 

什么是metadata元数据

 

元数据从 metadata 一词译来，就是“关于数据的数据”的意思。

元数据的功能作用有很多，比如：你可能用过 Javadoc 的注释自动生成文档。这就是元数据功能的一种。总的来说，元数据可以用来创建文档，跟踪代码的依赖性，执行编译时格式检查，代替已有的配置文件。如果要对于元数据的作用进行分类，目前还没有明确的定义，不过我们可以根据它所起的作用，大致可分为三类： 

1. 编写文档：通过代码里标识的元数据生成文档

2. 代码分析：通过代码里标识的元数据对代码进行分析

3. 编译检查：通过代码里标识的元数据让编译器能实现基本的编译检查

 

Annotation和Annotation类型

 

Annotation 使用了在 java5.0 所带来的新语法，它的行为十分类似 public、final 这样的修饰符。每个 Annotation 具有 一个名字 和 成员个数>=0。每个 Annotation 的成员具有被称为 name=value 对的名字和值（就像 javabean 一样），name=value 装载了 Annotation 的信息。

Annotation类型 定义了 Annotation 的名字、类型、成员默认值。一个 Annotation类型 可以说是一个特殊的java接口，它的成员变量是受限制的，而声明 Annotation类型 时需要使用新语法。当我们通过 java反射api 访问 Annotation 时，返回值将是一个实现了该  annotation类型 接口的对象，通过访问这个对象我们能方便的访问到其 Annotation 成员。后面的章节将提到在 java5.0 的 java.lang 包里包含的3个标准 Annotation类型。

 

注解的分类

 

根据注解的参数个数分类：

1. 标记注解，一个没有成员的Annotation类型被称为标记注解，这种类型仅仅使用自身的存在与否来为我们提供信息，比如常见的@Override

2. 单值注解

3. 完整注解

根据注解使用的方法和用途分类：

1. JDK内置系统注解

2. 元注解

3. 自定义注解

 

元注解

元注解的作用就是负责注解其他注解，Java 5.0定义了 4个meta-annotation 类型，用来提供对爱他的 annotation 类型做说明。

java.lang.annotation

• @Target

• @Retention

• @Document

• @Inhrited

@Target

修饰的对象范围：packages、types（类、接口、枚举、Annotation类型）、类型成员（方法、构造方法、成员变量、枚举值）、方法参数和本地变量（如循环变量、catch参数）。

作用：用于描述注解的使用范围。

ElementType 取值：

1. CONSTRUCTOR:用于描述构造器

2. FIELD:用于描述域

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

4. METHOD:用于描述方法

5. PACKAGE:用于描述包

6. PARAMETER:用于描述参数

7. TYPE:用于描述类、接口(包括注解类型) 或enum声明

例如，Name 可以注解类的成员变量：

@Target(ElementType.FIELD)@Documented
public @interface Name {    String value() default "";
}

Person 可以注解类、接口（包括注解类型）、或者enum声明:

@Target(ElementType.TYPE)
public @interface Person {
    String value() default "";
}

@Retention

定义了该 Annotation 被保留的时间长短：某些 Annotation 仅出现在源代码中，而被编译器丢弃；而另一些却被编译在class文件中；编译在class文件中的Annotation可能会被虚拟机忽略，而另一些在 class 被装载时将被读取（请注意并不影响 class 的执行，因为 Annotation 与 class 在使用上是被分离的）。使用这个 meta-Annotation 可以对  Annotation 的“生命周期”限制。

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

RetentionPoicy取值:

• SOURCE:在源文件中有效（即源文件保留）

• CLASS:在class文件中有效（即class保留）

• RUNTIME:在运行时有效（即运行时保留）

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

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Name {
    String value() default "";
}

@Document

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

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

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Name {
    String value() default "";
}

@Inhrited

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

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

当 @Inherited annotation类型 标注的 annotation 的 Retention 是 RetentionPolicy.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类型里面的参数该怎么设定:

第一,只能用 public 或 默认(default) 这两个访问权修饰.例如,String value();这里把方法设为 defaul 默认类型；

第二,参数成员只能用基本类型 byte,short,char,int,long,float,double,boolean 八种基本数据类型 和 String,Enum,Class,annotations 等数据类型,以及这一些类型的数组.例如,String value();这里的参数成员就为String;

第三,如果只有一个参数成员,最好把参数名称设为"value",后加小括号.例:下面的例子 Name 注解就只有一个参数成员。

Name 姓名注解：

 

 

Gander 性别注解：

 

Profile 个人资料注解：

 

注解元素的默认值

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

注解处理器类库(java.lang.reflect.AnnotatedElement)

注解元素Java使用 Annotation 接口来代表程序元素前面的注解，该接口是所有 Annotation类型 的父接口。除此之外，Java 在 java.lang.reflect 包下新增了 AnnotatedElement 接口，该接口代表程序中可以接受注解的程序元素，该接口主要有如下几个实现类：

• Class：类定义

• Constructor：构造器定义

• Field：累的成员变量定义

• Method：类的方法定义

• Package：类的包定义

当一个 Annotation 被定义为运行时Annotation后，改注解才是运行时可见的，当class文件被装载时被保存在class文件中的Annotation才会被虚拟机读取。 

AnnotatedElement 接口提供了以下四个方法来访问 Annotation 的信息：

• 方法1：<T extends Annotation> T getAnnotation(Class<T> annotationClass): 返回改程序元素上存在的、指定类型的注解，如果该类型注解不存在，则返回null。

• 方法2：Annotation[] getAnnotations():返回该程序元素上存在的所有注解。

• 方法3：boolean is AnnotationPresent(Class<?extends Annotation> annotationClass):判断该程序元素上是否包含指定类型的注解，存在则返回true，否则返回false.

• 方法4：Annotation[] getDeclaredAnnotations()：返回直接存在于此元素上的所有注释。与此接口中的其他方法不同，该方法将忽略继承的注释。（如果没有注释直接存在于此元素上，则返回长度为零的一个数组。）该方法的调用者可以随意修改返回的数组；这不会对其他调用者返回的数组产生任何影响。

我们为前面定义好的自定义注解写一个简单的处理器：

 

使用自定义注解：

 

运行：

CustomUtils.getInfo(Person.class);

输出：