Java复习（注解）

Java复习（注解）(学习于B站尚硅谷:链接)

注解内容

• 注解（Annotation）概述
• 常见的Annotation示例
• 自定义Annotation
• JDK中的元注解
• 利用反射获取注解信息（在反射部分涉及）
• JDK 8中注解的新特性

1、注解(Annotation)概述

从 JDK 5.0开始，Java增加了对元数据（MetaData）的支持，也就是Annotation（注解）

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

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

在JavaSE中，注解的使用目的比较简单，例如标记过时的功能，忽略警告等。在JavaEE/Android中注解占据了更重要的角色，例如用来配置应用程序的任何切面，代替JavaEE旧版中所遗留的繁冗代码和XML配置等。

未来的开发模型都时基于注解的，JPA是基于注解的，Spring2.5以上都是基于注解的，Hibernate3.X以后也是基于注解的，现在的Struts2有一部分也是基于注解的了，注解是一种趋势，一定程度上可以说：（重要）:框架 = 注解 + 反射 + 设计模式。

2、常见的Annotation示例

使用 Annotation 时要在其钱买你增加 @ 符号，并把该 Annotation 当成一个修饰符使用。用于修饰它支持的程序元素。（可以将 Annotation 与 static 静态修饰符相对比）

示例一：生成文档相关的注解

• @author：表明开发该类模块的作者，多个作者之间使用，分割
• @version：表明该类模块的版本
• @see：参考转向，也就是相关主题
• @since：从哪个版本开始增加的
• @param：从方法中某参数的说明，如果没有参数就不能写
• @return：对方法返回值的说明，如果方法的返回值类型时void就是不能写
• @exception：对方法可能抛出的异常进行说明，如果方法没有用throws显式抛出的异常就不能写在其中

其中@param、@return和@exception 者三个标记都是只用于方法的

@param 的格式要求：@param 形参名 形参类型 形参说明

@return 的格式要求：@return 返回值类型 返回值说明

@exception 的格式要求：@exception 异常类型 异常说明

@param 和 @exception 可以并列多个

示例二：在编译时进行格式检查（JDK内置的三个基本注解）

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

3、如何自定义注解，参照：@SuppressWarnings定义注解即可

注意：

• 定义新的 Annotation 类型使用 @interface 关键字
• 自定义注解自动继承了 Java.lang.annotation.Annotation 接口
• Annotation 的成员变量在 Annotation 定义中以无参数方法的形式来声明。其方法名和返回值定义了该成员的名字和类型。我们称为配置参数。类型只能是八种基本数据类型：String类型、Class类型、enum类型、Annotation类型，以上所有类型的数组。
• 可以在定义 Annotation 的成员变量时为其指定初始值，指定成员变量的初始值可使用 default 关键字。
• 如果只有一个参数成员，建议使用参数名为value。
• 如果定义在注解含有配置参数，那么使用时必须指定参数值，除非它有默认值。格式是“参数名 = 参数值”，如果只有一个参数成员，且名称为value，则可以省略“value = ”
• 没有参数定义的 Annotation 称为标记；包含成员变量的 Annotation 称为元数据 Annotation

注意：自定义注解必须配上注解的信息处理流程（使用反射）才有意义。

package com.zhang.annotationTest;

/**
 * 如何自定义注解，参照：@SuppressWarnings定义注解即可
 *      1、注解声明为：@interface
 *      2、要多个，则使用字符串数组
 *      3、内部定义成员，通常使用 value() 表示
 *      4、如果自定义注解没有成员变量，那么这个注解类就是标记
 *      5、可以使用default定义注解类的里成员变量的默认值
 *
 * @author ZPH
 * @create 2021-05-12 20:52
 */
public @interface MyAnnotation {
    String value() default "hello";
}

4、JDK 中的元注解：修饰其他注解的注解

（其中记住重要的两个注解@Retention指when，@target是指where）

元注解定义：JDK 的元注解用于修饰其他 Annotation 定义

JDK5.0 提供了4个标准的meta-annotation 类型，分别是：

• @Retention
• @target
• @Documented
• @Inherited

元数据：对现有数据的修饰

如：String name = “zhangsan”；

其中 String 就是对 name 修饰的元数据。

1、@Retention

只能用于修饰 Annotation 定义，用于指定该 Annotation 的生命周期，@Retention 包含一个 RetentionPolicy 类型的长远变量，使用 @Retention 时必须为该 value 成员变量指定值：

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

理解：这个是修饰注解的，指明这个注解能在==哪个生命周期（when：修饰这个注解可以在什么时候使用）==保留；

第一个是在源文件保留；

第二个是持续到源文件编译过后的class文件中保留，执行的时候不会加载，也就是不会进入内存；

第三个是持续到运行，也就是内存中，这种情况可以通过反射进行获取。

package com.zhang.annotationTest;

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

/**
 * 如何自定义注解，参照：@SuppressWarnings定义注解即可
 *      1、注解声明为：@interface
 *      2、要多个，则使用字符串数组
 *      3、内部定义成员，通常使用 value() 表示
 *      4、如果自定义注解没有成员变量，那么这个注解类就是标记
 *      5、可以使用default定义注解类的里成员变量的默认值
 * jdk 提供的4中元注解
 * 元注解：对现有的注解进行解释说明的注解
 * - Retention：指定所修饰的 Annotation 的生命周期：SOURCE\CLASS（默认行为）\RUNTIME
 *              只有声明为 RUNTIME 生命周期的注解，才能通过反射获取
 * - target
 * - Documented
 * - Inherited
 * @create 2021-05-12 20:52
 */
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
    String value() default "hello";
}

注意：如果想通过反射获取定义的注解需要两个条件：

1. 生命周期定义（Retention）需要为RetentionPolicy.RUNTIME
2. 得到已经定义了这个注解的类

2、@Target

用于修饰 Annotation 定义，用于指定被修饰的 Annotation 能用于修饰哪些程序元素。@Target 也包含一个名为 value 的成员变量。

取值（ElementTYpe）	设定注解的目标
CONSTRUCTOR	构造器
FIELD	作用域
LOCAL_VARIABLE	局部变量
METHOD	方法
PACKAGE	包
PARAMETER	参数
TYPE	类、接口（包括注解类型）或enum声明

理解：target 目标，就是这个修饰这个注解可以用在哪（where：修饰注解用在哪）

3、@Documented：被这个注解修饰的 Annotation，将被 javadoc 工具提取成文档。默认情况下，javadoc 是不包括注解的。

• 定义为 Documented 的注解必须设置 Retention 值为RUNTIME

4、@Inherited：修饰注解使得具有继承性，在类级别使用修饰过后的注解，会继承所修饰的全部注解

• 比如：如果把标有 @Inherited 注解的自定义的注解标注在类级别上，子类则可以继承父类类级别的注解
• 实际应用中，使用较少

package com.zhang.annotationTest;

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

import static java.lang.annotation.ElementType.*;

/**
 * 如何自定义注解，参照：@SuppressWarnings定义注解即可
 *      1、注解声明为：@interface
 *      2、要多个，则使用字符串数组
 *      3、内部定义成员，通常使用 value() 表示
 *      4、如果自定义注解没有成员变量，那么这个注解类就是标记
 *      5、可以使用default定义注解类的里成员变量的默认值
 *      6、自定义注解通常都会使用两个元注解 @Retention、@Target，也就是when（这个注解什么时候有效）、where（这个注解在哪里有效）
 *
 *  jdk 提供的4中元注解
 * 元注解：对现有的注解进行解释说明的注解（参考 @SuppressWarnings 镇压警告注解）
 * - Retention：（when）指定所修饰的 Annotation 的生命周期：SOURCE\CLASS（默认行为）\RUNTIME
 *              只有声明为 RUNTIME 生命周期的注解，才能通过反射获取
 * - target：（where）用于指定修饰的 Annotation 能用于哪些程序元素
 * ******以下出现频率较低******
 * - Documented：表示所有修饰的注解在被javadoc解析时，保留下来。
 * - Inherited：被它修饰的 Annotation 将具有继承新
 *
 * 通过反射获取注解的信息
 * @author ZPH
 * @create 2021-05-12 20:52
 */
//@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
public @interface MyAnnotation {
    String value() default "hello";
}

5、通过反射获取注解

package com.zhang.annotationTest;

import java.lang.annotation.Annotation;

/**
 * @author ZPH
 * @create 2021-05-13 14:42
 */
public class AnnotationTest1 {
    public static void main(String[] args) {
//        Class<MyAnnotation> aClass = MyAnnotation.class;
//        Annotation[] annotations = aClass.getAnnotations();
//        for (int i = 0; i < annotations.length; i++) {
//            System.out.println(annotations[i]);
//        }
        Class<A> aClass = A.class;
        Annotation[] annotations = aClass.getAnnotations();
        for (int i = 0; i < annotations.length; i++) {
            System.out.println(annotations[i]);
        }
        //继承了这个注解：@com.zhang.annotationTest.MyAnnotation(value=hi)
        //若注释继承注解@Inherited：@com.zhang.annotationTest.MyAnnotation(value=hi) 
        //  ?我将@Inherited注释，出来的结果居然一样？
    }
}

@MyAnnotation(value = "hi")
class A{
}

理解：反射可以拿到很多东西，类、父类、方法以及它的注解等等。

6、jdk 8 注解新特性：可重复注解、类型注解

可重复注解：（以前使用的注解类数组）

步骤：

1. 创建MyAnnotations类，参数的类型为 MyAnnotation 的value()数组
2. 在MyAnnotation上声明@@Repeatable，成员值为MyAnnotations.class
3. MyAnnotation 的Target 和Retention 和MyAnnotations等元注解（@Documented，@Inherited）一定要相同，否则报错

MyAnnotation：

package com.zhang.annotationTest;

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

import static java.lang.annotation.ElementType.*;

/**
 * 如何自定义注解，参照：@SuppressWarnings定义注解即可
 *      1、注解声明为：@interface
 *      2、要多个，则使用字符串数组
 *      3、内部定义成员，通常使用 value() 表示
 *      4、如果自定义注解没有成员变量，那么这个注解类就是标记
 *      5、可以使用default定义注解类的里成员变量的默认值
 *      6、自定义注解通常都会使用两个元注解 @Retention、@Target，也就是when（这个注解什么时候有效）、where（这个注解在哪里有效）
 *
 *  jdk 提供的4中元注解
 * 元注解：对现有的注解进行解释说明的注解（参考 @SuppressWarnings 镇压警告注解）
 * - Retention：（when）指定所修饰的 Annotation 的生命周期：SOURCE\CLASS（默认行为）\RUNTIME
 *              只有声明为 RUNTIME 生命周期的注解，才能通过反射获取
 * - target：（where）用于指定修饰的 Annotation 能用于哪些程序元素
 * ******以下出现频率较低******
 * - Documented：表示所有修饰的注解在被javadoc解析时，保留下来。
 * - Inherited：被它修饰的 Annotation 将具有继承新
 *
 * 通过反射获取注解的信息
 *
 * jdk 8 中注解的新特性：可重复注解、类型注解
 *      可重复注解：1、创建MyAnnotations类，参数的类型为 MyAnnotation 的value()数组
 *                2、在MyAnnotation上声明@@Repeatable，成员值为MyAnnotations.class
 *                3、MyAnnotation 的Target 和Retention 和MyAnnotations 相同
 * @author ZPH
 * @create 2021-05-12 20:52
 */
//@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
@Repeatable(MyAnnotations.class)
public @interface MyAnnotation {
    String value() default "hello";
}

MyAnnotations：

package com.zhang.annotationTest;

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

import static java.lang.annotation.ElementType.*;

/**
 * @author ZPH
 * @create 2021-05-13 15:05
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
public @interface MyAnnotations {
    MyAnnotation[] value();
}

类型注解：

JDK1.8之后，关于元注解@Target的参数类型ElementType枚举值多了两个：TYPE_PARAMETER，TYPE_USE。

在Java 8之前，注解只能是在声明的地方所使用，Java8开始，注解可以应用在任何地方。

• ElementType.TYPE_PARAMETER：表示该注解能写在类型变量的声明语句中（如：泛型声明）。
• ElementType.TYPE_USE：表示该注解能写在使用类型的任何语句中。

class Generic<@MyAnnotation T>{//修饰泛型的类型，需要元注解@Target中加入TYPE_USE，表明注解的where
    //以下修饰任何类型的语句中，需要元注解@Target中加入TYPE_USE，表明注解的where
    public void show() throws @MyAnnotation RuntimeException{
        ArrayList<@MyAnnotation String> list = new ArrayList<>();
        int s = (@MyAnnotation int)10l;
    }
}