JAVA 注解（Annotation）自定义注解入门

注解的基本概念

Java 注解就像修饰符一样，可以用于从java代码中抽取文档、跟踪代码中的依赖性或者在编译时做检查。注解可以被应用在包、类、方法、成员变量、参数和本地变量的声明中。我们大多数人最先接触的注解就是@Override。

注解的工作原理就是，先使用注解修饰java代码，然后另一块叫做注解处理器的代码会解析这段注解和被修饰的代码并做相应的处理。

---

---

JDK内置的标准注解
JavaSE中内置了三个标准注解，都是定义在java.lang中，它们是：

    @Override:用于修饰子类的方法覆盖了父类中的方法；    @Deprecated:用于修饰已经过时了的方法，不推荐使用的方法；    @SuppressWarnnings:告诉java编译器禁止编译警告。

@Override
很简单，只是一个标记，用于标注一个方法。它表示，被它标注的方法覆盖了父类的方法。如果一不小心，子类的方法名写错了，有了@Override之后，编译时会报错。也就是说被@Override标注的方法如果没有覆盖父类的方法，编译时报错。

@Deprecated
也是一个标记注解，用于修饰一个方法。它表示此方法不推荐使用。无论是继承、覆盖或直接使用此方法，编译器都会给出警告。

@SuppressWarnings
字面翻译就是抑制警告，它用于告诉编译器，对被标注的这句代码不要给出特定的警告。

@SuppressWarnings有一些参数用于表示特定的警告：

    deprecation:不要给出“不赞成使用的类或方法的警告”；    unchecked:不要给出“类型转换时警告”；    fallthrough:不要给出”switch语句块没有break的警告”；    path:不要给出“不存在的路径”的警告；    serial:不要给出“可序列化类缺少serialVersionUID”的警告；    finally:不要给出“finally语句块不能正常完成”的警告；    all:不要给出以上所有情况的警告。

---

---

自定义注解

要深入学习注解，我们就必须能定义自己的注解，并使用注解，在定义自己的注解之前，我们就必须要了解Java为我们提供的元注解和相关定义注解的语法

元注解：

　　元注解的作用就是负责注解其他注解。Java5.0定义了4个标准的meta-annotation类型，它们被用来提供对其它 annotation类型作说明。Java5.0定义的元注解：
　　　

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

---

@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,这样注解处理器可以通过反射，获取到该注解的属性值，从而去做一些运行时的逻辑处理

---

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

---

---

开始自定义注解

定义注解格式：

　　public @interface 注解名 {定义体}

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

    所有基本数据类型（int,float,boolean,byte,double,char,long,short)    String类型    Class类型    enum类型    Annotation类型    以上所有类型的数组

使用@interface自定义注解时，自动继承了java.lang.annotation.Annotation接口，由编译程序自动完成其他细节。在定义注解时，不能继承其他的注解或接口。

@interface用来声明一个注解，其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称，返回值类型就是参数的类型（返回值类型只能是基本类型、Class、String、enum）。可以通过default来声明参数的默认值。

注意：

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

@Target(TYPE)@Inherited@Retention(RUNTIME)public @interface ComponentDesc {    String agent();    String groupType();}

注解元素的默认值：

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

/**  * 水果供应者注解  * @author peida  *  */ @Target(ElementType.FIELD) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface FruitProvider {     /**      * 供应商编号      * @return      */     public int id() default -1;     /**      * 供应商名称      * @return      */     public String name() default "";     /**      * 供应商地址      * @return      */     public String address() default ""; }

定义一个注解处理器，用于处理注解内容：

import java.lang.reflect.Field;public class AnnotationProcessor {    public static void getStudentInfo(Class<?> clazz){        if(clazz.isAnnotationPresent(Persion.class)){            Persion annotation = (Persion)clazz.getAnnotation(Persion.class);            System.out.println(annotation);            System.out.println(annotation.age());            System.out.println(annotation.name());            String[] hobby = annotation.hobby();            for(String str : hobby){                System.out.println(str);            }        }        Field[] fields = clazz.getDeclaredFields();        for(Field field :fields){            System.out.println("fieldName=" + field.toString());            if(field.isAnnotationPresent(StudentGender.class)){                StudentGender annotation = (StudentGender)field.getAnnotation(StudentGender.class);                System.out.println(annotation);                System.out.println(annotation.gender());            }        }    }}

定义测试类：

package com.zcx.annotation;public class Test {    /**     * @param args     */    public static void main(String[] args) {        // TODO Auto-generated method stub        AnnotationProcessor.getStudentInfo(Student.class);    }}