[Android開發] ButterKnife8.5.1 使用方法教程總結

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

一、 ButterKnife是啥

註解中相對簡單易懂的很不錯的開源框架
1. 強大的View繫結和Click事件處理功能，簡化程式碼，提升開發效率
2. 方便的處理Adaper裡的ViewHolder繫結問題
3. 執行時不會影響app效率，使用配置方便
4. 程式碼清晰，可讀性強

二、使用步驟

2.1 新增外掛

File -> Settings -> Plugins -> 搜尋ButterKnife，找到Android ButterKnife Zeleany進行安裝重啟AndroidStudio
這裡寫圖片描述

2.2 新增依賴

在對應module的build.gradle裡面新增下面的依賴，重新編譯就會自動下載

dependencies {
  compile 'com.jakewharton:butterknife:8.5.1'
  annotationProcessor 'com.jakewharton:butterknife-compiler:8.5.1'
}

注意和Dagger2配合使用需要注意把annotationProcessor改為apt。

2.3 在Activity中使用

2.3.1 使用外掛

在R.layout.activity_main上面右擊選擇Generate -> Generate ButterKnife injections,即可選擇生成view對應的註解,還支援ViewHolder和OnClick

2.3.2 手動

繫結ButterKnife


@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);
    //繫結初始化ButterKnife
    ButterKnife.bind(this);
}

定義View

下面的程式碼把R.id.tv_test這個TextView定義了為tvTest，注意型別不能為static或者private

@BindView(R.id.tv_test)
TextView tvTest;

//當然寫成一行也是可以
@BindView(R.id.tv_test) TextView tvTest;

點選事件

添加註解@OnClick(R.id.xx)即為點選方法，對應的View引數可有可無，如果有多個引數可以只加一個引數(例如onItemClick有四個引數，你可以只加一個int position的引數)。如果引數錯誤，編譯的時候會報錯。

@OnClick(R.id.bt_test)
public void onClick(View v) {
    tvTest.setText("被點選了...");
}

如果定義為指定的型別，將會自動轉換

@OnClick(R.id.bt_test)
public void onClick(Button button) {
    tvTest.setText("被點選了...");
}

更多事件看下面的三

2.4 在Fragment中使用

在Fragment中使用和在Activity中使用，只是有一點不一樣：在獲取View的時候，加多一個view引數把View繫結到ButterKnife就行了。

@Nullable
@Override
public View onCreateView(LayoutInflater inflater, @Nullable ViewGroup container, @Nullable Bundle savedInstanceState) {
    View view = inflater.inflate(R.layout.my_fragment, container, false);
    //這裡需要加多一個引數view
    ButterKnife.bind(this, view);
    return view;
}

Fragment生命週期和activity有點不同，銷燬的時候可以進行解綁


public class MyFragment extends Fragment {

    @BindView(R.id.bt_test)
    Button btTest;

    private Unbinder unbinder;

    @Nullable
    @Override
    public View onCreateView(LayoutInflater inflater, @Nullable ViewGroup container, @Nullable Bundle savedInstanceState) {
        View view = inflater.inflate(R.layout.my_fragment, container, false);
        //繫結的時候返回了一個Unbinder物件
        unbinder = ButterKnife.bind(this, view);
        return view;
    }

    @Override
    public void onDestroyView() {
        super.onDestroyView();
        unbinder.unbind();
    }
}

2.5 在Adapter ViewHolder中使用

把ViewHolder加一個構造方法，在new ViewHolder的時候把view傳遞進去。

static class ViewHolder {
    @BindView(R.id.tv_item_test)
    TextView tvItemTest;
    @BindView(R.id.bt_item_test)
    Button btItemTest;
    public ViewHolder(View view) {
        ButterKnife.bind(this, view);
    }
}

item裡面Button控制元件的點選事件也可以使用註解@OnClick來實現，在介面卡裡面新增就行，如：


    //item的button的點選事件
    @OnClick(R.id.bt_item_test)
    void onClick(){
        Toast.makeText(context,"點選了按鈕",Toast.LENGTH_SHORT).show();

    }

    static class ViewHolder {
        @BindView(R.id.tv_item_test)
        TextView tvItemTest;
        @BindView(R.id.bt_item_test)
        Button btItemTest;
        public ViewHolder(View view) {
            ButterKnife.bind(this, view);
        }
    }

注意：如果item裡面有Button等這些有點選的控制元件事件的，需要設定這些控制元件屬性focusable為false

三、事件註解

一共有12個

名稱	作用
@OnClick	點選事件
@OnCheckedChanged	選中，取消選中
@OnEditorAction	軟鍵盤的功能鍵
@OnFocusChange	焦點改變
@OnItemClick	item被點選(注意這裡有坑，如果item裡面有Button等這些有點選的控制元件事件的，需要設定這些控制元件屬性focusable為false)
@OnItemLongClick	item長按(返回真可以攔截onItemClick)
@OnItemSelected	item被選擇事件
@OnLongClick	長按事件
@OnPageChange	頁面改變事件
@OnTextChanged	EditText裡面的文字變化事件
@OnTouch	觸控事件
@Optional	選擇性注入，如果當前物件不存在，就會丟擲一個異常，為了壓制這個異常，可以在變數或者方法上加入一下註解,讓注入變成選擇性的,如果目標View存在,則注入, 不存在,則什麼事情都不做=如下程式碼

@Optional
@OnCheckedChanged(R.id.cb_test)
public void onCheckedChanged(CompoundButton buttonView,boolean isChecked){
    if(isChecked){
        tvTest.setText("被選中了...");
    }else{
        tvTest.setText("被取消了...");
    }
}

三、繫結註解

有11種

名稱	解析
@BindViews	繫結多個view id為一個view的list變數
@BindView	繫結一個view id為一個view 變數
@BindArray	繫結string裡面array陣列,@BindArray(R.array.city ) String[] citys ;
@BindBitmap	繫結圖片資源為Bitmap，@BindBitmap( R.mipmap.wifi ) Bitmap bitmap;
@BindBool	繫結真假boolean
@BindColor	繫結color,@BindColor(R.color.colorAccent) int black;
@BindDimen	繫結Dimen,@BindDimen(R.dimen.borth_width) int mBorderWidth;
@BindDrawable	繫結Drawable,@BindDrawable(R.drawable.test_pic) Drawable mTestPic;
@BindFloat	繫結float
@BindInt	繫結int
@BindString	繫結一個String id為一個String變數,@BindString( R.string.app_name ) String meg;

五、 ButterKnife更多使用

4.1 指定多個id繫結事件

例如繫結多個Button的onclick事件，在小括號裡面加大括號，然後用逗號分割即可。

    @OnClick({R.id.bt_test,R.id.bt_test_two})
    public void onClick(View v) {
        switch (v.getId()){
            case R.id.bt_test:
                tvTest.setText("按鈕1被點選了...");
                break;
            case R.id.bt_test_two:
                tvTest.setText("按鈕2被點選了...");
                break;
        }
    }

4.2 多個view

使用BindViews繫結多個

@BindViews({R.id.tv_test,R.id.tv_test_two,R.id.tv_test_three})
List<TextView> tvList;

使用Action介面或者Setter介面或者View的Property，可以同時設定多個view的屬性

@BindViews({R.id.tv_test,R.id.tv_test_two,R.id.tv_test_three})
List<TextView> tvList;

@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);
    ButterKnife.bind(this);


    //設定多個view的屬性
    //方式1 傳遞值
    ButterKnife.apply(tvList,ENABLED,false);
    //方式2 指定值
    ButterKnife.apply(tvList,DISABLE);
    //方式3 設定View的Property
    ButterKnife.apply(tvList, View.ALPHA, 0.0f);

}

//Action介面設定屬性
static final ButterKnife.Action<View> DISABLE = new ButterKnife.Action<View>() {
    @Override public void apply(View view, int index) {
        view.setEnabled(false);
    }
};

//Setter介面設定屬性
static final ButterKnife.Setter<View, Boolean> ENABLED = new ButterKnife.Setter<View, Boolean>() {
    @Override public void set(View view, Boolean value, int index) {
        view.setEnabled(value);
    }
};

4.3 自定義View使用註解事件

不用指定id，直接註解OnClick

public class MyButton extends Button {
  @OnClick
  public void onClick() {
  }
}

4.4 繫結api

使用Activity為根檢視繫結任意物件時，如果你使用類似MVC的設計模式你可以在Activity 呼叫ButterKnife.bind(this, activity)，來繫結Controller。
使用ButterKnife.bind(this)繫結一個view的子節點欄位.如果你在子View的佈局裡或者自定義view的構造方法裡使用了inflate,你可以立刻呼叫此方法。或者，從XML inflate來的自定義view型別可以在onFinishInflate回撥方法中使用它。

4.5 多方法的listener

例如Spinner的setOnItemSelectedListener，他會回撥兩個方法:

mSpinner.setOnItemSelectedListener(new AdapterView.OnItemSelectedListener() {
    @Override
    public void onItemSelected(AdapterView<?> parent, View view, int position, long id) {
    }
    @Override
    public void onNothingSelected(AdapterView<?> parent) {
    }
});

所以這時候如果我們需要註解onNothingSelected，需要在註解引數新增一個callback，

@OnItemSelected(R.id.my_spiner)//預設callback為ITEM_SELECTED
void onItemSelected(int position) {
    Toast.makeText(this, "position: " + position, Toast.LENGTH_SHORT).show();
}

@OnItemSelected(value = R.id.my_spiner, callback = OnItemSelected.Callback.NOTHING_SELECTED)
void onNothingSelected() {
    Toast.makeText(this, "Nothing", Toast.LENGTH_SHORT).show();
}

注意的是Spinner中只要有資料,預設都會選中第0個數據,所以想進入到onNothingSelected()方法,就需要把Adapter中的資料都清空

4.6 使用findById

Butter knife仍然包含了findById方法，用於仍需從一個view ，Activity，或者Dialog上 find view的時候。並且它可以自動轉換型別。

View view = LayoutInflater.from(context).inflate(R.layout.thing, null);
TextView firstName = ButterKnife.findById(view, R.id.first_name);
TextView lastName = ButterKnife.findById(view, R.id.last_name);
ImageView photo = ButterKnife.findById(view, R.id.photo);

4.7 程式碼混淆

-keep class butterknife.** { *; }
-dontwarn butterknife.internal.**
-keep class **$$ViewBinder { *; }

-keepclasseswithmembernames class * {
    @butterknife.* <fields>;
}

-keepclasseswithmembernames class * {
    @butterknife.* <methods>;
}

五、原理

利用了IOC的(Inverse of Controll)控制反轉結構，04年後改名為DI(dependency injection)依賴注入。目的是為了使類與類之間解耦合，提高系統的可擴充套件性和可維護性。

六、和Dagger使用注意

搭配Dagger使用的時候，ButterKnife可能會不起作用，沒效果，繫結控制元件為null。這時候把依賴包的annotationProcessor改為apt 就可以了：

    compile 'com.jakewharton:butterknife:8.5.1'
    //apt
    apt 'com.jakewharton:butterknife-compiler:8.5.1'