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 {
// 参数传递,无默认值
String value();
// 参数传递,有默认值
int id() default 0;
}
@MyAnnotation("1")//如果只有value元素需要传值,则可以省略元素名
@MyAnnotation("1",id = 5555)//多个参数传值,则以key-value的形式传值
class Test {
}
1.4 注解的应用场景
1.4.1 SOURCE
RetentionPolicy.SOURCE ,作用于源码级别的注解,可提供给IDE语法检查、APT等场景使用。 在类中使用 SOURCE 级别的注解,其编译之后的class中会被丢弃。
1.4.1.1 IDE语法检查
在Android开发中, support-annotations 与 androidx.annotation) 中均有提供 @IntDef 注解,此注解的定义如下:
@Retention(SOURCE) //源码级别注解
@Target({ANNOTATION_TYPE})
public @interface IntDef {
int[] value() default {};
boolean flag() default false;
boolean open() default false;
}
此注解的意义在于能够取代枚举,实现如方法入参限制。
1.4.1.1.1 Android源码的应用场景:
1.4.1.1.2 个人开发的应用场景
public class AnnotationTest {
public static TestTime mTestTime;
public static int mTestTimeInt;
public static void main(String[] args) {
/**
* 限定参数只能是枚举类型TestTime
*/
setTime(TestTime.TODAY);
setTime2(TODAY);
setTime2(9999999);
}
public enum TestTime{
TODAY,TOMORROW;
}
@IntDef(value = {TODAY,TOMORROW})
@Target({ElementType.FIELD,ElementType.TYPE_PARAMETER})
@Retention(RetentionPolicy.SOURCE)
public @interface TestTimeInt{
}
/**
* @param testTime 指定参数类型为枚举类TestTime中的值
*/
public static void setTime(TestTime testTime){
mTestTime = testTime;
}
public static final int TODAY = 1;
public static final int TOMORROW = 2;
/**
* @param testTime 指定参数类型为int
*/
public static void setTime2(int testTime){
mTestTimeInt = testTime;
}
}
如以上代码所示,开发中会有使用枚举的场景,但是我们知道每一个枚举都是一个对象,而对象由对象头(Header)、实例数据(Instance Data)和对齐填充(Padding)组成,可占用几十个字节,这也是为什么我们常常会说使用枚举的内存消耗比较大的原因。
此时,我们可以采用常量的下方式来实现,:
public class AnnotationTest {
public static int mTestTimeInt;
public static void main(String[] args) {
setTime2(TODAY);
// 参数类型并没有错,但是并不是我们所想要的值
setTime2(9999999);
}
/**
* 以常量的形式来限定参数值
*/
public static final int TODAY = 1;
public static final int TOMORROW = 2;
/**
* @param testTime 指定参数类型为int
*/
public static void setTime2(int testTime){
mTestTimeInt = testTime;
}
}
但是,该方式存在缺陷,毕竟对于我们而言,我们只想接收int类型的TODAY/TOMORROW。 此时,注解@IntDef便派上了用场:
public class AnnotationTest {
// 限定了接收的值
@TestTimeInt
public static int mTestTimeInt;
public static void main(String[] args) {
setTime2(TODAY);
// 参数加上了注解,限定了参数值得来源,此时将不能再传入任意的int类型参数
setTime2(9999999);
}
@IntDef(value = {TODAY,TOMORROW})//限定了参数值来源
@Target({ElementType.FIELD,ElementType.PARAMETER})// 用于注解成员变量与参数
@Retention(RetentionPolicy.SOURCE)// 保留级别为源码期
public @interface TestTimeInt{
}
/**
* 以常量的形式来限定参数值
*/
public static final int TODAY = 1;
public static final int TOMORROW = 2;
/**
* 注解@TestTimeInt 限定了参数值的来源
*
* @param testTime 指定参数类型为int
*/
public static void setTime2(@TestTimeInt int testTime){
mTestTimeInt = testTime;
}
}
1.4.1.2 APT注解处理器
APT全称为:"Anotation Processor Tools",意为注解处理器。顾名思义,其用于处理注解。编写好的Java源文 件,需要经过 javac 的编译,翻译为虚拟机能够加载解析的字节码Class文件。注解处理器是 javac 自带的一个工 具,用来在编译时期扫描处理注解信息。你可以为某些注解注册自己的注解处理器。 注册的注解处理器由 javac 调起,并将注解信息传递给注解处理器进行处理。
注解处理器是对注解应用最为广泛的场景。在Glide、EventBus3、Butterknifer、Tinker、ARouter等等常用 框架中都有注解处理器的身影。但是你可能会发现,这些框架中对注解的定义并不是 SOURCE 级别,更多的是 CLASS 级别,别忘了:CLASS包含了SOURCE,RUNTIME包含SOURCE、CLASS。
1.4.2 CLASS
定义为 CLASS 的注解,会保留在class文件中,但是会被虚拟机忽略(即无法在运行期反射获取注解)。此时完全符合 此种注解的应用场景为字节码操作。如:AspectJ、热修复Roubust中应用此场景。
所谓字节码操作即为,直接修改字节码Class文件以达到修改代码执行逻辑的目的。
1.4.3 RUNTIME
注解保留至运行期,意味着我们能够在运行期间结合反射技术获取注解中的所有信息。