Java中的元注解

元注解：

　　元注解的作用就是负责注解其他注解。Java5.0定义了4个标准的meta-annotation类型，它们被用来提供对其它 annotation类型作说明。Java5.0定义的元注解：

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

一、 @Target

(1) 定义

package java.lang.annotation;

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Target {

    ElementType[] value();

}


//ElementType 定义

package java.lang.annotation;

public enum ElementType {
    /** Class, interface (including annotation type), or enum declaration */
    TYPE,

    /** Field declaration (includes enum constants) */
    FIELD,

    /** Method declaration */
    METHOD,

    /** Formal parameter declaration */
    PARAMETER,

    /** Constructor declaration */
    CONSTRUCTOR,

    /** Local variable declaration */
    LOCAL_VARIABLE,

    /** Annotation type declaration */
    ANNOTATION_TYPE,

    /** Package declaration */
    PACKAGE,

    /**
     * Type parameter declaration
     *
     * @since 1.8
     */
    TYPE_PARAMETER,

    /**
     * Use of a type
     *
     * @since 1.8
     */
    TYPE_USE
}

(2) 解析　　　

     @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声明

(3) 使用示例:

package com.lic.test;

import java.lang.annotation.ElementType;
import java.lang.annotation.Target;

@Target(ElementType.METHOD)
public @interface MyAnn {
}

二、@Retention

(1) 定义

package java.lang.annotation;

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Retention {
   
    RetentionPolicy value();
}

//RetentionPolicy 定义

package java.lang.annotation;

public enum RetentionPolicy {
    /**
     * Annotations are to be discarded by the compiler.
     */
    SOURCE,

    /**
     * Annotations are to be recorded in the class file by the compiler
     * but need not be retained by the VM at run time.  This is the default
     * behavior.
     */
    CLASS,

    /**
     * Annotations are to be recorded in the class file by the compiler and
     * retained by the VM at run time, so they may be read reflectively.
     *
     * @see java.lang.reflect.AnnotatedElement
     */
    RUNTIME
}

(2) 解析　

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

　　作用：表示需要在什么级别保存该注释信息，用于描述注解的生命周期（即：被描述的注解在什么范围内有效）

　取值（RetentionPoicy）

1. SOURCE: 在源文件中有效（即源文件保留）
2. CLASS: 在class文件中有效（即class保留）
3. RUNTIME: 在运行时有效（即运行时保留）

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

(3) 使用实例

package com.lic.test;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnn {
}

 

三、@Documented

(1) 定义

package java.lang.annotation;

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Documented {
}

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

 

四、@Inherited

(1) 定义

package java.lang.annotation;

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Inherited {
}

(2) 解析

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

　　注意：@Inherited annotation类型是被标注过的class的子类所继承。类并不从它所实现的接口继承annotation，方法并不从它所重载的方法继承annotation。(即: 在注解上使用@Inherited 表示该注解会被子类继承，注意，仅针对类，成员属性、方法并不受此注释的影响。)

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

 

自定义注解值获取示例:

//自定义注解(作用于类)
package com.lic.test;

import java.lang.annotation.*;

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface TypeAnn {

  String name() default "dafaultName";

  String age() default "15";

}


//自定义注解(作用于属性)

package com.lic.test;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface FieldAnn {

  String value() default "defaultValue";

}


//自定义注解使用

package com.lic.test;

@TypeAnn(name = "lic",age = "18")
public class AnnTest {

  @FieldAnn
  private String userName;

  public String getUserName() {
    return userName;
  }

  public void setUserName(String userName) {
    this.userName = userName;
  }
}


//测试

package com.lic.test;

import java.lang.reflect.Field;

public class Test {

  public static void main(String[] args) throws NoSuchFieldException {
    AnnTest annTest = new AnnTest();
    TypeAnn typeAnn = annTest.getClass().getAnnotation(TypeAnn.class);  //通过类对象获取到注解对象
    System.out.println(typeAnn.age());
    System.out.println(typeAnn.name());

    Field userName = annTest.getClass().getDeclaredField("userName");  //获取声明的属性
    FieldAnn annotation = userName.getAnnotation(FieldAnn.class);  //通过属性对象获取到注解对象
    System.out.println(annotation.value());

  }
}

 

参考播客: https://blog.csdn.net/yjclsx/article/details/52101922