自定义数据采集插件三部曲之Annotation

简介

Annotation即注解又称Java注解，是Java语言5.0版本开始支持加入源代码的特殊语法元数据。

Java语言中的类、方法、变量、参数和包等都可以被标注。和Javadoc不同，Java标注可以通过反射获取标注内容。在编译器生成类文件时，标注可以被嵌入到字节码中。Java虚拟机可以保留标注内容，在运行时可以获取到标注内容。维基百科 英文说明

下面是一个Annotation的实例：

//第一个@Target表示这个注解只能给函数使用
//第二个@Retention表示注解内容需要包含的Class字节码里，属于运行时需要的。
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface AppStats {
    int pg() default 1;
    int PS = 1;
}

要深入了解Annotation，我们就需要从自定义Annotation入手，在自定义Annotation之前我们有必要先了解下Annotation的语法。

语法

在说语法之前，我们先分析下上面的例子：

1. @interface关键字定义Annotation
2. Annotation可以被其它Annotation修饰
3. Annotation和接口类似，内部可以定义常量和方法。
4. Annotation对定义的方法有一定限制：方法不能有参数；返回值只能是基本类型、字符串、Class、枚举、注解、及以上类型的数组；可以包含默认值。

一、元注解

元注解，就是定义注解的注解。由@Target、@Retention、@Documented、@Inherited这四种注解组成。

1. @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:用于描述类、接口(包括注解类型) 或enum声明

实例：

@Target(ElementType.METHOD)
public @interface TestTarget {

}

2. @Retention

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

其取值（RetentionPoicy）有：

1. SOURCE：在源文件中有效（即源文件保留）
2. CLASS：在class文件中有效（即class保留）
3. RUNTIME：在运行时有效（即运行时保留）

实例：

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestRetention {

}

3. @Documented

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

实例：

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface TestDocumented {

}

4. @Inherited

@Inherited 元注解是一个标记注解，@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类型被发现，或者到达类继承结构的顶层。

实例：

@Inherited
public @interface TestInherited {

}

二、自定义Annotation

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

1. 定义注解格式：

• public @interface 注解名 {定义体}

2. 注解参数可支持数据类型：

• 1.所有基本数据类型（int,float,boolean,byte,double,char,long,short)
• 2.String类型
• 3.Class类型
• 4.enum类型
• 5.Annotation类型
• 6.以上所有类型的数组

3. Annotation类型里面的参数设定:

• 1. 只能用public或默认(default)这两个访问权修饰.例如,String value();这里把方法设为defaul默认类型；
• 2. 参数成员只能用基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型和 String,Enum,Class,annotations等数据类型,以及这一些类型的数组.例如,String value();这里的参数成员就为String;

实例：

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestCustom {
    String name() defualt "";
}

注解元素的默认值

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