注解的定義

Java 注解(Annotation)又稱 Java 標注，是 JDK1.5 引入的一種注釋機制。

注解是元數據的一種形式，提供有關于程序但不屬于程序本身的數據。注解對它們注解的代碼的操作沒有直接影響。

注解本身沒有任何意義，單獨的注解就是一種注釋，他需要結合其他如反射、插樁等技術才有意義。

如何定義一個注解

@Target({ElementType.TYPE})

@Retention(RetentionPolicy.SOURCE)

public @interface Example {

String value() default "xxx";

}

這里是注解的一個簡單的例子，在接口前面加上一個@，就能定義一個注解了。

在這個注解中還有一個value()的成員變量，其中我們為它賦了默認值“xxx”，如果沒有默認值，那么該注解使用的時候，就必須為它傳值。

注解上面還有兩個注解，我們將之稱為元注解。

元注解

元注解，即在定義注解時，注解類也能夠使用其他的注解聲明。這種對注解類型進行注解的注解類，我們稱之為 meta-annotation(元注解)。

聲明的注解允許作用于哪些節點使用@Target聲明，例如ElementType.FIELD允許在成員變量上使用，而@Target注解是一個一對多的關系，即我們所寫的注解可以在多個地方定義，在類上定義，在方法上定義，等等；

保留級別由@Retention 聲明。其中保留級別如下。

RetentionPolicy.SOURCE

標記的注解僅保留在源級別中，并被編譯器忽略。

RetentionPolicy.CLASS

標記的注解在編譯時由編譯器保留，但 Java 虛擬機(JVM)會忽略。

RetentionPolicy.RUNTIME

標記的注解由 JVM 保留，因此運行時環境可以使用它。

當我們使用@SOURCE聲明注解時候，@Example注解的保留級別為SOURSE，即保留到源碼階段。

@Example("123")

public class MainActivity extends AppCompatActivity {

@Override

protected void onCreate(Bundle savedInstanceState) {

super.onCreate(savedInstanceState);

}

}

通過ASM反編譯工具查看MainActivity.class字節碼，并沒有看到注解的存在，因為在編譯過程中，注解已經被抹除了

// class version 51.0 (51)

// access flags 0x21

這里并沒有看到注解的存在了

public class com/example/anatationtest/MainActivity extends androidx/appcompat/app/AppCompatActivity {

// compiled from: MainActivity.java

// access flags 0x1

public ()V

......

protected onCreate(Landroid/os/Bundle;)V

......

}

注解的應用場景

根據注解的保留級別不同，對注解的使用自然存在不同場景。由注解的三個不同保留級別可知，注解作用于：

源碼、字節碼與運行時可以產生不同的應用場景。

級別

技術

說明

源碼

APT

在編譯期能夠獲取注解與注解聲明的類包括類中所有成員信息，一般用于生成額外的輔助類

字節碼

字節碼增強

在編譯出Class后，通過修改Class數據以實現修改代碼邏輯目的。對于是否需要修改的區分或者修改為不同邏輯的判斷可以使用注解

運行時

反射

在程序運行期間，通過反射技術動態獲取注解與其元素，從而完成不同的邏輯判定

APT技術

APT技術，APT，全稱為Annotation Processor Tools ，即注解處理器

要定義一個注解處理器，首先要新建一個普通Java模塊，并在app模塊中依賴。

在其中新建一個注解處理器，繼承自AbstractProcessor，編譯器已經為我們在內部實現了注解的采集，我們只需要對注解進行處理就可以了。

@SupportedAnnotationTypes("com.example.anatationtest.Example")

public class ExampleProcessor extends AbstractProcessor {

@Override

public boolean process(Set extends TypeElement> set, RoundEnvironment roundEnvironment) {

Messager messager = processingEnv.getMessager();

messager.printMessage(Diagnostic.Kind.NOTE,"========這里是打印信息========");

return false;

}

}

正如Activity類需要在Manifest中注冊一樣，注解器也需要配置才可以生效。配置文件層級為compiler/main/resources/META-INF/services/javax.annotation.processing.Processor

其中配置文件內容為，即定義的注解處理器的路徑

com.example.compile.ExampleProcessor

注解處理程序運行在什時候

我們知道，一個.java文件要由javac編譯成.class文件，并交由虛擬機去運行。在這個過程中，javac會采集到所有的注解信息，并包裝成Element節點，然后交給注解處理程序。那么怎么證明這一點呢？

試著Make Project，可以在Build Output中的compileDebugJavaWithJavac Task中看到我們寫在代碼中的打印信息，說明javac編譯.java文件的階段調起了注解處理程序。

Android注解語法檢查

在Android中我們需要設計接口以供使用者調用時，如出現需要對入參進行類型限定，如限定為資源ID、布局ID等類型參數，將參數類型直接給定int即可。然而，我們可以利用Android為我們提供的語法檢查注解，來輔助進行更為直接的參數類型檢查與提示。

如參數限制為：圖片資源ID。這里利用了@Drawable 來限定入參為Drawable類型的int值

public Drawable getMyDrawable(@DrawableRes int id) {

return getDrawable(id);

}

在平時開發中假如有一個方法限制了入參的類型，那么我們可以使用枚舉來解決。

private Weekday currentDay;

enum Weekday {

SUNDAY,MONDAY

}

public void setCurrentDay(Weekday currentDay){

this.currentDay=currentDay;

}

但是通過ASM字節碼工具可以發現，枚舉其實是生成了對象，較int基本數據類型會比較占用內存

// access flags 0x4019

public final static enum Lcom/enjoy/ annotat ion/ intdef/Test$WeekDay; SUNDAY

// access flags 0x4019

public final static enum Lcom/ enjoy/ annotation/ intdef /Test$WeekDay; MONDAY

這時候就可以使用@IntDef注解來進行語法檢查，@IntDef是AndroidX為我們提供的一個元注解。由IDE來實現，在我們編寫代碼的時候進行檢查。

@WekDay

private static int mCurrentIntDay;

@IntDef({SUNDAY, MONDAY})

@Target({ElementType.FIELD, ElementType.PARAMETER})

@Retention(RetentionPolicy.SOURCE)

@interface WekDay { //注解

}

public static void setCurrentDay(@WekDay int currentDay) {

mCurrentIntDay = currentDay;

}

但是，語法檢查階段對于我們編譯是不會產生影響的。

字節碼增強技術

什么叫字節碼增強技術？就是在字節碼中寫代碼。平時我們是在.java文件中去編寫代碼，其有一定的格式，也正如.java一樣，.class文件也有一定的格式(數據按照特定的方式記錄與排列)。

QQ空間曾經發布的熱修復解決方案中利用Javaassist 庫實現向類的構造函數中插入一段代碼解決

CLASS_ISPREVERIFIED 問題。包括了Instant Run的實現以及參照Instant Run實現的熱修復美團Robus等等等等都利用到了插樁技術。

插樁就是將一段代碼插入到另一段代碼，或替換另一段代碼。字節碼插樁顧名思義就是在我們編寫的源碼編譯成字節碼(Class)后，在Android下生成dex之前修改Class文件，修改或者增強原有代碼邏輯的操作。

由于對于該技術也只是有所了解，因此不做更多贅述。如果大家感興趣可以自己去加強學習。

利用注解加反射實現findViewById

我們利用注解加反射來實現一個簡單的findViewById。

首先我們定義一個@InjectView的注解 ，里面包含一個@Idres int類型的成員變量，用來存放控件的id值。

由于程序需要在運行期間利用反射來獲取元素的注解和值，因此注解應聲明在Runtime階段執行

@Target(ElementType.FIELD)

@Retention(RetentionPolicy.RUNTIME)

public @interface InjectView {

@IdRes int value();

}

使用注解：

public class MainActivity extends AppCompatActivity {

@InjectView(R.id.tv_text)

TextView textView;

@Override

protected void onCreate(Bundle savedInstanceState) {

super.onCreate(savedInstanceState);

setContentView(R.layout.activity_main);

InjectUtil.injectView(this);

textView.setText("使用了@InjectView注解");

}

}

InjectViewUtil 處理工具類

public class InjectUtil {

public static void injectView(Activity activity) {

Class extends Activity> cls = activity.getClass();

//獲得成員變量

Field[] declaredFields = cls.getDeclaredFields();

for (Field declaredField : declaredFields) {

//判斷是否被@Inject注解

if (declaredField.isAnnotationPresent(InjectView.class)) {

InjectView annotation = declaredField.getAnnotation(InjectView.class);

//獲得注解的值

int id = annotation.value();

View view = activity.findViewById(id);

//反射設置屬性的值

declaredField.setAccessible(true);//設置訪問權限，允許操作private屬性

try {

declaredField.set(activity, view);

} catch (IllegalAccessException e) {

e.printStackTrace();

}

}

}

}

}

InjectViewUtil在處理時，先通過getClass拿到Activity的類對象，再使用getDeclaredFields拿到其成員變量，并通過if (declaredField.isAnnotationPresent(InjectView.class))

判斷是否被@InjectView注解過了，并進一步拿到id值，最后使用set方法設置回去。運行項目，觀察效果，TextView 對象已經獲取到了實例，并修改為了我們設置的text值。

這是ButterKnife早期的實現，但由于運行階段利用反射去處理注解，會影響運行時的性能，所以后面它是在編譯時對注解進行解析完成相關代碼的生成，即剛剛介紹的第一種，利用注解處理器去完成findViewById的過程，相關源碼大家感興趣的話可以去查閱。

關于java注解的知識本次就介紹到這~

じゃ、また