學習注解原理的理由
越來越多的流行Android庫中使用的注解,比如butterknife,EventBus,dagger2,okHttp3等里面也是使用了注解,減少了重復代碼的編寫,極大的方便我們快速開發,那么了解其內部的工作原理極其重要,而且如果我們不知道其中的原理,我們在使用過程中遇到的相關問題就會一頭霧水,難以解決,所以我決定寫一個注解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文件
@ClassAnnotationpublic class AnnotationClass { public AnnotationClass() { }}
發現我們@ClassAnnotation的注解還是存在的。
最后,我們使用RetentionPolicy.RUNTIME,新建
@Retention(RetentionPolicy.RUNTIME)@Target(ElementType.TYPE)public @interface RuntimeAnnotation { String value() default "RuntimeAnnotation";}
注解AnnotationClass,編譯,猜想一下,是不是一樣存在?
@RuntimeAnnotationpublic 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)技術在編譯期生產代碼