注解的定義

Java 注解（Annotation）又稱 Java 標(biāo)注，是 JDK1.5 引入的一種注釋機(jī)制。

注解是元數(shù)據(jù)的一種形式，提供有關(guān)于程序但不屬于程序本身的數(shù)據(jù)。注解對(duì)它們注解的代碼的操作沒有直接影響。
注解本身沒有任何意義，單獨(dú)的注解就是一種注釋，他需要結(jié)合其他如反射、插樁等技術(shù)才有意義。

如何定義一個(gè)注解

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.SOURCE)
public @interface Example {
    String value() default "xxx";
}

這里是注解的一個(gè)簡(jiǎn)單的例子，在接口前面加上一個(gè)@，就能定義一個(gè)注解了。
在這個(gè)注解中還有一個(gè)value()的成員變量，其中我們?yōu)樗x了默認(rèn)值“xxx”，如果沒有默認(rèn)值，那么該注解使用的時(shí)候，就必須為它傳值。

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

元注解

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

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

保留級(jí)別由@Retention 聲明。其中保留級(jí)別如下。

• RetentionPolicy.SOURCE
• 標(biāo)記的注解僅保留在源級(jí)別中，并被編譯器忽略。
• RetentionPolicy.CLASS
• 標(biāo)記的注解在編譯時(shí)由編譯器保留，但 Java 虛擬機(jī)(JVM)會(huì)忽略。
• RetentionPolicy.RUNTIME
• 標(biāo)記的注解由 JVM 保留，因此運(yùn)行時(shí)環(huán)境可以使用它。

當(dāng)我們使用@SOURCE聲明注解時(shí)候，@Example注解的保留級(jí)別為SOURSE，即保留到源碼階段。

@Example("123")
public class MainActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
    }
}

通過(guò)ASM反編譯工具查看MainActivity.class字節(jié)碼，并沒有看到注解的存在，因?yàn)樵诰幾g過(guò)程中，注解已經(jīng)被抹除了

// 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 <init>()V
  ......
  protected onCreate(Landroid/os/Bundle;)V
   ......
}

注解的應(yīng)用場(chǎng)景

根據(jù)注解的保留級(jí)別不同，對(duì)注解的使用自然存在不同場(chǎng)景。由注解的三個(gè)不同保留級(jí)別可知，注解作用于：
源碼、字節(jié)碼與運(yùn)行時(shí)可以產(chǎn)生不同的應(yīng)用場(chǎng)景。

APT技術(shù)

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

要定義一個(gè)注解處理器，首先要新建一個(gè)普通Java模塊，并在app模塊中依賴。
在其中新建一個(gè)注解處理器，繼承自AbstractProcessor，編譯器已經(jīng)為我們?cè)趦?nèi)部實(shí)現(xiàn)了注解的采集，我們只需要對(duì)注解進(jìn)行處理就可以了。

@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中注冊(cè)一樣，注解器也需要配置才可以生效。配置文件層級(jí)為compiler/main/resources/META-INF/services/javax.annotation.processing.Processor

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

com.example.compile.ExampleProcessor

注解處理程序運(yùn)行在什時(shí)候

我們知道，一個(gè).java文件要由javac編譯成.class文件，并交由虛擬機(jī)去運(yùn)行。在這個(gè)過(guò)程中，javac會(huì)采集到所有的注解信息，并包裝成Element節(jié)點(diǎn)，然后交給注解處理程序。那么怎么證明這一點(diǎn)呢？

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

Android注解語(yǔ)法檢查

在Android中我們需要設(shè)計(jì)接口以供使用者調(diào)用時(shí)，如出現(xiàn)需要對(duì)入?yún)⑦M(jìn)行類型限定，如限定為資源ID、布局ID等類型參數(shù)，將參數(shù)類型直接給定int即可。然而，我們可以利用Android為我們提供的語(yǔ)法檢查注解，來(lái)輔助進(jìn)行更為直接的參數(shù)類型檢查與提示。

如參數(shù)限制為：圖片資源ID。這里利用了@Drawable 來(lái)限定入?yún)镈rawable類型的int值

public Drawable getMyDrawable(@DrawableRes int id) {
       return getDrawable(id);
}

在平時(shí)開發(fā)中假如有一個(gè)方法限制了入?yún)⒌念愋?，那么我們可以使用枚舉來(lái)解決。

private Weekday currentDay;

    enum Weekday {
        SUNDAY,MONDAY
    }
    public void setCurrentDay(Weekday currentDay){
        this.currentDay=currentDay;
}

但是通過(guò)ASM字節(jié)碼工具可以發(fā)現(xiàn)，枚舉其實(shí)是生成了對(duì)象，較int基本數(shù)據(jù)類型會(huì)比較占用內(nèi)存

// 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

這時(shí)候就可以使用@IntDef注解來(lái)進(jìn)行語(yǔ)法檢查，@IntDef是AndroidX為我們提供的一個(gè)元注解。由IDE來(lái)實(shí)現(xiàn)，在我們編寫代碼的時(shí)候進(jìn)行檢查。

@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;
}

但是，語(yǔ)法檢查階段對(duì)于我們編譯是不會(huì)產(chǎn)生影響的。

字節(jié)碼增強(qiáng)技術(shù)

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

QQ空間曾經(jīng)發(fā)布的熱修復(fù)解決方案中利用Javaassist 庫(kù)實(shí)現(xiàn)向類的構(gòu)造函數(shù)中插入一段代碼解決
CLASS_ISPREVERIFIED 問(wèn)題。包括了Instant Run的實(shí)現(xiàn)以及參照Instant Run實(shí)現(xiàn)的熱修復(fù)美團(tuán)Robus等等等等都利用到了插樁技術(shù)。

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

由于對(duì)于該技術(shù)也只是有所了解，因此不做更多贅述。如果大家感興趣可以自己去加強(qiáng)學(xué)習(xí)。

利用注解加反射實(shí)現(xiàn)findViewById

我們利用注解加反射來(lái)實(shí)現(xiàn)一個(gè)簡(jiǎn)單的findViewById。

首先我們定義一個(gè)@InjectView的注解 ，里面包含一個(gè)@Idres int類型的成員變量，用來(lái)存放控件的id值。
由于程序需要在運(yùn)行期間利用反射來(lái)獲取元素的注解和值，因此注解應(yīng)聲明在Runtime階段執(zhí)行

@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);
                //反射設(shè)置屬性的值
                declaredField.setAccessible(true);//設(shè)置訪問(wèn)權(quán)限，允許操作private屬性
                try {
                    declaredField.set(activity, view);
                } catch (IllegalAccessException e) {
                    e.printStackTrace();
                }
            }
        }
    }
}

InjectViewUtil在處理時(shí)，先通過(guò)getClass拿到Activity的類對(duì)象，再使用getDeclaredFields拿到其成員變量，并通過(guò)if (declaredField.isAnnotationPresent(InjectView.class))
判斷是否被@InjectView注解過(guò)了，并進(jìn)一步拿到id值，最后使用set方法設(shè)置回去。運(yùn)行項(xiàng)目，觀察效果，TextView 對(duì)象已經(jīng)獲取到了實(shí)例，并修改為了我們?cè)O(shè)置的text值。

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

關(guān)于java注解的知識(shí)本次就介紹到這~

じゃ、また