Java之注解（Annotation）

定义

注解（Annotation），也叫元数据。一种代码级别的说明。它是JDK1.5及以后版本引入的一个特性，与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面，用来对这些元素进行说明，注释。它们都不会直接影响到程序的语义，只是作为注解（标识）存在，我们可以通过反射机制编程实现对这些元数据（用来描述数据的数据）的访问。

作用

①编写文档：通过代码里标识的元数据生成文档【生成文档doc文档】 ②代码分析：通过代码里标识的元数据对代码进行分析【使用反射】
③编译检查：通过代码里标识的元数据让编译器能够实现基本的编译检查【Override】

内置注解

Java有3个重要注解可用：

@Override

它的作用是对覆盖超类中方法的方法进行标记，如果被标记的方法并没有实际覆盖超类中的方法，则编译器会发出错误警告。

public class DemoTest {
   @Override
   public String toString() {
       return "测试注解";
   }
}

@Deprecated

它的作用是对不应该再使用的方法添加注解，当编程人员使用这些方法时，将会在编译时显示（show()）提示信息。

public static void main(String[] args) {
	show();
}
	
@Deprecated
public static void show(){
	System.out.println("测试");
}

@SuppressWarnings

其参数有： deprecation：使用了过时的类或方法时的警告 unchecked：执行了未检查的转换时的警告
fallthrough：当 switch 程序块直接通往下一种情况而没有 break 时的警告
path：在类路径、源文件路径等中有不存在的路径时的警告 serial：当在可序列化的类上缺少serialVersionUID
定义时的警告 finally：任何 finally 子句不能正常完成时的警告

List list = newArrayList();
@SuppressWarnings("unchecked")
public void add(Stringdata) {
    list.add(data);
}

自定义注解

使用@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.以上所有类型的数组

元注解

元注解的作用就是负责注解其他注解。Java5.0定义了4个标准的meta-annotation类型，它们被用来提供对其它
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:用于描述类、接口(包括注解类型) 或enum声明

@Target({ElementType.TYPE})
public @interface Table {
    /**
     * 数据表名称注解
     * @return
     */
    public String tableName() default "className";

}

@Target({ElementType.FIELD})
public @interface NoDBColumn {

}

注解Table 可以用于注解类、接口(包括注解类型) 或enum声明,而注解NoDBColumn仅可用于注解类的成员变量。

@Retention

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

取值（RetentionPoicy）有：
1.SOURCE:在源文件中有效（即源文件保留）
2.CLASS:在class文件中有效（即class保留）
3.RUNTIME:在运行时有效（即运行时保留） Retention meta-annotation类型有唯一的value作为成员，它的取值来自java.lang.annotation.RetentionPolicy的枚举类型值。具体实例如下：

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Column {
    public String name() default "fieldName";
    public String setFuncName() default "setField";
    public String getFuncName() default "getField"; 
    public boolean defaultDBValue() default false;
}

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

@Documented

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

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface Color{
   String value();
}

@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类型被发现，或者到达类继承结构的顶层。

//自定义注解
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface Color{
   String value();
}

//创建父类，并使用注解
@Color(value = "red")
public class Parent {

	@Color(value = "green")
	public void show() {  
        System.out.println("Parent do show");  
    }  
}

//创建子类继承父类并重写方法
public class Child extends Parent {

	@Override
	public void show() {
		System.out.println("Child do show");  
	}
}

//通过反射获取子类方法注解信息
Class<Child> c = Child.class;  
Method method = c.getMethod("show", new Class[]{});  

if (method.isAnnotationPresent(Color.class)) {  
    InheritedTest inheritedTest = method.getAnnotation(Color.class);  
    String value = inheritedTest.value();  
    System.out.println(value);  
}  

说明：上面我们创建接口并标注@Inherited，创建父类并使用注解，创建子类并继承父类，并且重写了父类show方法，然后我们通过反射获取子类重写方法show的注解信息，结果是获取不到的。这就是上面注意所提到的。