23 - Java 注解

• 从 Java 5 开始出现
• Annotaticm 能被用来为程序元素（ 类、方法、成员变量等）设置元数据
• 所有注解都隐式继承了 Annotation java.lang.annotation.Annotation 接口

• @Override：限定重写父类方法
• @Deprecated：标示已过时（与文档注释中的 @deprecated 标记的作用基本相同）
• @SuppressWarnings("变量值") ：抑制编译器警告（常见的变量值：unused, rawtypes, unchecked, serial, deprecation, all）
• @SafeVarargs： 抑制编译器“堆污染”警告（Java 7 新增）
• @FunctionalInterface： 函数式接口（接口中只有一个抽象方法）（Java 8 新增）

• @Target ：用于指定被修饰的注解能用于修饰哪些程序元素常量值封装在 ElementType 枚举类中：TYPE、FIELD、CONSTRUCTOR、METHOD、LOCAL_VARIABLE、PACKAGE、PARAMETER、ANNOTATION_TYPE
• @Retention：用于指定被修饰的注解可以保留多长时间常量值封装在 RetentionPolicy 枚举类中：SOURCE、CLASS（默认值）、RUNTIME
• @Documented：其修饰的注解会保存到 API 文档中
• @Inherited：其修饰的注解可以被子类所继承

• Annotation 中的属性以无参数的抽象方法的形式来定义
• 属性的类型只能是基本类型、String、Class、annotation、枚举及这些类型一维数组
• 在定义 Annotation 的属性时可以使用 default 为其指定默认值
• 使用带属性的注解时，必须为该注解的所有没有默认值的属性指定值
• 对于 Annotation 中变量名为 value属性，在使用该注解时可以直接在该注解后的括号里指定 value 属性的值，无须使用“value = 变量值”的形式

public @interface MyTag1 {
    String name();
    int age();
}
// 使用
@MyTag1(name="xx", age=6)
public @interface MyTag2 {
    // 使用 default 为两个成员变量指定初始值
    String name() default "admin";
    int age() default 17;
}
// 使用
@MyTag2
// 获取程序元素上的注解 @MyTag2 的成员变量的值
程序元素.getAnnotation(MyTag2.Class).成员变量名()

• 只能提取使用了@Retention(RetentionPolicy.RUNTIME) 修饰的注解
• AnnotatedElement 接口是所有程序元素（Class、Constructor、Field、Method、Package ） 的父接口
• AnnotatedElement 接口中的方法

• 注解处理工具 APT（Annotation Processing Tool）

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

@Target(ElementType.METHOD)
public @interface MyMethodAnnotation {
    // 注解内容
}

• SOURCE：注解只在源代码中存在，编译成字节码文件时会被丢弃。这种注解通常用于标记，对代码的运行没有影响。
• CLASS：注解在源代码和字节码文件中都存在，但在运行时不会被加载到JVM中。这是默认的保留策略。
• RUNTIME：注解在源代码、字节码文件中存在，并且在运行时可以被加载到JVM中，因此可以通过反射机制读取注解的信息。

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

@Retention(RetentionPolicy.RUNTIME)
public @interface MyRuntimeAnnotation {
    // 注解内容
}

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 MyMethodRuntimeAnnotation {
    String value() default "default value";
}

public class MyClass {

    @MyMethodRuntimeAnnotation(value = "Test method")
    public void myMethod() {
        // 方法实现
    }
}

import java.lang.reflect.Method;

public class AnnotationTest {
    public static void main(String[] args) throws Exception {
        Method method = MyClass.class.getMethod("myMethod");
        if (method.isAnnotationPresent(MyMethodRuntimeAnnotation.class)) {
            MyMethodRuntimeAnnotation annotation = method.getAnnotation(MyMethodRuntimeAnnotation.class);
            System.out.println("Annotation value: " + annotation.value());
        }
    }
}