学习注解原理的理由
越来越多的Android库中使用的注解,比如butterknife,EventBus3,okHttp里面也是使用了注解,减少了重复代码的编写,极大的方便我们快速开发,那么了解其内部的工作原理极其重要,而且如果我们不知道其中的原理,我们在使用过程中遇到的相关问题就会一头雾水,难以解决,所以我决定写一个注解Annotation的系列文章,窥探注解之秘。
注解(Annotation)是什么?
Annotation是元数据的一种形式,向外提供程序的信息,但它本身并不是这个程序的一部分,它可以被添加到包,类,方法,变量中,并且可以在某个生命周期中(java源码中,编译期,Runtime)被反射获取。Annotation并不是直接影响它所注解的代码 。
简单来说,注解(Annotation) 为我们在代码中添加信息提供了一种形式化的方法,是我们可以在稍后某个时刻方便地使用这些数据(通过 解析注解 来使用这些数据)
注解(Annotation)用来做什么?
1.给编译器提供信息--例如提供给编译器探测错误和压制警告等等
2.编译期生成代码
3.运行期(Runtime)处理注解
自定义注解
新建一个java library的module,新建一个class
@Retention(RetentionPolicy.SOURCE)
@Target(ElementType.TYPE)
public @interface SourceAnnotation {
String value() default "SourceAnnotation";
}
先讲一下元注解的概念,用来注解注解类的注解就是元注解,java提供了五种元注解,分别是@Documented,@Inherited, @Repeatable, @Target, @Retention
@Documented 它代表着此注解的元素会被javadoc工具提取成文档
@Inherited 允许子类继承父类中的注解
@Repeatable Java SE8引入的注解,表示这个注解可以在同一处多次声明
@Target 是用来描述该注解标记哪一种类型在java源码中,它的取值可为:
ElementType.ANNOTATION_TYPE 可以使用在注解类型上
ElementType.CONSTRUCTOR 可以使用在构造方法上
ElementType.FIELD 可以使用在属性(成员变量)上
ElementType.LOCAL_VARIABLE 可以使用在局部变量上
ElementType.METHOD 可以使用在方法上
ElementType.PACKAGE 可以使用在包声明上
ElementType.PARAMETER 可以使用在方法参数上
ElementType.TYPE 可以使用在类中任何元素
@Retention代表这个注解的生命周期,可以存活到什么时期:
RetentionPolicy.SOURCE 存在在java源码中
RetentionPolicy.CLASS 存活到编译成Class中
RetentionPolicy.RUNTIME 存活到运行时期
接下来重点理解一下这个Rentention,我们新建一个AnnotationClass的类,然后用上面定义的SourceAnnotation去注解它
@SourceAnnotation()
public class AnnotationClass {
}
编译一下,
然后在build文件夹classes中查找到AnnotationClass.class文件查看
package com.example;
public class AnnotationClass {
public AnnotationClass() {
}
}
我们的注解@SourceAnnotation()已经不存在了,这个就是RetentionPolicy.SOURCE的作用,使注解仅存在与java源码中。
我接下来再定义一个注解,设置为RetentionPolicy.CLASS
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.TYPE)
public @interface ClassAnnotation {
public String value() default "ClassAnnotation";
}
同样,我们来注解一下AnnotationClass
@ClassAnnotation()
public class AnnotationClass {
}
编译,查找AnnotationClass.class文件
@ClassAnnotation
public class AnnotationClass {
public AnnotationClass() {
}
}
发现我们@ClassAnnotation的注解还是存在的。
最后,我们使用RetentionPolicy.RUNTIME,新建
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface RuntimeAnnotation {
String value() default "RuntimeAnnotation";
}
注解AnnotationClass,编译,猜想一下,是不是一样存在?
@RuntimeAnnotation
public class AnnotationClass {
public AnnotationClass() {
}
}
是的,同在编译成Class文件中可以查找到,那么RetentionPolicy.Runtime和RetentionPolicy.CLASS区别又在哪里呢?这涉及到Annotation的使用,我们上面提到,Annotation信息的获取是通过反射获取的,我们可以通过Class中getAnnotation的方法来获取接下来,我们来尝试获取AnnationClass类中的注解信息。
注解信息的获取
我们在AnnotationTest中,写一个Main方法,作为程序的入口,编写一下代码
public class AnnotationTest {
public static void main(String[] args){
Class annotationClass = AnnotationClass.class;
RuntimeAnnotation annotation = (RuntimeAnnotation) annotationClass.getAnnotation(RuntimeAnnotation.class);
String value = annotation.value();
System.out.println("value:"+value);
}
}
我们上面定义了RuntimeAnnotation注解的默认的值是"RuntimeAnnotion",运行一下
查看输出
确实打印了RuntimeAnnotion的值,说明运行时期获取到这个注解的值。接下来,我们获取一下ClassAnnotation这个注解的值,看能否获取得到,修改AnnotationClass的注解为@ClassAnnotation
@ClassAnnotation()
public class AnnotationClass {
}
修改main方法为
public class AnnotationTest {
public static void main(String[] args){
Class annotationClass = AnnotationClass.class;
// RuntimeAnnotation annotation = (RuntimeAnnotation) annotationClass.getAnnotation(RuntimeAnnotation.class);
ClassAnnotation annotation = (ClassAnnotation) annotationClass.getAnnotation(ClassAnnotation.class);
String value = annotation.value();
System.out.println("value:"+value);
}
}
如果获取得到话,应该打印出的是默认值"ClassAnnotation",我们运行一下,查看输出
我们发现报错了,而且报错的原因是在
String value = annotaion.value();
这一行报出空指针异常,也就是说我们获取ClassAnnotation这个注解不存在,我们之前看到过,在编译的class文件中,这个注解是存在的。所以这个就是RetentionPolicy.CLASS和RetentionPolicy.RUNTIME的区别,RetentionPolicy.CLASS的注解是不会存活到运行时期的,在运行时期要想通过反射获得注解,那么你定义这个注解的时候需要使用RetentionPolicy.RUNTIME。
理解注解的基本使用之后,接下来我们将利用ART(Annotation Processing Tool)技术在编译期生成代码。