# Java SE —— 注解

# 1. 概述

Annotation 其实就是代码里的特殊标记, 这些标记可以在编译，类加载，运行时被读取，并执行相应的处理。通过使用 Annotation，程序员可以在不改变原有逻辑的情况下，在源文件中嵌入一些补充信息。代码分析工具、开发工具和部署工具可以通过这些补充信息进行验证或者进行部署。

Annotation 可以像修饰符一样被使用，可用于修饰包、类、构造器、方法、成员变量、参数、局部变量的声明, 这些信息被保存在 Annotation 的 “name=value” 对中。

# 2. 常见注解

# 2.1 生成文档相关的注解

@author：标明作者
@version：版本
@see：参考转向（相关主题）
@since：从哪个版本开始增加的
@param：对方法中某参数的说明，如果没有参数就不能写
@return：对方法返回值的说明，如果方法的返回值类型是void就不能写
@exception：对方法可能抛出的异常进行说明，如果方法没有用throws显式抛出的异常就不能写

其中：

@param @return 和 @exception 这三个标记都是只用于方法的。

@param和@exception可以并列多个。

# 2.2 在编译时进行格式检查（JDK内置的三个基本注解）

@Override：限定重写父类方法, 该注解只能用于方法
@Deprecated：用于表示所修饰的元素(类, 方法等)已过时。通常是因为所修饰的结构危险或存在更好的选择。
@SuppressWarnings：抑制编译器警告。

# 3. JDK 提供的4个元注解

JDK 的元 Annotation 用于修饰其他 Annotation 定义。

# 3.1 @Retention

只能用于修饰一个 Annotation 定义, 用于指定该 Annotation 的生命周期,

@Rentention 包含一个 RetentionPolicy 类型的成员变量, 使用 @Rentention 时必须为该 value 成员变量指定值:

RetentionPolicy.SOURCE：在源文件中有效(即源文件保留)，编译器直接丢弃这种策略的注释。
RetentionPolicy.CLASS：在class文件中有效(即class保留) ，当运行 Java 程序时, JVM 不会保留注解。这是默认值。
RetentionPolicy.RUNTIME：在运行时有效(即运行时保留)，当运行 Java 程序时, JVM 会保留注释。程序可以通过反射获取该注释。

# 3.2 @Target

用于修饰 Annotation 定义，用于指定被修饰的 Annotation 能用于修饰哪些程序元素。

@Target 也包含一个名为 value 的成员变量。

ElementType.TYPE：用于描述类、接口、注解或 enum 声明
ElementType.CONSTRUCTOR：用于描述构造器
ElementType.FIELD：用于描述域
ElementType.LOCAL_VARIABLE：用于描述局部变量
ElementType.METHOD：用于描述方法
ElementType.PACKAGE：用户描述包
ElementType.PARAMETER：用户描述参数

# 3.3 @Documented

用于指定被该元 Annotation 修饰的 Annotation 类将被 javadoc 工具提取成文档。

默认情况下，javadoc是不包括注解的。

# 3.4 @Inherited

被它修饰的 Annotation 将具有继承性。如果某个类使用了被 @Inherited 修饰的 Annotation, 则其子类将自动具有该注解。

# 4. 利用反射获取注解信息

JDK 5.0 在 java.lang.reflect 包下新增了 AnnotatedElement 接口, 该接口代表程序中可以接受注解的程序元素。

当一个 Annotation 类型被定义为==运行时 Annotation== 后，该注解才是运行时可见, 当 class 文件被载入时保存在 class 文件中的 Annotation 才会被虚拟机读取。

程序可以调用 AnnotatedElement对象的如下方法来访问 Annotation 信息：

# 5. 自定义注解

import java.lang.annotation.*;

/**
 * ① 关键字 @interface
 * ② 自定义注解自动继承了java.lang.annotation.Annotation 接口 (从 import 中可以看出来 )
 */
@Retention(RetentionPolicy.RUNTIME)  //当一个 Annotation 类型被定义为运行时 Annotation 后，该注解才是运行时可见, 当 class 文件被载入时保存在 class 文件中的 Annotation 才会被虚拟机读取。
@Target(ElementType.TYPE)  //表明这是一个类、接口、注解或 enum
@interface MyAnnotation {

    /**
     * ③ Annotation 的成员变量在 Annotation 定义中以无参数方法的形式来声明。其
     *      方法名和返回值定义了该成员的名字和类型。我们称为配置参数。
     *      类型只能是八种基本数据类型、String类型、Class类型、enum类型、Annotation类型、 以上所有类型的数组。
     * ④ 可以在定义 Annotation 的成员变量时为其指定初始值, 指定成员变量的初始 值可使用 default 关键字
     * ⑤ 如果只有一个参数成员，建议使用参数名为value
     */
    String value() default "Test";

}

/**
 * ⑥ 如果定义的注解含有配置参数，那么使用时必须指定参数值，除非它有默认值。
 *    格式是“参数名 = 参数值”，如果只有一个参数成员，且名称为value， 可以省略“value=”
 * ⑦ 没有成员定义的 Annotation 称为标记; 包含成员变量的 Annotation 称为元数据 Annotation
 */
@MyAnnotation(value = "测试")
public class Main {
    public static void main(String[] args) {
        Class clazz = Main.class;
        Annotation annotation = clazz.getAnnotation(MyAnnotation.class);
        MyAnnotation myAnnotation = (MyAnnotation)annotation;
        String info = myAnnotation.value();
        System.out.println(info);
    }
}

# 6. 上述 main() 方法读取注解信息详解

AnnotatedElement 接口可以读取注解信息：

而 Class 类实现了 AnnotatedElement 接口：

所以我们可以用当前类（Main）来获取标在它上面的注解，强制转化为对应的类型，然后就可以读取其中相应的信息了。

# 7. JDK8 中注解的新特性

# 7.1 改进一：可重复注解

# 7.1.1 比如 @Target 可以同时指定多个

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE,ElementType.CONSTRUCTOR,ElementType.METHOD}) 
@interface MyAnnotation {

# 7.1.2 JDK8 之前如何实现重复注解

创建一个新注解，成员是我们之前定义的注解组成的数组

public @interface MyAnnotations {
    MyAnnotation[] value();
}

然后在 Main 类上换成该注解

@MyAnnotations({@MyAnnotation(value = "测试1"),@MyAnnotation(value = "测试2")})
public class Main {
    public static void main(String[] args) {

这样实际上还是“非重复注解”。

# 7.1.3 JDK8 之后如何实现重复注解

需要一个 @Repeatable 注解，里面的值就填我们刚刚定义的 MyAnnotations.class（该注解称为注解容器）
```
@interface MyAnnotations {
    MyAnnotation[] value();
}
```
但是这个时候报错了：MyAnnotations 的生命周期比 MyAnnotation 短

延长MyAnnotations 的生命周期：

@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotations {
    MyAnnotation[] value();
}

这个时候又出现了新的报错：MyAnnotations 的@Target 必须是 MyAnnoation 的子集
- ==这里很奇怪，不应该是 MyAnnotations 的范围更广吗？==

增加 MyAnnotations 可以注解的地方：

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE,ElementType.CONSTRUCTOR})
@interface MyAnnotations {
    MyAnnotation[] value();
}

这样就不会报错了，而且可以使用 getAnnotationsByType() 方法获取：

@MyAnnotation("测试")
@MyAnnotation("测试2")
public class Main {
    public static void main(String[] args) {
        Class clazz = Main.class;
        Annotation[] annotations = clazz.getAnnotationsByType(MyAnnotation.class);
        System.out.println(annotations.length);
        for (Annotation annotation:annotations){
            String info =((MyAnnotation)annotation).value();
            System.out.println(info);
        }
    }
}

输出结果：
```
2
测试
测试2
```

# 7.2 改进二：可用于类型的注解

ElementType.TYPE_PARAMETER：表示该注解能写在类型变量的声明语句中(如:泛型声明)。

class Generic<@TypeDefine() U>{
   
}

@Target({ElementType.TYPE_PARAMETER})
@interface TypeDefine{

}

ElementType.TYPE_USE：表示该注解能写在使用类型的任何语句中。

class Generic{
    public void show(){
        ArrayList<@TypeDefine() String> list = new ArrayList<>();
        int num = (@TypeDefine int) 10L;
    }
}

@Target({ElementType.TYPE_USE})
@interface TypeDefine{

}

← Java SE —— 反射 Synchronized →