Java注解详解

1. 注解概述

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

2. 注解本质

• 通过编译与反编译查看public @interface AnnotationTest {}
• javac AnnotationTest.java
• javap AnnotationTest.class
• 输出：public interface AnnotationTest extends java.lang.annotation.Annotation {}

3. 有哪些注解

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

3.1 预定义注解

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

3.2 元注解(作用在其他注解的注解 )

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

3.3 作用范围（作用在类上，属性，方法，构造方法等）

@Target({
ElementType.TYPE,
ElementType.FIELD, 
ElementType.METHOD,
ElementType.PARAMETER, 
ElementType.CONSTRUCTOR, 
ElementType.LOCAL_VARIABLE})

3.4 运行范围（编译阶段，运行时阶段）

@Retention(RetentionPolicy.SOURCE)
@Retention(RetentionPolicy.RUNTIME)
@Retention(RetentionPolicy.ClASS)

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

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

3.6 自定义注解

1.格式：public @interface AnnotationTest {}
2.本质：public interface AnnotationTest extends java.lang.annotation.Annotation {}
3.属性返回值类型：基本数据类型，字符串，枚举，注解，数组

3.7 代码实现

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

/**
 * 注解
 * Java 注解（Annotation）又称 Java 标注，是 JDK5.0 引入的一种注释机制。
 * Java 语言中的类、方法、变量、参数和包等都可以被标注。
 * 和 Javadoc 不同，Java 标注可以通过反射获取标注内容。
 * 在编译器生成类文件时，标注可以被嵌入到字节码中。
 * Java 虚拟机可以保留标注内容，在运行时可以获取到标注内容 。
 * 当然它也支持自定义 Java 标注。
 *
 * 注解本质：
 * 通过编译与反编译查看public @interface AnnotationTest {}
 * javac AnnotationTest.java
 * javap AnnotationTest.class
 * 输出：public interface AnnotationTest extends java.lang.annotation.Annotation {}
 *
 * Java 定义了一套注解，共有 7 个，3 个在 java.lang 中，剩下 4 个在 java.lang.annotation 中。
 *
 * 1. 预定义注解
 *     @Override - 检查该方法是否是重写方法。如果发现其父类，或者是引用的接口中并没有该方法时，会报编译错误。
 *     @Deprecated - 标记过时方法。如果使用该方法，会报编译警告。
 *     @SuppressWarnings - 指示编译器去忽略注解中声明的警告。
 *
 * 2. 作用在其他注解的注解(或者说 元注解)是:
 *     @Retention - 标识这个注解怎么保存，是只在代码中，还是编入class文件中，或者是在运行时可以通过反射访问。
 *     @Documented - 标记这些注解是否包含在用户文档中。
 *     @Target - 标记这个注解应该是哪种 Java 成员。
 *     @Inherited - 标记这个注解是继承于哪个注解类(默认 注解并没有继承于任何子类)
 *
 *      作用范围（作用在类上，属性，方法，构造方法等）
 *     @Target({ElementType.TYPE, ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.CONSTRUCTOR, ElementType.LOCAL_VARIABLE})
 *
 *     运行范围（编译阶段，运行时阶段）
 *     @Retention(RetentionPolicy.SOURCE)
 *     @Retention(RetentionPolicy.RUNTIME)
 *     @Retention(RetentionPolicy.ClASS)
 *
 * 3. 从 Java 7 开始，额外添加了 3 个注解:
 *     @SafeVarargs - Java 7 开始支持，忽略任何使用参数为泛型变量的方法或构造函数调用产生的警告。
 *     @FunctionalInterface - Java 8 开始支持，标识一个匿名函数或函数式接口。
 *     @Repeatable - Java 8 开始支持，标识某注解可以在同一个声明上使用多次。
 *
 * 自定义注解
 * 1.格式：public @interface AnnotationTest {}
 * 2.本质：public interface AnnotationTest extends java.lang.annotation.Annotation {}
 * 3.属性：
 *   属性返回值类型：基本数据类型，字符串，枚举，注解，数组
 *
 * @author zrj
 * @version V1.0
 * @since 2020/11/29
 **/
@Target({ElementType.TYPE, ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.CONSTRUCTOR, ElementType.LOCAL_VARIABLE})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {

    String show() default "";

    int getInt() default 0;

    Ststus getEnum() default Ststus.ON;

    String[] getStrs() default {};

}

enum Ststus{
    ON,
    OFF;
}

使用注解

/**
 * 使用注解
 *
 * @author zrj
 * @version V1.0
 * @since 2020/11/29
 **/
@MyAnnotation(show = "ON")
public class AnnotationTest {

    @MyAnnotation(show = "OFF")
    public void AnnotationTest() {

    }
}

解析注解

import org.junit.Test;

import java.lang.annotation.Annotation;
import java.util.Arrays;

/**
 * 解析注解
 *
 * @author zrj
 * @version V1.0
 * @since 2020/11/29
 **/
public class ReflexAnnotationTest {

    @Test
    public void reflexAnno() {
        System.out.println( "------------解析注解------------" );
        // 获取Class对象
        Class<AnnotationTest> annotationTestClass = AnnotationTest.class;
        System.out.println( "获取类对象：" + annotationTestClass );

        // 获取所以类注解
        Annotation[] annotations = annotationTestClass.getAnnotations();
        Arrays.stream( annotations ).forEach( System.out::println );

        // 获取执行类注解
        MyAnnotation annotation = annotationTestClass.getAnnotation( MyAnnotation.class );
        System.out.println(annotation.show());

    }

}