自定义注解的理解及应用

一、元注解

Java5.0定义的元注解：

@Target

 作用：描述该注解修饰的范围，
            可被用于 packages、types（类、接口、枚举、Annotation类型）、
            类型成员（方法、构造方法、成员变量、枚举值）、
            方法参数和本地变量（如循环变量、catch参数）。
            取值(ElementType)：

      CONSTRUCTOR:用于描述构造器；

       FIELD:用于描述域；

       LOCAL_VARIABLE:用于描述局部变量；

       METHOD:用于描述方法；

       PACKAGE:用于描述包；

       PARAMETER:用于描述参数；

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


@Retention
    作用：描述该注解的生命周期，表示在什么编译级别上保存该注解的信息。
    Annotation被保留的时间有长短：某些Annotation仅出现在源代码中，而被编译器丢弃；
    而另一些却被编译在class文件中；编译在class文件中的Annotation可能会被虚拟机忽略，而另一些在class被装载时将被    读取（请注意并不影响class的执行，因为Annotation与class在使用上是被分离的）
    
      取值（RetentionPoicy）：
      SOURCE:在源文件中有效（即源文件保留）
      CLASS:在class文件中有效（即class保留） 　　　　
      RUNTIME:在运行时有效（即运行时保留）


@Documented
        @Documented Annotation的作用是在生成javadoc文档的时候将该Annotation也写入到文档中


@Inherited

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

自定义注解

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

参数定义要点：

1. 只能用public或默认(default)这两个访问权修饰；
2. 参数成员只能用基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型和 String,Enum,Class,annotations等数据类型,以及这一些类型的数组；
3. 如果只有一个参数成员，建议参数名称设为value()；
4. 注解元素必须有确定的值，要么在定义注解的默认值中指定，要么在使用注解时指定，非基本类型的注解元素的值不可为null。因此, 使用空字符串或负数作为默认值是一种常用的做法。

例子

例：@Target(ElementType.TYPE)
1.ElementType.CONSTRUCTOR:用于描述构造器
2.ElementType.FIELD:用于描述域（类的成员变量）
3.ElementType.LOCAL_VARIABLE:用于描述局部变量（方法内部变量）
4.ElementType.METHOD:用于描述方法
5.ElementType.PACKAGE:用于描述包
6.ElementType.PARAMETER:用于描述参数
7.ElementType.TYPE:用于描述类、接口(包括注解类型) 或enum声明


例：@Retention(RetentionPolicy.RUNTIME)
1.RetentionPoicy.SOURCE:在源文件中有效（即源文件保留）
2.RetentionPoicy.CLASS:在class文件中有效（即class保留）
3.RetentionPoicy.RUNTIME:在运行时有效（即运行时保留）



/**
 *自定义注解MyAnnotation
 */
@Target(ElementType.TYPE) //目标对象是类型
@Retention(RetentionPolicy.RUNTIME) //保存至运行时
@Documented //生成javadoc文档时，该注解内容一起生成文档
@Inherited //该注解被子类继承
public @interface MyAnnotation {
    public String value() default ""; //当只有一个元素时，建议元素名定义为value(),这样使用时赋值可以省略"value="
    String name() default "devin"; //String
    int age() default 18; //int
    boolean isStudent() default true; //boolean
    String[] alias(); //数组
    enum Color {GREEN, BLUE, RED,} //枚举类型
    Color favoriteColor() default Color.GREEN; //枚举值
}