2. 程式人生 > >Android開發之手把手教你寫ButterKnife框架（一）

Android開發之手把手教你寫ButterKnife框架（一）

阿新 • • 發佈：2019-01-10

系列文章目錄導讀：

一、概述

JakeWharton我想在Android界無人不知，無人不曉的吧， ButterKnife這個框架就是出自他隻手。這個框架我相信很多人都用過，本系列部落格就是帶大家更加深入的認識這個框架，ButterKnife截至目前已有1w+的star：

這裡寫圖片描述

如果我們對於這個優秀框架還是停留在使用階段，那就太可惜。

本系列文章的主要內容如下：
1，ButterKnife是什麼？
2，ButterKnife的作用和功能介紹。
3，ButterKnife的實現原理。
4，自己動手實現個ButterKnife。

二、ButterKnife是什麼？

ButterKnife是一個編譯時的依賴注入框架（compile-time dependency injection framework）用來簡化android中類似findViewById、setOnclickListener等的模板程式碼。
比如在寫activity介面的時候常常有如下程式碼：

public class MyActivity extents Activity{
    private EditText etConsultValidDate;
    private TextView tvToolbarCenter;
    private TextView  tvLeftAction;
    private
 
 TextView  tvRightAction;
    private TextView tvConsultTip;
    private TextView tvSuggestTime;
    private EditText etConsultTitle;
    private EditText etConsultDesc;
    private EditText etConsultTime;
    private EditText etConsultNumber;
    private RelativeLayout rlContactInfo;
    private LinearLayout llAnswerTime;
    private
 
 TextView tvAnswerTime, tvAnswerTimePre;
    private TextView tvToolbarRight;
    private LinearLayout llBottom;
    private int from;
    private RelativeLayout rlOppositeInfo;
    private ImageView ivHeadIcon;
    private TextView tvOppositeUsername, tvOppositeDesc;

    @Override
    protected void initViews() {
        tvExpertIdentify = (TextView) findViewById(R.id.tv_expert_identify);
        llBottom = (LinearLayout) findViewById(R.id.ll_bottom);
        rlOppositeInfo = (RelativeLayout) findViewById(R.id.rl_opposite_info);
        ivHeadIcon = (ImageView) findViewById(R.id.iv_head_icon);
        tvOppositeUsername = (TextView) findViewById(R.id.tv_opposite_username);
        tvOppositeDesc = (TextView) findViewById(R.id.tv_opposite_desc);
        rbOppositeScore = (RatingBar) findViewById(R.id.rbar_star);
        tvUserCompany = (TextView) findViewById(R.id.tv_user_company);
        infoArrow = findViewById(R.id.iv_member_info_arrow);
        tvConsultTip = (TextView) findViewById(R.id.tv_consult_tip);
        tvLeftAction = (TextView) findViewById(R.id.tv_left_action);
        tvRightAction = (TextView) findViewById(R.id.tv_right_action);
        llAnswerTime = (LinearLayout) findViewById(R.id.ll_answer_time);
        tvAnswerTimePre = (TextView) findViewById(R.id.tv_answer_time_pre);
        tvAnswerTime = (TextView) findViewById(R.id.tv_answer_time);
        tvLeftAction.setOnClickListener(this);
        tvRightAction.setOnClickListener(this);
        etConsultTitle = (EditText) findViewById(R.id.et_consult_title);
        etConsultDesc = (EditText) findViewById(R.id.et_consult_desc);
        etConsultTime = (EditText) findViewById(R.id.et_contact_time);
        etConsultNumber = (EditText) findViewById(R.id.et_contact_number);
        etConsultValidDate = (EditText) findViewById(R.id.et_consult_valid_day);
        tvSuggestTime = (TextView) findViewById(R.id.tv_contact_time);
    }
}

初始化Views大量的沒有技術含量的模板程式碼。如果介面比較複雜的話，這樣的程式碼變得更多。使用ButterKnife可以很好的簡化上面冗長的程式碼。

public class MyActivity extents Activity{

    @BindView(R.id.xxx) EditText etConsultValidDate;
    @BindView(R.id.xxx) TextView tvToolbarCenter;
    @BindView(R.id.xxx) TextView tvLeftAction;
    @BindView(R.id.xxx) TextView tvRightAction;
    @BindView(R.id.xxx) TextView tvConsultTip;
    @BindView(R.id.xxx) TextView tvSuggestTime;
    @BindView(R.id.xxx) EditText etConsultTitle;
    @BindView(R.id.xxx) EditText etConsultDesc;
    @BindView(R.id.xxx) EditText etConsultTime;
    @BindView(R.id.xxx) EditText etConsultNumber;
    @BindView(R.id.xxx) RelativeLayout rlContactInfo;
    @BindView(R.id.xxx) LinearLayout llAnswerTime;
    @BindView(R.id.xxx) TextView tvAnswerTime, tvAnswerTimePre;
    @BindView(R.id.xxx) TextView tvToolbarRight;
    @BindView(R.id.xxx) LinearLayout llBottom;
    @BindView(R.id.xxx) RelativeLayout rlOppositeInfo;
    @BindView(R.id.xxx) ImageView ivHeadIcon;
    @BindView(R.id.xxx) TextView tvOppositeUsername;
    @BindView(R.id.xxx) TextView tvOppositeDesc;

    @Override 
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.simple_activity);
        //初始化Views
        ButterKnife.bind(this); 
    }
}

相比之下，極大的簡化了View的初始化程式碼。

三、ButterKnife的功能介紹（所有的功能）

除了上面的@BindView註解，還其他功能：

1. 使用@BindViews初始化多個View

@BindViews({ R.id.first_name, R.id.middle_name, R.id.last_name })
List nameViews;

2. 使用@OnClick設定監聽事件

@OnClick(R.id.submit)
public void submit(View view) {
// TODO do something…
}

如果不想要submit方法引數可以去掉如：
@OnClick(R.id.submit)
public void submit() {
// TODO do something…
}

View的引數還可以自動轉換，比如給TextView設定點選事件
@OnClick(R.id.submit)
public void submit(TextView textView) {
// TODO do something…
}

如果是自定義的View可以不指定View Id 如：
public class FancyButton extends Button {
@OnClick
public void onClick() {
// TODO do something!
}
}

3. listView item點選事件

@OnItemSelected(R.id.list_view)
void onItemSelected(int position) {
// TODO …
}

4. view的onTouchEvent

@OnTouch(R.id.example) boolean onTouch() {
Toast.makeText(this, “Touched!”, Toast.LENGTH_SHORT).show();
return false;
}

5. 監聽EditText的addTextChangedListener

@OnTextChanged(R.id.example) void onTextChanged(CharSequence text) {
Toast.makeText(this, “Text changed: ” + text, Toast.LENGTH_SHORT).show();
}

6. 設定ViewPager的OnPageChangeListener

@OnPageChange(R.id.example_pager) void onPageSelected(int position) {
Toast.makeText(this, “Selected ” + position + “!”, Toast.LENGTH_SHORT).show();
}

7. 設定TextView的OnEditorActionListener（該事件主要用來設定軟鍵盤上的按鈕）

@OnEditorAction(R.id.example) boolean onEditorAction(KeyEvent key) {
Toast.makeText(this, “Pressed: ” + key, Toast.LENGTH_SHORT).show();
return true;
}

8. 設定View的OnFocusChangeListener事件

@OnFocusChange(R.id.example) void onFocusChanged(boolean focused) {
Toast.makeText(this, focused ? “Gained focus” : “Lost focus”, Toast.LENGTH_SHORT).show();
}

9. 設定View的OnLongClickListener長按事件

@OnLongClick(R.id.example) boolean onLongClick() {
Toast.makeText(this, “Long clicked!”, Toast.LENGTH_SHORT).show();
return true;
}

10. 關於資源的繫結

@BindString(R.string.title) String title; //字串
@BindDrawable(R.drawable.graphic) Drawable graphic; //drawable
@BindColor(R.color.red) int red; // int or ColorStateList field
@BindDimen(R.dimen.spacer) Float spacer; // int (for pixel size) or float (for exact value) field
@BindArray(R.array.countries) String[] countries; 字串陣列
@BindArray(R.array.icons) TypedArray icons;
@BindBool(R.bool.is_tablet) boolean isTablet;

四、ButterKnife的實現原理

通過上面的例子我們知道，要使用ButterKnife首先要在目的碼使用註解，然後在onCreate生命週期方法裡呼叫ButterKnife.bind(this);方法。使用註解沒什麼好說的，那只有看看ButterKnife.bind(this);這個方法是怎麼實現的：

  @NonNull @UiThread
  public static Unbinder bind(@NonNull Activity target) {
    View sourceView = target.getWindow().getDecorView();
    return createBinding(target, sourceView);
  }

獲取activity的decorView，然後呼叫createBinding方法：

private static Unbinder createBinding(@NonNull Object target, @NonNull View source) {
    //獲取target的位元組碼
    Class<?> targetClass = target.getClass();
    if (debug) Log.d(TAG, "Looking up binding for " + targetClass.getName());
    //搜尋構造方法（什麼類的構造方法，下面會分析）
    Constructor<? extends Unbinder> constructor = findBindingConstructorForClass(targetClass);

    if (constructor == null) {
      return Unbinder.EMPTY;
    }

    //noinspection TryWithIdenticalCatches Resolves to API 19+ only type.
    try {
      //通過反射構造類例項
      return constructor.newInstance(target, source);
    } catch (IllegalAccessException e) {
        //Ignore Exceptions
    } 
  }

createBinding方法的第一個引數target就是我們的activity例項，source就是decorView。上面的程式碼也比較簡單，我也加上了註釋。這個方法我就不多說了。然後看看findBindingConstructorForClass方法是怎麼實現的：

  @Nullable @CheckResult @UiThread
  private static Constructor<? extends Unbinder> findBindingConstructorForClass(Class<?> cls) {
    //從容器中查詢構造方法，如果找到了直接返回。
    Constructor<? extends Unbinder> bindingCtor = BINDINGS.get(cls);
    if (bindingCtor != null) {
      if (debug) Log.d(TAG, "HIT: Cached in binding map.");
      return bindingCtor;
    }
    String clsName = cls.getName();
    //如果是android framework裡的類則直接return
    if (clsName.startsWith("android.") || clsName.startsWith("java.")) {
      if (debug) Log.d(TAG, "MISS: Reached framework class. Abandoning search.");
      return null;
    }
    try {
      //拼接類名，然後獲取該類的位元組碼
      Class<?> bindingClass = Class.forName(clsName + "_ViewBinding");
      //noinspection unchecked
      //獲取該類的構造方法
      bindingCtor = (Constructor<? extends Unbinder>) bindingClass.getConstructor(cls, View.class);
      if (debug) Log.d(TAG, "HIT: Loaded binding class and constructor.");
    } catch (ClassNotFoundException e) {
      if (debug) Log.d(TAG, "Not found. Trying superclass " + cls.getSuperclass().getName());
      bindingCtor = findBindingConstructorForClass(cls.getSuperclass());
    } catch (NoSuchMethodException e) {
      throw new RuntimeException("Unable to find binding constructor for " + clsName, e);
    }
    BINDINGS.put(cls, bindingCtor);
    return bindingCtor;
  }

findBindingConstructorForClass方法核心程式碼是下面2行程式碼：

Class<?> bindingClass = Class.forName(clsName + "_ViewBinding");
bindingCtor = (Constructor<? extends Unbinder>) bindingClass.getConstructor(cls, View.class);

意思就是target的型別(qualified name)拼接_ViewBinding，然後通過獲取拼接後類的構造方法。那麼clsName + _ViewBinding 這個類是從哪裡來的。
我們把butterKnife的原始碼（8.4.0版本）下載下來，build程式碼後，查詢以_ViewBinding為結尾的java類，發現有十個只有，都位於各自所在專案的build->gernerated->source->apt->debug目錄下。
以裡面的SimpleActivity_ViewBinding為例：

// Generated code from Butter Knife. Do not modify!
package com.example.butterknife.library;
public class SimpleActivity_ViewBinding<T extends SimpleActivity> implements Unbinder {
  //ignore some code
  @UiThread
  public SimpleActivity_ViewBinding(final T target, View source) {
    target.title = Utils.findRequiredViewAsType(source, R.id.title, "field 'title'", TextView.class);
    target.subtitle = Utils.findRequiredViewAsType(source, R.id.subtitle, "field 'subtitle'", TextView.class);
    view = Utils.findRequiredView(source, R.id.hello, "field 'hello', method 'sayHello', and method 'sayGetOffMe'");
    target.hello = Utils.castView(view, R.id.hello, "field 'hello'", Button.class);
    //ignore some code
  }
}

target其實是我們上面的activity，source就是DecorView。發現所有的View的初始化工作全部放在了SimpleActivity_ViewBinding構造方法裡。

// Generated code from Butter Knife. Do not modify!

通過這句話我們知道，SimpleActivity_ViewBinding是ButterKnife生成的。那麼ButterKnife是怎麼生成這個類的呢？

通過一個叫APT（Annotation Processing Tool）工具生成對應的類。

總結下：
1. butterKnife是一個執行時依賴注入框架，有效地幫我們簡化一些重複程式碼。
2. butterKnife在ButterKnife.bind方法裡通過反射呼叫對應的類構造方法執行初始化工作，所以butterKnife並不是完全沒有使用反射，只在這個地方用到了。所以butterKnife的效率也是很高的。對於反射這個技術，不應該持極端態度(徹底不用，或到處濫用)。特別是在android中，到處都是反射，對效能也是有一定的影響的。
3. butterknife使用 apt技術來生成java類。

本系列預計有三篇文章，下一篇文章將介紹在android studio中如何使用apt。最後一篇文章講如何實現呼叫bind方法就完成view的初始化工作。

相關推薦

Android開發之手把手教你寫ButterKnife框架（一）

系列文章目錄導讀： 一、概述 JakeWharton我想在Android界無人不知，無人不曉的吧， ButterKnife這個框架就是出自他隻手。這個框架我相信很多人都用過，本系列部落格就是帶大家更加深入的認識這個框架，ButterKnife截至目前

Android開發之手把手教你寫ButterKnife框架（三）

系列文章目錄導讀： 一、概述 然後在Processor裡生成自己的程式碼，把要輸出的類，通過StringBuilder拼接字串，然後輸出。 try { // write the file JavaFileObject

教你寫Http框架（一）

大家都知道，從本質上來說app實際只是整個大系統當中的View層，因為設計優秀的系統中，app基本都不會承擔任何實際的業務邏輯處理，只是負責向用戶展示資料以及從使用者端蒐集使用者資料。而這個資料的一來一去，自然離不開網路通訊協議，而我們用得最多的，自然是這個ht

手把手教你寫網路爬蟲（2）：迷你爬蟲架構

語言&環境 有需要Python學習資料的小夥伴嗎?小編整理【一套Python資料、原始碼和PDF】，感興趣者可以加學習群：548377875或者加小編微信：【mmp9972】反正閒著也是閒著呢，不如學點東西啦~~ 語言：帶足彈藥，繼續用Python開路！ t

手把手教你寫網路爬蟲（8）：徹底解決亂碼問題

字元編解碼是爬蟲裡必學的一項知識，在我們的爬蟲生涯中早晚會爬到亂碼的網頁，與其遇到時驚慌失措，不如早學早好，徹底避免亂碼問題。 字元編碼簡介 什麼是字符集 在介紹字元編碼之前，我們先了解下什麼是字符集。 字元(Character)是各種文字和符號的總稱，包括各國家文字、標點

手把手教你寫指令碼引擎（五）——簡單的高階語言（3，符號表）

手把手教你寫指令碼引擎（五）——簡單的高階語言（3，符號表） 陳梓瀚 華南理工大學軟體本科05級 符號表的結構的複雜度跟語言的語義規則的複雜度有關。對於C#來說，每一個符號都附帶了一大堆資訊，譬如位置啦，所在的namespace啦，型別啦什麼的。對於JavaScript來說，

手把手教你寫網路爬蟲（5）：PhantomJS實戰

有需要Python學習資料的小夥伴嗎?小編整理【一套Python資料、原始碼和PDF】，感興趣者可以加學習群：548377875或者加小編微信：【mmp9972】反正閒著也是閒著呢，不如學點東西啦~~ 如果想看到更多專案，並不能像網易雲音樂那樣點“下一頁”翻頁，而是

手把手教你寫網路爬蟲（1）：網易雲音樂歌單

Selenium：是一個強大的網路資料採集工具，其最初是為網站自動化測試而開發的。近幾年，它還被廣泛用於獲取精確的網站快照，因為它們可以直接執行在瀏覽器上。Selenium 庫是一個在WebDriver 上呼叫的API。WebDriver 有點兒像可以載入網站的瀏覽器，但是它也可以像BeautifulSoup

【爬蟲】手把手教你寫網路爬蟲（1）

介紹 什麼是爬蟲？ 先看看百度百科的定義: 簡單的說網路爬蟲（Web crawler）也叫做網路鏟（Web scraper）、網路蜘蛛（Web spider），其行為一般是先“爬”到對應的網頁上，再把需要的資訊“鏟”下來。 為什麼學習爬蟲？ 看到這裡，有人就要問了：Google、百度等

教你寫Http框架（二）——三個樣例帶你深入理解AsyncTask

func implement oncreate 其它 層疊 worker dcl 例如 人員 這個標題大家不要奇怪，扯Http框架怎麽扯到AsyncTask去了，有兩個原因：首先是Http框架除了核心http理論外。其技術實現核心也是線程池 + 模板 +

手把手教你安卓入門（一）

部落格 學院 下載 GitChat 論壇 寫部落格 發Chat

【手把手教你樹莓派3 （一）】裝機

概述 raspberry pi其實可以看做一個微型的計算機，我們可以在上面裝各種作業系統，然後搭建伺服器，當然這只是它的一小點功能罷了。。。與我們常用的PC機不同的是，ras pi有GPIO，我們可以讓raspberry pi來控制這些引腳，從而傳送一些物理訊號給其他的裝置

手把手教你實現SVM演算法（一）

什麼是機器學習 （Machine Learning）       機器學習是研究計算機怎樣模擬或實現人類的學習行為，以獲取新的知識或技能，重新組織已有的知識結構使之不斷改善自身的效能。它是人工智慧的核心，是使計算機具有智慧的根本途徑，其應用遍及人工智慧的各個領域。 機器學習

【25】手把手教你響應式佈局（一）

一：佈局方式有如下幾種： 1. 固定佈局：固定佈局以PX(畫素)作為單位的，在PC端，設計稿多少PX就寫多少PX，前幾年都是這種佈局，常見的是以960px或者1000px來設計的，但是這樣設計有如下缺點： 1.1.頁面很死板，在更大的螢幕上，頁面左右2邊留白。 1.2.不適

android 手把手教你寫資料庫框架(第一篇)

前言:當你想成為什麼樣的人,努力朝目標努力,終究有一天會實現,人生最大的快樂就是不斷追尋夢想的過程 準備寫一個數據庫框架,現在的專案中資料庫框架是用三方orm,不知道是不是叫這個名字,不重要了,準備這段時間把這資料庫框架寫出來,也許寫的不夠好,沒關係,只要堅持住總會比之前

手把手教你寫DI_1_DI框架有什麼？

DI框架有什麼？ 在上一節：手把手教你寫DI_0_DI是什麼？ 我們已經理解DI是什麼 接下來我們就徒手擼一擼，玩個支援建構函式注入的DI出來 首先我們回顧一下 建構函式注入 的程式碼形式， 大概長這模樣： class MovieLister { private IMovieFinder f

手把手教你寫DI_1_DI框架有什麽？

這樣的 desc inject var .net 框架 抽象 幹什麽 depend DI框架有什麽？ 在上一節：手把手教你寫DI_0_DI是什麽？ 我們已經理解DI是什麽 接下來我們就徒手擼一擼，玩個支持構造函數註入的DI出來 首先我們回顧一下 構造函數註入 的代碼形式，

Android 手把手教您自定義ViewGroup（一）

最近由於工作的變動，導致的部落格的更新計劃有點被打亂，希望可以儘快脈動回來~今天給大家帶來一篇自定義ViewGroup的教程，說白了，就是教大家如何自定義ViewGroup，如果你對自定義ViewGroup還不是很瞭解，或者正想學習如何自定義，那麼你可以好好看看這篇部落格。1、概述在寫程式碼之前，我必須得

Android開發之AIDL實現遠端服務程序通訊（IPC）

首先什麼是AIDL呢，它是Android系統中的一種介面定義語言，用於約束兩個程序間的通訊規則，供編譯器生成程式碼。 實現Android裝置上的兩個程序間通訊（IPC），程序之間的通訊資訊首先會被轉換成AIDL協議資訊，然後傳送給對方；對方接收到AIDL協議資

Android開發之仿QQ側滑刪除實現（二）

一、把SlideDelete的簡單樣式先做出來。 SlideDelete繼承自ViewGroup，在引用SlideDelete的xml的位置include進兩個layout，一個是內容，一個是刪除 一、1、準備兩個佈局 內容部分 <?xml version="1.