Java自定义注解之元注解(meta-annotation)Target、Retention、Documented、Inherited介绍

元注解:

  元注解的作用就是负责注解其他(如:自定义)注解,用来对其它 annotation类型作说明。Java定义了4个标准的meta-annotation类型:

   1.@Target

   2.@Retention

   3.@Documented

   4.@Inherited

  这些类型和它们所支持的类在java.lang.annotation包中可以找到。下面我们看一下每个元注解的作用和相应分参数的使用说明。

@Target:说明了Annotation所修饰的对象范围作;用于描述注解的使用范围(即:被描述的注解可以用在什么地方)

  @Target注解可被用于:

  (1)packages、types(类、接口、枚举、Annotation类型)、

  (2)类型成员(方法、构造方法、成员变量、枚举值)、

  (3)方法参数和本地变量(如循环变量、catch参数)。

  (4)在Annotation类型的声明中使用了target可更加明晰其修饰的目标。  

  取值(ElementType)有:

   1.CONSTRUCTOR:用于描述构造器

   2.FIELD:用于描述域

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

   4.METHOD:用于描述方法

   5.PACKAGE:用于描述包
   6.PARAMETER:用于描述参数

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

使用实例:

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

@Target(ElementType.TYPE)

public @interface Test {

public String TestName() default "testName";

}

@Target(ElementType.FIELD)

public @interface NoDBColumn {

}

@Retention:定义了该Annotation被保留的时间长短,使用这个meta-Annotation可以对注解的“生命周期”限制,用于描述注解的生命周期(即:被描述的注解在什么范围内有效)

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

   取值(RetentionPoicy)有:

   1.SOURCE:这种类型的Annotations只在源代码级别保留,编译时就会被忽略

   2.CLASS:在c这种类型的Annotations编译时被保留,在class文件中存在,但JVM将会忽略

   3.RUNTIME:这种类型的Annotations将被JVM保留,所以他们能在运行时被JVM或其他使用反射机制的代码所读取和使用。请注意并不影响class的执行,因为Annotation与class在使用上是被分离的

使用实例:

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

@Target(ElementType.FIELD)

@Retention(RetentionPolicy.RUNTIME)
public @interface DbColumn {
public String name() default "fieldName";
public String setFuncName() default "setField";
public String getFuncName() default "getField";

public boolean defaultDBValue() default false;

}

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

Documented 注解表明这个注解应该被 javadoc工具记录,默认情况下javadoc是不包括注解的,但如果声明注解时指定了 @Documented,则它会被 javadoc 之类的工具处理, 所以注解类型信息也会被包括在生成的文档中。 

使用实例:

@Target(ElementType.FIELD)

@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface DbColumn {
public String name() default "fieldName";
public String setFuncName() default "setField";
public String getFuncName() default "getField"; public boolean defaultDBValue() default false;

}

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

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

  当@Inherited 注解类型标注的注解Retention是RetentionPolicy.RUNTIME,则反射API增强了这种继承性。如果我们使用java.lang.reflect去查询一个@Inherited 注解类型时,反射代码检查将展开工作:检查class和其父类,直到发现指定的注解类型被发现,或者到达类继承结构的顶层。

  实例代码:

@Inherited
public @interface MyParentObject { 
   boolean isInherited() default true;

   String doSomething() default "Do what?";

}

@MyParentObject
public Class MyChildObject {

}

正如你看到的,你不需要在实现类中定义接口方法. 因为使用 @Inherited标记,这些都自动继承了.

自定义注解:

  使用@interface自定义注解时,自动继承了java.lang.annotation.Annotation接口,由编译程序自动完成其他细节。在定义注解时,不能继承其他的注解或接口。@interface用来声明一个注解,其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称,返回值类型就是参数的类型(返回值类型只能是基本类型、Class、String、enum)。可以通过default来声明参数的默认值。

定义注解格式:

  1.所有基本数据类型(int,float,boolean,byte,double,char,long,short)

  2.String类型
  3.Class类型
  4.enum类型
  5.Annotation类型
  第一,只能用public或默认(default)这两个访问权修饰.例如,String value();这里把方法设为defaul默认类型;   
  第二,参数成员只能用基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型和 String,Enum,Class,annotations等数据类型,以及这一些类型的数组.例如,String value();这里的参数成员就为String;  

  6.以上所有类型的数组

  注解类型里面的参数该怎么设定:

  第三,如果只有一个参数成员,最好把参数名称设为"value",后加小括号.例:下面的例子FruitName注解就只有一个参数成员。

猜你喜欢

转载自blog.csdn.net/weixin_42315600/article/details/80630669