天天看点

自定义注解(Annotation) 入门

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

元注解:

        元注解的作用就是负责注解其他注解。java5.0 定义了四个标准的 meta-annotation 类型,他们被用来提供对其他annotation 类型作说明,java5.0 定义的元注解:

  • @Target
  • @Retention
  • @Documented
  • @Inherited

这些类型和他们支持的类在 java.lang.annotation 包中可以找到;

    @Target:

           说明了Annotation所修饰的对象范围,Annotation 可以被用于 packages,types(类,接口,枚举,annotation类型)、类型成员(方法,构造方法,成员变量,枚举值)、方法参数和本地变量(如循环变量、catch参数)。在Annotation类型的声明中使用Target可更加明晰其修饰的目标。

            作用:用于描述注解的使用范围(即:被描述的注解可以用在什么地方)

            取值(ElementType)有:

  • CONSTRUCTOR:用于描述构造器
  • FILEID:用于描述字段声明包括枚举常量
  • LOCAL_VARIABLE:用于描述局部变量
  • METHOD:用于描述方法
  • PACKAGE:用于描述包
  • PARAMETER:用于描述参数
  • TYPE:用于描述类、接口(包括注解类型)或enum的声明

例子:

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

    @Retention:

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

     作用:表示需要在什么级别保存该注释信息,用于描述注解的生命周期(即描述该注解在什么范围内有效)

     取值(ElementType)有:

  • SOURCE:在源文件中有效(即源文件保留)
  • CLASS:在class文件中有效(即class保留)
  • RUNTIME:在运行是有效(即运行时保留)

Retention  meat-annotation 类型有唯一的的value作为成员,他的取值来自java.lang.annotation.RetentionPolicy的枚举类型值:

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

@Documented

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

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