Java 注解（Annotation）

最新推荐文章于 2022-03-27 15:44:37 发布

树》》》新时代码农

最新推荐文章于 2022-03-27 15:44:37 发布

阅读量94

点赞数

分类专栏： java修炼之路——java基础

java修炼之路——java基础专栏收录该内容

6 篇文章 0 订阅

订阅专栏

认识java注解

Java 注解（Annotation）又称 Java 标注，是 JDK5.0 引入的一种注释机制。
Java 语言中的类、方法、变量、参数和包等都可以被标注。
和 Javadoc 不同，Java 标注可以通过反射获取标注内容。
在编译器生成类文件时，标注可以被嵌入到字节码中。
Java 虚拟机可以保留标注内容，在运行时可以获取到标注内容。
支持自定义 Java 标注。

内置的注解

Java 定义了一套注解，共有 7 个，3 个在 java.lang 中，剩下 4 个在 java.lang.annotation 中。

作用在代码的注解是

@Override - 检查该方法是否是重写方法。如果发现其父类，或者是引用的接口中并没有该方法时，会报编译错误
@Deprecated - 标记过时方法。如果使用该方法，会报编译警告。
@SuppressWarnings - 指示编译器去忽略注解中声明的警告。

作用在其他注解的注解(或者说元注解)是:

@Retention - 标识这个注解怎么保存，是只在代码中，还是编入class文件中，或者是在运行时可以通过反射访问。
@Documented - 标记这些注解是否包含在用户文档中。
@Target - 标记这个注解应该是哪种 Java 成员。
@Inherited - 标记这个注解是继承于哪个注解类(默认注解并没有继承于任何子类)

从 Java 7 开始，额外添加了 3 个注解:

@SafeVarargs - Java 7 开始支持，忽略任何使用参数为泛型变量的方法或构造函数调用产生的警告。
@FunctionalInterface - Java 8 开始支持，标识一个匿名函数或函数式接口。
@Repeatable - Java 8 开始支持，标识某注解可以在同一个声明上使用多次。

Annotation 组成部分

Annotation.java

package java.lang.annotation;

/**
 *由所有注释类型扩展的公共接口。请注意，手动扩展该接口的接口不会定义注释类型。
 *另请注意，此接口本身并不定义注释类型。有关注释类型的更多信息，
 */
public interface Annotation {
   
    boolean equals(Object obj);

    int hashCode();

    String toString();

    Class<? extends Annotation> annotationType();
}

ElementType.java

package java.lang.annotation;

/**
	此枚举类型的常量提供对Java程序中可能出现注释的句法位置的简单分类。
	这些常量用于{@link Target java.lang.annotation.Target}元注释中
	，以指定在何处编写给定类型的注释是合法的。 <p>可能出现注释的语法
	位置分为<em>声明上下文<em>和<em>类型上下文<em>，其中<em>声明上
	下文用于声明，而<em>类型上下文<em>注释用于声明和表达式中使用的类型
	。 <p>常量{@link ANNOTATION_TYPE}，{@link CONSTRUCTOR}，{@link FIELD}
	，{@link LOCAL_VARIABLE}，{@link METHOD}，{@link PACKAGE}，
	{@link PARAMETER}，{@link TYPE}和{@link TYPE_PARAMETER}对应于
	JLS 9.6.4.1中的声明上下文。 <p>例如，注释类型为
	{@code @Target（ElementType.FIELD）}的注释只能写为字段声明的修饰符
	。 <p>常量{@link TYPE_USE}对应于JLS 4.11中的15个类型上下文
	，以及两个声明上下文：类型声明（包括注释类型声明）和类型参数声明。
	 <p>例如，注释类型可以使用{@code @Target（ElementType.TYPE_USE）}
	 进行元注释的注释可以写在字段的类型上（如果是嵌套的，也可以写在字段
	 的类型内，参数化或数组类型），也可能会作为类声明的修饰符出现。
	  <p> {@ code TYPE_USE}常量包含类型声明和类型参数声明，
	  以方便类型检查器的设计人员，这些检查器为注释类型提供了语义。
	  例如，如果注释类型{@code NonNull}用{@code @Target（ElementType.TYPE_USE）
	  }进行元注释，则可以将{@code @NonNull} {@code class C {...}}类型检查器表示{{code C}
	  类的所有变量都不为空，同时根据{@code @NonNull}是否出现在列表中，
	  仍允许其他类的变量为非null或非null。变量的声明。
 */
public enum ElementType {
   /* 类、接口（包括注释类型）或枚举声明  */
    TYPE,

   /* 字段声明（包括枚举常量）  */
    FIELD,

    /* 方法声明  */
    METHOD,

    /* 参数声明  */
    PARAMETER,

   /* 构造方法声明  */
    CONSTRUCTOR,

   /* 局部变量声明  */
    LOCAL_VARIABLE,

	 /* 注释类型声明  */
    ANNOTATION_TYPE,

    /* 包声明  */
    PACKAGE,

     /*类型参数声明 */
    TYPE_PARAMETER,

   /*使用类型 */
    TYPE_USE
}

RetentionPolicy.java

package java.lang.annotation;

/**
	注释保留策略。此枚举类型的常量描述了用于保留注释的各种策略。
	它们与{@link Retention}元注释类型一起使用，以指定将保留注释多长时间。
 */
public enum RetentionPolicy {
    /* Annotation信息仅存在于编译器处理期间，编译器处理完之后就没有该Annotation信息了  */
    SOURCE,

    /* 编译器将Annotation存储于类对应的.class文件中。默认行为  */
    CLASS,

    /* 编译器将Annotation存储于class文件中，并且可由JVM读入 */
    RUNTIME
}

说明：

Annotation 就是个接口。
每 1 个 Annotation 对象，都会有唯一的 RetentionPolicy 属性；和多个 ElementType 属性
ElementType 是 Enum 枚举类型，它用来指定 Annotation 的类型。
RetentionPolicy 是 Enum 枚举类型，它用来指定 Annotation 的策略。

自定义注解

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

说明：

@interface ：使用 @interface 定义注解时，意味着它实现了 java.lang.annotation.Annotation 接口，即该注解就是一个Annotation。定义 Annotation 时，@interface 是必须的。注意：它和我们通常的 implemented 实现接口的方法不同。Annotation 接口的实现细节都由编译器完成。通过 @interface 定义注解后，该注解不能继承其他的注解或接口。
@Documented：类和方法的 Annotation 在缺省情况下是不出现在 javadoc 中的。如果使用 @Documented 修饰该 Annotation，则表示它可以出现在 javadoc 中。定义 Annotation 时，@Documented 可有可无；若没有定义，则 Annotation 不会出现在 javadoc 中。
@Target(ElementType.TYPE)：就是来指定 Annotation 的类型属性。定义 Annotation 时，@Target 可有可无。若有 @Target，则该 Annotation 只能用于它所指定的地方；若没有 @Target，则该 Annotation 可以用于任何地方。
@Retention(RetentionPolicy.RUNTIME)：就是指定 Annotation 的策略属性。定义 Annotation 时，@Retention 可有可无。若没有 @Retention，则默认是 RetentionPolicy.CLASS。

Annotation 的作用（在反射中使用 Annotation）

在反射的 Class, Method, Field 等函数中，有许多于 Annotation 相关的接口。

这也意味着，我们可以在反射中解析并使用 Annotation。

import java.lang.annotation.Annotation;
import java.lang.annotation.Target;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Inherited;
import java.lang.reflect.Method;

/**
 * Annotation在反射函数中的使用示例
 */
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation {
    String[] value() default "unknown";
}

/**
 * Person类。它会使用MyAnnotation注解。
 */
class Person {
   
    /**
     * empty()方法同时被 "@Deprecated" 和 "@MyAnnotation(value={"a","b"})"所标注
     * (01) @Deprecated，意味着empty()方法，不再被建议使用
     * (02) @MyAnnotation, 意味着empty() 方法对应的MyAnnotation的value值是默认值"unknown"
     */
    @MyAnnotation
    @Deprecated
    public void empty(){
        System.out.println("\nempty");
    }
   
    /**
     * sombody() 被 @MyAnnotation(value={"girl","boy"}) 所标注，
     * @MyAnnotation(value={"girl","boy"}), 意味着MyAnnotation的value值是{"girl","boy"}
     */
    @MyAnnotation(value={"girl","boy"})
    public void somebody(String name, int age){
        System.out.println("\nsomebody: "+name+", "+age);
    }
}

public class AnnotationTest {

    public static void main(String[] args) throws Exception {
       
        // 新建Person
        Person person = new Person();
        // 获取Person的Class实例
        Class<Person> c = Person.class;
        // 获取 somebody() 方法的Method实例
        Method mSomebody = c.getMethod("somebody", new Class[]{String.class, int.class});
        // 执行该方法
        mSomebody.invoke(person, new Object[]{"lily", 18});
        iteratorAnnotations(mSomebody);
       

        // 获取 somebody() 方法的Method实例
        Method mEmpty = c.getMethod("empty", new Class[]{});
        // 执行该方法
        mEmpty.invoke(person, new Object[]{});        
        iteratorAnnotations(mEmpty);
    }
   
    public static void iteratorAnnotations(Method method) {

        // 判断 somebody() 方法是否包含MyAnnotation注解
        if(method.isAnnotationPresent(MyAnnotation.class)){
            // 获取该方法的MyAnnotation注解实例
            MyAnnotation myAnnotation = method.getAnnotation(MyAnnotation.class);
            // 获取 myAnnotation的值，并打印出来
            String[] values = myAnnotation.value();
            for (String str:values)
                System.out.printf(str+", ");
            System.out.println();
        }
       
        // 获取方法上的所有注解，并打印出来
        Annotation[] annotations = method.getAnnotations();
        for(Annotation annotation : annotations){
            System.out.println(annotation);
        }
    }
}

somebody: lily, 18
girl, boy,
@com.skywang.annotation.MyAnnotation(value=[girl, boy])

empty
unknown,
@com.skywang.annotation.MyAnnotation(value=[unknown])
@java.lang.Deprecated()

树》》》新时代码农

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
Java 注解（Annotation）

认识java注解Java 注解（Annotation）又称 Java 标注，是 JDK5.0 引入的一种注释机制。Java 语言中的类、方法、变量、参数和包等都可以被标注。和 Javadoc 不同，Java 标注可以通过反射获取标注内容。在编译器生成类文件时，标注可以被嵌入到字节码中。Java 虚拟机可以保留标注内容，在运行时可以获取到标注内容。支持自定义 Java 标注。...
复制链接

扫一扫

专栏目录