注解是放在 Java 源码的类、方法、字段、参数前的一种特殊“注释”

注释会被编译器直接忽略，注解则可以被编译器打包进入 class 文件，因此，注解是一种用作标注的“元数据”. 可以通过反射机制访问这些元数据

注解以 "@注释名" 在代码中存在，还可以添加一些参数值，比如 @SuppressWarnings(value="unchecked")

java 注解的主要作用之一，就是跟踪代码依赖性，实现替代配置文件功能。比较常见的是 Spring 等框架中的基于注解配置。

注解的作用

从 JVM 的角度看，注解本身对代码逻辑没有任何影响，如何使用注解完全由工具决定。

Java 的注解可以分为三类：

1. 第一类是由编译器使用的注解，例如：

• @Override：让编译器检查该方法是否正确地实现了覆写
• @SuppressWarnings：告诉编译器忽略此处代码产生的警告
• @Deprecated

都是定义在 java.lang 包中的

这类注解不会被编译进入.class 文件，它们在编译后就被编译器扔掉了 (SOURCE 类型的注解在编译期就被丢掉了)

2. 第二类是由工具处理.class 文件使用的注解

比如有些工具会在加载 class 的时候，对 class 做动态修改，实现一些特殊的功能。这类注解会被编译进入.class 文件，但加载结束后并不会存在于内存中。这类注解只被一些底层库使用，一般我们不必自己处理 (CLASS 类型的注解仅保存在 class 文件中，它们不会被加载进 JVM)

3. 第三类是在程序运行期能够读取的注解

它们在加载后一直存在于 JVM 中，这也是最常用的注解。例如，一个配置了 @PostConstruct 的方法会在调用构造方法后自动被调用（这是 Java 代码读取该注解实现的功能，JVM 并不会识别该注解）(RUNTIME 类型的注解会被加载进 JVM，并且在运行期可以被程序读取)

只有 RUNTIME 类型的注解不但要使用，还经常需要编写。

元注解

有一些注解可以修饰其他注解，这些注解就称为元注解（meta annotation）。Java 标准库已经定义了一些元注解，我们只需要使用元注解，通常不需要自己去编写元注解。

最常用的元注解是 @Target。使用 @Target 可以定义 Annotation 能够被应用于源码的哪些位置

• 类或接口：ElementType.TYPE；
• 字段：ElementType.FIELD；
• 方法：ElementType.METHOD；
• 构造方法：ElementType.CONSTRUCTOR；
• 方法参数：ElementType.PARAMETER。

@Target({
    ElementType.METHOD,
    ElementType.FIELD
})
@Retention(RetentionPolicy.RUNTIME)
public @interface Report {
    // 这个是注解的参数，不是方法
    String name() default "";
    int id() default -1;
    // 如果默认为 -1，代表不存在（类似于 indexOf）
    // 如果注解中只有一个参数，建议将参数命名为 value，如果为 value 的话，不用写 default，会默认设置 default
}

另一个重要的元注解 @Retention 定义了 Annotation 的生命周期：

• 仅编译期：RetentionPolicy.SOURCE；
• 仅 class 文件：RetentionPolicy.CLASS；
• 运行期：RetentionPolicy.RUNTIME。

还有 @Document(该注解将被包含在 javadoc 中)

@inherited(子类可以继承父类中的该注解)

如何使用注解

只讨论如何读取 RUNTIME 类型的注解。因为注解定义后也是一种 class，所有的注解都继承自 java.lang.annotation.Annotation，因此，读取注解，需要使用反射 API。

1.Java 提供的使用反射 API 读取 Annotation 的方法包括：

(1) 判断某个注解是否存在于 Class、Field、Method 或 Constructor：

• Class.isAnnotationPresent(Class)
• Field.isAnnotationPresent(Class)
• Method.isAnnotationPresent(Class)
• Constructor.isAnnotationPresent(Class)

(2) 使用反射 API 读取 Annotation：

• Class.getAnnotation(Class)
• Field.getAnnotation(Class)
• Method.getAnnotation(Class)
• Constructor.getAnnotation(Class)

使用反射 API 读取 Annotation 有两种方法。方法一是先判断 Annotation 是否存在，如果存在，就直接读取，第二种方法是直接读取 Annotation，如果 Annotation 不存在，将返回 null

读取方法、字段和构造方法的 Annotation 和 Class 类似。但要读取方法参数的 Annotation 就比较麻烦一点，因为方法参数本身可以看成一个数组，而每个参数又可以定义多个注解，所以，一次获取方法参数的所有注解就必须用一个二维数组来表示。例如，对于以下方法定义的注解：

public void hello(@NotNull @Range(max=5) String name, @NotNull String prefix) {
}
// 获取 Method 实例:
Method m = ...
// 获取所有参数的 Annotation:
Annotation[][] annos = m.getParameterAnnotations();
// 第一个参数（索引为 0）的所有 Annotation:
Annotation[] annosOfName = annos[0];
for (Annotation anno : annosOfName) {
    if (anno instanceof Range) { // @Range 注解
        Range r = (Range) anno;
    }
    if (anno instanceof NotNull) { // @NotNull 注解
        NotNull n = (NotNull) anno;
    }
}

2. 使用注解示例

注解如何使用，完全由程序自己决定。

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface Range {
    int min() default 0;
    int max() default 255;
}
public class Person {
@Range(min=1, max=20)
public String name;
<span class="hljs-meta">@Range(max=10)</span>
<span class="hljs-keyword">public</span> String city;

}

但是，定义了注解，本身对程序逻辑没有任何影响。我们必须自己编写代码来使用注解。这里，我们编写一个 Person 实例的检查方法，它可以检查 Person 实例的 String 字段长度是否满足 @Range 的定义:

void check(Person person) throws IllegalArgumentException, ReflectiveOperationException {
    // 遍历所有 Field:
    for (Field field : person.getClass().getFields()) {
        // 获取 Field 定义的 @Range:
        Range range = field.getAnnotation(Range.class);
        // 如果 @Range 存在:
        if (range != null) {
            // 获取 Field 的值:
            Object value = field.get(person);
            // 如果值是 String:
            if (value instanceof String) {
                String s = (String) value;
                // 判断值是否满足 @Range 的 min/max:
                if (s.length() < range.min() || s.length() > range.max()) {
                    throw new IllegalArgumentException("Invalid field:" + field.getName());
                }
            }
        }
    }
}

这样一来，我们通过 @Range 注解，配合 check() 方法，就可以完成 Person 实例的检查。注意检查逻辑完全是我们自己编写的，JVM 不会自动给注解添加任何额外的逻辑。