1.1 注解的意义
注解本身没有任何意义,单独的注解就是一种注释,他需要结合其他如反射、插桩等技术才有意义。
Java 注解(Annotation)又称 Java 标注,是 JDK1.5 引入的一种注释机制。是元数据的一种形式,提供有关于程序但不属于程序本身的数据。注解对它们注解的代码的操作没有直接影响。
1.2 元注解
在定义注解时,注解类也能够使用其他的注解声明。对注解类型进行注解的注解类,我们称之为 meta-annotation(元注解)。
声明的注解允许作用于哪些节点使用@Target声明;保留级别由@Retention 声明。
其中保留级别如下:
RetentionPolicy.SOURCE:标记的注解仅保留在源级别中,并被编译器忽略。
RetentionPolicy.CLASS:标记的注解在编译时由编译器保留,但 Java 虚拟机(JVM)会忽略。
RetentionPolicy.RUNTIME:标记的注解由 JVM 保留,因此运行时环境可以使用它。
SOURCE < CLASS < RUNTIME,即CLASS包含了SOURCE,RUNTIME包含SOURCE、CLASS。
一般的,我们在定义自定义注解时,需要指定的元注解有两个 :
@Target
注解标记另一个注解,以限制可以应用注解的 Java 元素类型。目标注解指定以下元素类型之一作为其值:
-
ElementType.ANNOTATION_TYPE 可以应用于注解类型。
-
ElementType.CONSTRUCTOR 可以应用于构造函数。
-
ElementType.FIELD 可以应用于字段或属性。
-
ElementType.LOCAL_VARIABLE 可以应用于局部变量。
-
ElementType.METHOD 可以应用于方法级注解。
-
ElementType.PACKAGE 可以应用于包声明。
-
ElementType.PARAMETER 可以应用于方法的参数。
-
ElementType.TYPE 可以应用于类的任何元素。
@Retention
注解指定标记注解的存储方式:
-
RetentionPolicy.SOURCE - 标记的注解仅保留在源级别中,并被编译器忽略。
-
RetentionPolicy.CLASS - 标记的注解在编译时由编译器保留,但 Java 虚拟机(JVM)会忽略。
-
RetentionPolicy.RUNTIME - 标记的注解由 JVM 保留,因此运行时环境可以使用它
另外还有@Documented 与 @Inherited 元注解,前者用于被javadoc工具提取成文档,后者表示允许子类 继承父类中定义的注解。
1.3 注解声明
Java中所有的注解,默认实现 Annotation 接口。
public interface Annotation {
boolean equals(Object obj);
int hashCode();
String toString();
Class<? extends Annotation> annotationType();
}
与声明一个"Class"不同的是,注解的声明使用 @interface 关键字。一个注解的声明如下:
/**
* @author Renzituo
* time: 2022/4/10 16:02
* desc: xxx
*/
//标识该注解的应用场景,此时为应用于类上
@Target(ElementType.TYPE)
//标识该注解的保留级别,此时为源码期
@Retention(RetentionPolicy.SOURCE)
public @interface MyAnnotation {