天天看点

Spring(二)注释详解(@Target,@Retention,@Documented)

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

1、元注解(meta-annotation):

         元注解的作用就是负责注解其他注解,Java5定义了元注解类型,他们被用来提供对其它annotation类型做说明。

  • @Target
  • @Retention
  • @Documented

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

1.1、@Target(用于描述注解的适用范围 {被描述的注解可以用在什么地方})

              @Target说明了Annotation所修饰的对象范围:Annotation可用于 packages、type(类、接口、枚举、Annotation类型)、类型成员(方法、构造方法、成员变量、枚举值)、方法参数和本地变量(如循环变量、catch参数)。

           取值(ElementType):  

             ElementType.CONSTRUCTOR:用于描述构造器。

             ElementType.FLELD:用于描述域

             ElementType.LOCAL_VARIABLE:用于描述局部变量

             ElementType.METHOD:用于描述方法

             ElementType.PACKAGE:用于描述包

             ElementType.PARAMETER:用于描述参数

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

    使用示例:

@Target({ ElementType.PARAMETER, ElementType.METHOD })
public @interface Log
{
  
}
           

@Retention(表示需要在什么级别保存该注释信息,用于描述注解的声明周期{被描述的注解在什么范围内有效})

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

            取值(RetentionPoicy):

                    RetentionPoicy.SOURCE:在源文件中有效(即源文件保留)

                    RetentionPoicy.CLASS:在class文件中有效(即class保留)

                    RetentionPoicy.RUNTIME:在运行时有效(即运行时保留)

Retention meta-annotation类型有唯一的value作为成员,它的取值来自java.lang.annotation.RetentionPolicy的枚举类型值。具体实例如下:

@Target({ ElementType.PARAMETER, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
public @interface Log
{
   
}
           

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

@Documented(用于描述其他类型的annotation应该被做为被标注的程序成员的公告Api):

          @Documented 可以被例如 javadoc此类的工具文档化,Documented是一个标注注解,没有成员

@Target({ ElementType.PARAMETER, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Log
{
   
}
           

继续阅读