@Target元注解的使用

谁借莪１个温暖的怀抱￠ 2022-11-29 13:04 149阅读 0赞

### **一、@Target的用法** ###

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

package java.lang.annotation;
    @Documented
    @Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.ANNOTATION_TYPE)
    public @interface Target { 
        /** * Returns an array of the kinds of elements an annotation type * can be applied to. * @return an array of the kinds of elements an annotation type * can be applied to */
        ElementType[] value();
    }

**作用：用于描述注解的使用范围（即：被描述的注解可以用在什么地方）**

如下是Spring中@FeignClient中使用@Target的代码：

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

### 二、@Target的取值 ###

Target通过 java.lang.annotation.ElementType 来指定注解可使用范围的枚举集合

**我们看到java.lang.annotation.ElementType此枚举类声明了有哪些Java元素类型：**

package java.lang.annotation;
     
    /** * The constants of this enumerated type provide a simple classification of the * syntactic locations where annotations may appear in a Java program. These * constants are used in {@link Target java.lang.annotation.Target} * meta-annotations to specify where it is legal to write annotations of a * given type. * @author Joshua Bloch * @since 1.5 * @jls 9.6.4.1 @Target * @jls 4.1 The Kinds of Types and Values */
    public enum ElementType { 
        /** 类, 接口 (包括注释类型), 或 枚举 声明 */
        TYPE,
     
        /** 字段声明（包括枚举常量） */
        FIELD,
     
        /** 方法声明(Method declaration) */
        METHOD,
     
        /** 正式的参数声明 */
        PARAMETER,
     
        /** 构造函数声明 */
        CONSTRUCTOR,
     
        /** 局部变量声明 */
        LOCAL_VARIABLE,
     
        /** 注释类型声明 */
        ANNOTATION_TYPE,
     
        /** 包声明 */
        PACKAGE,
     
        /** * 类型参数声明 * * @since 1.8 */
        TYPE_PARAMETER,
     
        /** * 使用的类型 * * @since 1.8 */
        TYPE_USE
    }
    @Retention({ RetentionPolicy.Runtime}) 注解
    
    RetentionPolicy这个枚举类型的常量描述保留注释的各种策略，它们与元注释(@Retention)一起指定注释要保留多长时间
    
    package java.lang.annotation;
    /** * Annotation retention policy. The constants of this enumerated type * describe the various policies for retaining annotations. They are used * in conjunction with the {@link Retention} meta-annotation type to specify * how long annotations are to be retained. * * @author Joshua Bloch * @since 1.5 */
    public enum RetentionPolicy { 
        /** * 注释只在源代码级别保留，编译时被忽略 */
        SOURCE,
        /** * 注释将被编译器在类文件中记录 * 但在运行时不需要JVM保留。这是默认的 * 行为. */
        CLASS,
        /** *注释将被编译器记录在类文件中 *在运行时保留VM，因此可以反读。 * @see java.lang.reflect.AnnotatedElement */
        RUNTIME
    }

@Documented注解

Documented注解表明这个注释是由 javadoc记录的，在默认情况下也有类似的记录工具。 如果一个类型声明被注释了文档化，它的注释成为公共API的一部分。