Android butterknife 實現原理

簡介

ButterKnife 是一個 Android 系統的 View 注入框架，能夠通過『注解』的方式來綁定 View 的屬性或方法。

比如使用它能夠減少 findViewById() 的書寫，使代碼更為簡潔明了，同時不消耗額外的性能。

當然這樣也有個缺點，就是可讀性會差一些，好在 ButterKnife 比較簡單，學習難度也不大。

添加依賴

這里以 Android Studio Gradle 為例，為項目添加 ButterKnife，注意兩個步驟都要完成：

1. Project 的 build.gradle 添加：

dependencies {
  classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'
}
 

2. App 的 build.gradle 添加：

applyplugin: 'com.neenbedankt.android-apt'
 
dependencies {
  compile 'com.jakewharton:butterknife:8.0.1'
  apt 'com.jakewharton:butterknife-compiler:8.0.1'
}
 

這里順便提一個名為 Android Butterknife Zelezny 的插件，可在 Settings – plugins 中下載，提供一鍵生成注解的功能，這里不多贅述，可以看以下文章：

ButterKnife 注解框架的偷懶插件

ButterKnife 的使用

ButterKnife 的使用是比較簡單的，具體的使用可以參考官方文檔或者搜索其他博文資料，在這里只簡單介紹一下它的用途：

1. 通過使用 @BindView 來消除 findViewById
2. 將多個 View 組織到一個列表中，一次性操作它們
3. 通過使用 @onClick 為 View 綁定監聽，消除 listener 的匿名內部類
4. 通過使用資源注解如 @BindColor，來消除資源的查找

我們看到呢，它好像消除了一堆東西，其實就是簡化的意思啦。

使用方式整合

總的來說，ButterKnife 有以下使用：

1. View 綁定
2. Resource 綁定
3. 非 Activity 綁定
4. View List 綁定
5. Listener 綁定

具體的使用，參照文檔吧！

Butter Knife

原理簡單分析

Java Annotation Processing

注解處理器，在 Java5 中叫 APT，有沒有很眼熟：

dependencies {
  classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'
}
 
// 引入 ButterKnifeProcessor 等
apt 'com.jakewharton:butterknife-compiler:8.0.1'
 

這是一個用於編譯時掃描和解析 Java 注解的工具，通過它我們可以自己定義注解，並定義解析器來處理它們。它的原理是讀入 Java 源代碼，解析注解，然后生成新的 Java 代碼，新生成的代碼最后被編譯成 Java 字節碼。

當然這里我們不是要深究 APT 的原理，而是要知道在 ButterKnife 中運用到了這個工具。

ButterKnife 流程

這里以一個栗子來一步步觀察，ButterKnife 的工作流程。

在此之前看一眼 @BindView 注解的定義：

@Retention(CLASS) @Target(FIELD)
public @interface BindView {
  /** View ID to which the field will be bound. */
  @IdResint value();
}

重點在於 @Retention(CLASS)，它表示該注解在編譯時被保留，但在運行時 JVM 會忽略它。因此使用 ButterKnife 的注解，不會對運行時的性能造成消耗。

掃描 ButterKnife 注解

首先我們使用注解來聲明我們的一個 View：

@BindView(R.id.text1) TextViewtext1;

於是在我們編譯的時候，ButterKnifeProcessor 類的 process() 方法便會執行，搜索到所有的 ButterKnife 注解（@BindView），然后生成一個 Java 類。

根據注解，生成 Java 類

我們在 app\build\generated\source\apt\ 中找到生成的 MainActivity$$ViewBinder 文件，該類中包含了一個 bind 方法：

public Unbinderbind(final Finderfinder, final T target, Object source) {
    InnerUnbinderunbinder = createUnbinder(target);
    Viewview;
    view = finder.findRequiredView(source, 2131492944, "field 'text1'");
    target.text1 = finder.castView(view, 2131492944, "field 'text1'");
    return unbinder;
  }
 

到這里就越來越像我們手寫 findViewById() 了。

動態注入

最后當我們執行 ButterKnife.bind(this) 時，ButterKnife 會加載上面生成的類，然后調用其 bind 方法。

• 這里首先調用了 findRequiredView 去尋找 R.id.text1 所對應的控件，其實相當於我們的 findViewById()
• 其次調用 castView，相當於類型轉換，把找到的 View 轉化為 TextView 類型

至此，我們就完成了一次 ButterKnife 的工作流程。

總結

實際上我們發現，ButterKnife 的原理還是相對簡單的，因為其主要難點在於 APT 的使用，那屬於其他方面的內容，在此我們並不深究。

在這個框架中我們看到了『反射』和『Annotation Processing』間的取舍，ButterKnife 使用了后者，避免了額外性能的消耗。