注解的簡介
簡介
Annotations, a form of metadata, provide data about a program that is not part of the program itself. Annotations have no direct effect on the operation of the code they annotate.
注釋是元數(shù)據(jù)的一種形式蛙紫，為程序的元素（類表箭、方法、變量）提供一些說明茂附，但是不會對程序本身造成影響。
- Annotation 類似一種修飾符辙喂，用于修飾包锉矢、類型、構(gòu)造方法匕得、方法、成語變量巾表、參數(shù)的聲明語句汁掠。
- Annotation 是一個接口。通過反射來訪問annotation信息集币。根據(jù)獲取的信息來決定如何使用注解信息來做一些事情考阱。
- Annotation 不會對程序造成影響。
- Java預(yù)言解析器在工作的時候默認(rèn)是忽略這些annotation鞠苟，所以在JVM中"不起作用"乞榨，只有通過配套的工具才能對這些注解進(jìn)行訪問和處理。
Annotation的使用
- Annotation的聲明需要通過@interface這個關(guān)鍵字当娱。會繼承Annotation接口吃既。
- Annotation的方法必須聲明為無參數(shù)、無異常跨细。方法名代表成員變量名鹦倚，方法的返回值代表了成員變量的類型。而且返回值類型必須為基本數(shù)據(jù)類型冀惭、Class類型震叙、枚舉類型、String類型散休、Annotation類型或者由前面任意一種類型組成的一維數(shù)組媒楼。方法后面可以使用default和一個默認(rèn)數(shù)值來聲明一個成員變量的默認(rèn)值，null不能作為成員變量的默認(rèn)值溃槐。
- 注解中如果只有一個默認(rèn)屬性匣砖，可以直接使用value()函數(shù)，一個屬性也沒有的則表示該Annotation為Mark Annotation昏滴。
例如：
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Test {
String value();
}
直接使用@Test("demo")猴鲫，等同于@Test(value="demo")
添加默認(rèn)值：
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestDefault {
public String description() default "demo";
}
Annotation的作用
很多使用作為一種輔助途徑，應(yīng)用在軟件框架或工具中谣殊。這些工具類可以根據(jù)不同的Annotation心采取不同的處理拂共，具有"讓編譯器進(jìn)行編譯檢查的功能"
具體可分為以下三種作用：
- 標(biāo)記，告訴編譯器一些信息(RetentionPolicy.SOURCE)
- 運(yùn)行時動態(tài)處理姻几，如通過反射的信息獲取注解信息進(jìn)行操作(RetentionPolicy.RUNTIME)
- 編譯時動態(tài)處理宜狐，如生成代碼或XML(RetentionPolicy.CLASS)
分類
標(biāo)準(zhǔn)的Annotation
從1.5開始就自帶三張標(biāo)準(zhǔn)的Annotation類型：
- Override
它是一種marker類型的Annotation，用來標(biāo)注方法蛇捌，說明被它標(biāo)注的方法是重載了父類中的方法抚恒。如果我們使用了該注解到一個沒有覆蓋父類方法的方法時，編譯器就會提示一個編譯錯誤的警告络拌。 - Deprecated
它也是一種marker類型的Annotation俭驮。當(dāng)方法或者變量使用該注解時，編譯器就會提示該方法已經(jīng)廢棄春贸。 - SuppressWarnings
它不是marker類型的Annotation混萝。用戶告訴編譯器不要再對該類、方法或者成員變量進(jìn)行警告提示萍恕。
元Annotation
元Annotation是指用來定義Annotation的Annotation - @Retention
保留時間逸嘀，可為RetentionPolicy.SOURCE(源碼時)、RetentionPolicy.CLASS(編譯時)允粤、RetentionPolicy.RUNTIME(運(yùn)行時)崭倘，默認(rèn)為CLASS。如果值為RetentionPolicy.SOURCE那大多都是Mark Annotation类垫，例如:Override绳姨、Deprecated。SOURCE表示僅存在于源碼中阔挠，在class文件中不會包含飘庄。CLASS表示會在class文件中存在，但是運(yùn)行時無法獲取购撼。RUNTIME表示會在class文件中存在跪削，并且在運(yùn)行時可以通過反射獲取。 - @Target
用來標(biāo)記可進(jìn)行修飾哪些元素迂求，例如ElementType.TYPE碾盐、ElementType.METHOD、ElementType.CONSTRUCTOR揩局、ElementType.FIELD毫玖、ElementType.PARAMETER等，如果未指定則默認(rèn)為可修飾所有。 - @Inherited
子類是否可以繼承父類中的該注解付枫。它所標(biāo)注的Annotation將具有繼承性烹玉。 - @Documented
是否會保存到j(luò)avadoc文檔中。
自定義Annotation
在Android的獲取控件中都需要findViewById()來獲取阐滩，通過注解的來獲取到Id的值進(jìn)行綁定例如：
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface ViewInject{
int viewId();
}
注解聲明完后二打，可以定義一些控件來使用：
@ViewInject(viewId = R.id.test)
private TextView test;
Annotation解析
- 當(dāng)Java源代碼被編譯時，編譯器的一個插件annotation處理器則會處理這些annotation掂榔。
處理器可以產(chǎn)生報告信息继效，或者創(chuàng)建附加的Java源文件或資源。
如果annotation本身被加上了RententionPolicy的運(yùn)行時類装获，
則Java編譯器則會將annotation的元數(shù)據(jù)存儲到class文件中瑞信。然后Java虛擬機(jī)或其他的程序可以查找這些元數(shù)據(jù)并做相應(yīng)的處理。 - 除了annotation處理器可以處理annotation外穴豫，我們也可以使用反射來處理annotation凡简。Java SE 5有一個名為AnnotatedElement的接口，
Java的反射對象類Class,Constructor,Field,Method以及Package都實(shí)現(xiàn)了這個接口绩郎。
這個接口用來表示當(dāng)前運(yùn)行在Java虛擬機(jī)中的被加上了annotation的程序元素潘鲫。
通過這個接口可以使用反射讀取annotation。AnnotatedElement接口可以訪問被加上RUNTIME標(biāo)記的annotation肋杖，
相應(yīng)的方法有g(shù)etAnnotation,getAnnotations,isAnnotationPresent溉仑。
由于Annotation類型被編譯和存儲在二進(jìn)制文件中就像class一樣，
所以可以像查詢普通的Java對象一樣查詢這些方法返回的Annotation状植。
運(yùn)行時Annotation解析
該類是指@Retention為RUNTIME的Annotation浊竟。
該類型的解析其實(shí)本質(zhì)的使用反射。反射執(zhí)行的效率是很低的
如果不是必要津畸，應(yīng)當(dāng)盡量減少反射的使用振定，因?yàn)樗鼤蟠笸侠勰銘?yīng)用的執(zhí)行效率。
例如：
public static void viewInject(Activity activity){
Class<? extends Activity> obj=activity.getClass();
Field[] fields=obj.getDeclaredFields();//獲取聲明的字段
for (Field field :fields){
ViewInject viewInject=field.getAnnotation(ViewInject.class);
if(viewInject!=null){
int viewId=viewInject.viewId();
if(viewId!=-1){
try {
Method method=obj.getMethod("findViewById",int.class);
Object view=method.invoke(activity,viewId);
field.setAccessible(true);//設(shè)置屬性可以訪問
field.set(activity,view);
} catch (Exception e) {
e.printStackTrace();
}
}
}
}
}
在Android的開發(fā)中使用ButterKnife他也是使用到了注解
//聲明的保留時期為編譯時期
@Retention(CLASS) @Target(FIELD)
public @interface BindView {
/** View ID to which the field will be bound. */
@IdRes int value();
}
使用的是編譯類型的注解肉拓，這樣就不會通過反射來獲取數(shù)值后频，不會影響性能。
編譯類型注解的過程：
編譯類型注解的解析
- 該類型注解值是@Retention為CLASS的Annotation暖途，由APT(Annotaion Processing Tool)自動進(jìn)行解析卑惜。是在編譯時注入，所以不會像反射一樣影響效率問題驻售。
- 根據(jù)sun官方的解釋露久，APT（annotation processing tool）是一個命令行工具，
它對源代碼文件進(jìn)行檢測找出其中的annotation后欺栗，使用annotation processors來處理annotation毫痕。
而annotation processors使用了一套反射API并具備對JSR175規(guī)范的支持征峦。 - annotation processors處理annotation的基本過程如下：
- APT運(yùn)行annotation processors根據(jù)提供的源文件中的annotation生成源代碼文件和其它的文件（文件具體內(nèi)容由annotation processors的編寫者決定）
- 接著APT將生成的源代碼文件和提供的源文件進(jìn)行編譯生成類文件。
- APT在編譯時自動查找所有繼承自AbstractProcessor的類消请，然后調(diào)用他們的process方法去處理栏笆，這樣就擁有了在編譯過程中執(zhí)行代碼的能力
- 所以我們需要完成的工作：
- 自定義類繼承AbstractProcessor，重寫process方法梯啤。
- 注冊處理器竖伯，讓APT能夠檢測的到存哲。
- 但是在Android Studio死活提示找不到AbstractProcessor類因宇，這是因?yàn)樽⒔馐莏avase中javax包里面的，android.jar默認(rèn)是不包含的祟偷，所以會編譯報錯.
解決方法就是新建一個Module察滑，在選擇類型時將該Module的類型選為Java Library。
然后在該Module中創(chuàng)建就好了Processor就好了修肠，完美解決 - Android Studio中創(chuàng)建一個Android工程贺辰。
- 新建一個Module，然后選擇Java Library類型嵌施，并且讓app依賴該module
- 在annotations的module中創(chuàng)建注解類
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.CLASS)
public @interface AnnotationTest {
String value() default "";
}
- 創(chuàng)建自定義的Processor類
@SupportedAnnotationTypes("com.example.AnnotationTest")
@SupportedSourceVersion(SourceVersion.RELEASE_7)
public class TestProcessor extends AbstractProcessor {
@Override
public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
System.out.println("process");
for (TypeElement te : annotations) {
for (Element element : roundEnv.getElementsAnnotatedWith(te)) {
AnnotationTest annotation = element.getAnnotation(AnnotationTest.class);
String value = annotation.value();
System.out.println("type : " + value);
}
}
return true;
}
}
注意:@SupportedAnnotationTypes("com.charon.AnnotationTest")來指定要處理的注解類饲化。
@SupportedSourceVersion(SourceVersion.RELEASE_7)指定編譯的版本。這種通過注解指定編譯版本和類型的方式是從Java 1.7才有的吗伤。
對于之前的版本都是通過重寫AbstractProcessor中的方法來指定的吃靠。
- 注冊處理器
我們自定義了Processor那如何才能讓其生效呢?就是在annotations的java同級目錄新建resources/META-INF/services/javax.annotation.processing.Processor文件
然后在javax.annotation.processing.Processor文件中指定自定義的處理器，如:
com.example.TestProcessor - 在app中進(jìn)行使用
進(jìn)行Build會在控制臺看到輸出的信息足淆。
上面只是一個簡單的例子巢块，如果你想用編譯時注解去做一些更高級的事情，例如自動生成一些代碼巧号，那你可能就會用到如下幾個類庫:
- 以前使用android-apt族奢，Gradle plugin 2.2提供annotationProcessor來代替了android-apt，還是建議使用官方的
As of the Android Gradle plugin version 2.2, all functionality that was previously provided by android-apt is now available in the Android plugin. This means that android-apt is officially obsolete
Here are the steps to migrate:
Make sure you are on the Android Gradle 2.2 plugin or newer.
Remove the android-apt plugin from your build scripts
Change all apt, androidTestApt and testApt dependencies to their new format:
dependencies {
compile 'com.google.dagger:dagger:2.0'
annotationProcessor 'com.google.dagger:dagger-compiler:2.0'
}
-
Google Auto的作用：
Google Auto的主要作用是注解Processor類丹鸿，并對其生成META-INF的配置信息越走，
可以讓你不用去寫META-INF這些配置文件，只要在自定義的Processor上面加上@AutoService(Processor.class) -
Square javapoet的作用：
javapoet:A Java API for generating .java source files.可以更方便的生成代碼靠欢，它可以幫助我們通過類調(diào)用的形式來生成代碼廊敌。
自定義編譯時注解
在自定義注解時，一般來說可能會建三個modules:
- app module:寫一些使用注解的android應(yīng)用邏輯掺涛。
- api module:定義一些可以在app中使用的注解庭敦。它會被app以及compiler使用。
- compiler module:定義Processor該module不會被包含到應(yīng)用中薪缆，它只會在構(gòu)建過程中被使用秧廉。在編譯的過程中它會生成一些java文件伞广，而這些java文件會被打包進(jìn)apk中。
我們可以在該module中使用auto以及javapoet疼电。
開始進(jìn)行配置： - compiler module中配置auto以及javapoet
dependencies {
compile fileTree(include: ['*.jar'], dir: 'libs')
//Google Auto的主要作用是注解Processor類嚼锄，并對其生成META-INF的配置信息，
//可以讓你不用去寫META-INF這些配置文件蔽豺，只要在自定義的Processor上面加上@AutoService(Processor.class)
compile 'com.google.auto.service:auto-service:1.0-rc2'
//可以更方便的生成代碼区丑，它可以幫助我們通過類調(diào)用的形式來生成代碼。
compile 'com.squareup:javapoet:1.7.0'
compile project(':apimodule')
}
- app module中g(shù)radle配置：
compile project(':compilermodule')
annotationProcessor project(':compilermodule')
- 在api module 中創(chuàng)建一個注解
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.TYPE)
public @interface Factory {
String id();
Class type();
}
- 在compiler module中自定義一個Processor
@AutoService(Processor.class)
public class MyProcessor extends AbstractProcessor {
//初始化操作的方法修陡，RoundEnvironment會提供很多有用的工具類Elements沧侥、Types和Filer等。
@Override
public synchronized void init(ProcessingEnvironment processingEnv) {
super.init(processingEnv);
}
//這相當(dāng)于每個處理器的主函數(shù)main()魄鸦。在該方法中去掃描宴杀、評估、處理以及生成Java文件拾因。
@Override
public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
System.out.println("Hello Wolrd,Custom Processor");
return false;
}
//這里你必須指定旺罢，該注解器是注冊給哪個注解的
@Override
public Set<String> getSupportedAnnotationTypes() {
return super.getSupportedAnnotationTypes();
}
//用來指定你使用的java版本。通常這里會直接放回SourceVersion.latestSupported()
@Override
public SourceVersion getSupportedSourceVersion() {
return SourceVersion.latestSupported();
}
}
從jdk 1.7開始绢记，可以使用如下注解來代替getSupporedAnnotationTypes()和getSupportedSourceVersion()方法:
@SupportedSourceVersion(SourceVersion.latestSupported())
@SupportedAnnotationTypes({
// 合法注解全名的集合
})
