Java注解学习

发表于   |   分类于   |   阅读次数

元注解

元注解的作用就是负责注解其他的注解。Java(从Java5.0)中定义了4个标准的meta-annotation类型.

  1. @Target
  2. @Retention
  3. @Documented
  4. @Inherited

    @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声明
    1
    2
    3
    4
    5
    6
    7
    8
    /* 注解Table可以用于注解类、接口(包括注解类型)或者enum声明*/
    @Target(ElementType.TYPE)
    public @interface Table{
    }
    /* 仅可用于注解类的成员变量*/
    @Target(ElementType.FIELD)
    public @interface NoDBColumn{
    }

@Retention

@Retention定义了该Annotation被保留的时间长短:某些Annotation仅出现在源代码中,而被编译器丢弃;而另一些却被编译在class文件中;编译在class文件中的Annotation可能会被虚拟机忽略,而另一些在class被装载时将被读取（请注意并不影响class的执行,因为Annotation与class在使用上是被分离的）.使用这个meta-Annotation可以对 Annotation的“生命周期”限制.
作用：
表示需要在什么级别保存该注释信息，用于描述注解的生命周期（即：被描述的注解在什么范围内有效）

取值（RetentionPoicy）有：

  1. SOURCE:在源文件中有效（即源文件保留）:Annotation只保留在源代码中，编译器编译时，直接丢弃这种Annotation.
  2. CLASS:在class文件中有效（即class保留）:编译器把Annotation记录在class文件中。当运行Java程序时，JVM中不再保留该Annotation.
  3. RUNTIME:在运行时有效（即运行时保留）:编译器把Annotation记录在class文件中。当运行Java程序时，JVM会保留该Annotation，程序可以通过反射获取该Annotation的信息.
    Retention meta-annotation类型有唯一的value作为成员，它的取值来自java.lang.annotation.RetentionPolicy的枚举类型值。
    1
    2
    3
    4
    5
    6
    7
    8
    9
    /* Column注解的的RetentionPolicy的属性值是RUTIME,这样注解处理器可以通过反射，获取到该注解的属性值，从而去做一些运行时的逻辑处理*/
    @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;
    }

@Documented

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

@Inherited

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

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

自定义注解

使用@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. 以上所有类型的数组
    Annotation类型里面的参数该怎么设定:
    第一,只能用public或默认(default)这两个访问权修饰.例如,String value();这里把方法设为defaul默认类型；　 　
    第二,参数成员只能用基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型和 String,Enum,Class,annotations等数据类型,以及这一些类型的数组.例如,String value();这里的参数成员就为String;　　
    第三,如果只有一个参数成员,最好把参数名称设为”value”,后加小括号.

注解元素的默认值

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

1
2
3
4
5
6
7
8
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface FruitProvider {
  public int id() default -1;
  public String name() default "";
  public String address() default "";
}