Java注解
注解
注解的定义
Java 注解(Annotation)又称 Java 标注,是 JDK5.0 引入的一种注释机制。 注解是元数据的一种形式,提供有关于程序但不属于程序本身的数据。注解对它们注解的代码的操作没有直接影响。
注解的作用或意义是什么?
注解本身没有任何意义,单独的注解就是一种注释,他需要结合其他如反射、插桩等技术才有意义。
注解声明
Java中所有注解,默认实现Annotation
接口:
package java.lang.annotation;
public interface Annotation {
boolean equals(Object obj);
int hashCode();
String toString();
Class<? extends Annotation> annotationType();
}
与声明一个"Class"不同+,注解的声明使用@interface
关键字
public @interface Test {
}
元注解
在定义注解时,注解类也能够使用其他的注解声明。对注解类型进行注解的注解类,我们称之为 meta- annotation(元注解)。声明的注解允许作用于哪些节点使用
@Target
声明;保留级别由@Retention
声明
@Retention
保留级别如下:
-
RetentionPolicy.SOURCE
标记的注解仅保留在源码级别,并被编译器忽略
-
RententionPolicy.CLASS
标记的注解在编译器由编译器保留,但Java虚拟机(JVM)会忽略
-
RetentionPolicy.RUNTIME
标记的注解由 JVM 保留,因此运行时环境可以使用它。
@Target
-
ElementType.ANNOTATION_TYPE
可以应用于注解类型。
-
ElementType.CONSTRUCTOR
可以应用于构造函数。
-
ElementType.FIELD
可以应用于字段或属性。
-
ElementType.LOCAL_VARIABLE
可以应用于局部变量。
-
ElementType.METHOD
可以应用于方法级注解。
-
ElementType.PACKAGE
可以应用于包声明。
-
ElementType.PARAMETER
可以应用于方法的参数。
-
ElementType.TYPE
可以应用于类的任何元素。
注解类型元素
在上文元注解中,允许在使用注解时传递参数。我们也能让自定义注解的主体包含 annotation type element (注解类型元素) 声明,它们看起来很像方法,可以定义可选的默认值。
@Target({ElementType.TYPE,ElementType.FIELD})
@Retention(RetentionPolicy.SOURCE)
public @interface Test {
String value(); //无默认值
int age() default 1; //有默认值
}
注解的应用场景
级别 | 技术 | 说明 |
---|---|---|
源码 | APT | 在编译期能够获取注解与注解声明的类包括类中所有成员信息,一般用于生成额外的辅助类 |
字节码 | 字节码增强 | 在编译出Class后,通过修改Class数据以实现修改代码逻辑目的。对于是否需要修改的区分或者修改为不同逻辑的判断可以使用注解。 |
运行时 | 反射 | 在程序运行期间,通过反射技术动态获取注解与其元素,从而完成不同的逻辑判定 |
根据@Retention
,注解可在下面几种场景中使用
Source
作用于源码级别的注解,可提供给IDE语法检查、APT等场景使用
APT注解处理器
APT全称为:“Anotation Processor Tools”,意为注解处理器。顾名思义,其用于处理注解。编写好的Java源文件,需要经过 javac 的编译,翻译为虚拟机能够加载解析的字节码Class文件。注解处理器是 javac 自带的一个工具,用来在编译时期扫描处理注解信息。你可以为某些注解注册自己的注解处理器。 注册的注解处理器由 javac调起,并将注解信息传递给注解处理器进行处理。
注解处理器是对注解应用最为广泛的场景。在Glide、EventBus3、Butterknifer、Tinker、ARouter等等常用框架中都有注解处理器的身影。但是你可能会发现,这些框架中对注解的定义并不是 SOURCE 级别,更多的是 CLASS 级别,别忘了:CLASS包含了SOURCE,RUNTIME包含SOURCE、CLASS。
IDE语法检查
在Android中我们需要设计接口以供使用者调用时,如出现需要对入参进行类型限定,如限定为资源ID、布局ID等类型参数,将参数类型直接给定int即可。然而,我们可以利用Android为我们提供的语法检查注解,来辅助进行更为直接的参数类型检查与提示。
CLASS
定义为 CLASS 的注解,会保留在class文件中,但是会被虚拟机忽略(即无法在运行期反射获取注解)。此时完全符合此种注解的应用场景为字节码操作。如:AspectJ、热修复Roubust中应用此场景。
RUNTIME
注解保留至运行期,意味着我们能够在运行期间结合反射技术获取注解中的所有信息。