注解
【已申请转载/引用授权】本文内容主要参考资料：[柏码，Java 注解] https://www.itbaima.cn/zh-CN/document/qrd0xfttsz32gpqg?segment=3#注解
注解本质上也是一个类，只不过它的用法比较特殊
注解可以被标注在任意地方，包括方法上、类名上、参数上、成员属性上、注解定义上等，就像注释一样，它相当于我们对某样东西的一个标记。而与注释不同的是，注解可以通过反射在运行时获取，注解也可以选择是否保留到运行时
预设注解
JDK预设了以下注解，作用于代码：
- @Override - 检查（仅仅是检查，不保留到运行时）该方法是否是重写方法。如果发现其父类，或者是引用的接口中并没有该方法时，会报编译错误
- @Deprecated - 标记过时方法。如果使用该方法，会报编译警告
- @SuppressWarnings - 指示编译器去忽略注解中声明的警告（仅仅编译器阶段，不保留到运行时）
- @FunctionalInterface - Java 8 开始支持，标识一个匿名函数或函数式接口
- @SafeVarargs - Java 7 开始支持，忽略任何使用参数为泛型变量的方法或构造函数调用产生的警告
元注解
元注解是作用于注解上的注解，用于我们编写自定义的注解：
- @Retention - 标识这个注解怎么保存，是只在代码中，还是编入class文件中，或者是在运行时可以通过反射访问
- @Documented - 标记这些注解是否包含在用户文档中
- @Target - 标记这个注解应该是哪种 Java 成员
- @Inherited - 标记这个注解是继承于哪个注解类(默认注解并没有继承于任何子类)
- @Repeatable - Java 8 开始支持，标识某注解可以在同一个声明上使用多次
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface Override {
}
该注解由 @Target 限定为只能作用于方法上，ElementType是一个枚举类型，用于表示此枚举的作用域，一个注解可以有很多个作用域。@Retention 表示此注解的保存策略，这里定义为只在代码中。一般情况下，自定义的注解需要定义1个 @Retention和 1~n 个@Target
注解的使用
注解的成员变量以“无形参的方法”形式来声明，其方法名定义了成员变量名，返回值定义了成员变量的类型
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface Test {String value();
}
当注解只有一个属性时，可以将该属性命名为value。此时，使用注解时可以直接传入属性值，而无需指定属性名（如@Test("magicshushu")）
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface Test {String test();
}
public class Main {@Test(test = "")public static void main(String[] args) {}
}
当属性不叫value，或注解有多个属性时，使用注解必须指明属性名（如@Test(test = "")）
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface Test {String value() default "magicShushu";
}
可以在定义属性时使用default关键字为其指定默认值（如String value() default "magicShushu";）。当属性有默认值时，使用该注解时可以不为该属性赋值
当属性为数组，我们在使用注解传参时，如果数组里面只有一个内容，我们可以直接传入一个值，而不是创建一个数组：
@Test("value1")
public static void main(String[] args) {}
@Test({"value1", "value2"}) //多个值时就使用花括号括起来
public static void main(String[] args) {}
反射获取注解
获取类上的注解
public static void main(String[] args) {Class<Student> clazz = Student.class;for (Annotation annotation : clazz.getAnnotations()) {System.out.println(annotation.annotationType()); //获取类型System.out.println(annotation instanceof Test); //直接判断是否为TestTest test = (Test) annotation;System.out.println(test.value()); //获取我们在注解中写入的内容}
}
- 首先通过 类名.class 获取该类的 Class 对象
- 调用 Class 对象的 getAnnotations() 方法，返回一个注解数组（Annotation[]），遍历它即可获得所有注解
- 在遍历中，可以通过 annotation.annotationType() 获取注解的具体类型
- 可以通过 instanceof 关键字直接判断注解是否为特定类型（如 Test ）
- 将注解强制转换为具体类型后，即可调用其属性方法（如 test.value()）来获取注解中定义的值
获取方法上的注解
public static void main(String[] args) throws NoSuchMethodException {Class<Student> clazz = Student.class;for (Annotation annotation : clazz.getMethod("test").getAnnotations()) {System.out.println(annotation.annotationType()); //获取类型System.out.println(annotation instanceof Test); //直接判断是否为TestTest test = (Test) annotation;System.out.println(test.value()); //获取我们在注解中写入的内容}
}
基本流程与获取类注解相同，区别在于需要先通过 Class 对象的 getMethod("方法名") 方法获取目标方法的 Method 对象。然后对 Method 对象调用 getAnnotations() 方法，后续步骤同上
不仅限于类和方法，对于字段（Field）同样可以使用 getAnnotations() 方法来获取其标记的注解