Android Butterknife使用方法總結 IOC框架

時間 2019-12-10

標籤 android butterknife 使用方法總結 ioc 框架欄目 Android 简体版

原文原文鏈接

前言：
ButterKnife是一個專一於Android系統的View注入框架,之前老是要寫不少findViewById來找到View對象，有了ButterKnife能夠很輕鬆的省去這些步驟。是大神JakeWharton的力做，目前使用很廣。最重要的一點，使用ButterKnife對性能基本沒有損失，由於ButterKnife用到的註解並非在運行時反射的，而是在編譯的時候生成新的class。項目集成起來也是特別方便，使用起來也是特別簡單。php

經過學習本文，學會如何在項目中使用ButterKnife。本文包含如下要點：java

前言
- 簡單介紹
- ButterKnife的優點
基本配置
ButterKnife的註冊與綁定
- ButterKnife使用心得與注意事項
- 在Activity中綁定ButterKnife
- 在Fragment中綁定ButterKnife
- 在Adapter中綁定ButterKnife
ButterKnife的基本使用
- 綁定View
- 綁定資源
- 事件綁定
- 綁定監聽
- 使用findById
- 設置多個view的屬性
- 使用注意事項
- 更多綁定註解
- 更多事件註解
ButterKnife的代碼混淆
Butterknife插件：zelezny
- 插件安裝
- 插件使用

ButterKnife項目地址：https://github.com/JakeWharton/butterknifeandroid

▲ ButterKnife的優點：git

一、強大的View綁定和Click事件處理功能，簡化代碼，提高開發效率github

二、方便的處理Adapter裏的ViewHolder綁定問題設計模式

三、運行時不會影響APP效率，使用配置方便數組

四、代碼清晰，可讀性強bash

基本配置
在android Studio項目中配置使用ButterKnifeapp

Step one：在Project的 build.gradle 中添加以下代碼：

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:2.3.3' classpath 'com.jakewharton:butterknife-gradle-plugin:8.8.1' //添加這一行 } }

Step two：在App的 build.gradle 中添加以下代碼：

apply plugin: 'com.jakewharton.butterknife'

dependencies中添加：

compile 'com.jakewharton:butterknife:8.8.1' annotationProcessor 'com.jakewharton:butterknife-compiler:8.8.1'

構建環境特別簡單，接下來看看如何使用框架

ButterKnife的註冊與綁定

▲ ButterKnife使用心得與注意事項：

一、在Activity 類中綁定：ButterKnife.bind(this);必須在setContentView();以後綁定；且父類bind綁定後，子類不須要再bind。

二、在非Activity 類（eg：Fragment、ViewHold）中綁定： ButterKnife.bind(this，view);這裏的this不能替換成getActivity（）。

三、在Activity中不須要作解綁操做，在Fragment 中必須在onDestroyView()中作解綁操做。

四、使用ButterKnife修飾的方法和控件，不能用private or static 修飾，不然會報錯。錯誤: @BindView fields must not be private or static. (com.zyj.wifi.ButterknifeActivity.button1)

五、setContentView()不能經過註解實現。（其餘的有些註解框架能夠）

六、使用Activity爲根視圖綁定任意對象時，若是你使用相似MVC的設計模式你能夠在Activity 調用ButterKnife.bind(this, activity)，來綁定Controller。

七、使用ButterKnife.bind(this，view)綁定一個view的子節點字段。若是你在子View的佈局裏或者自定義view的構造方法裏使用了inflate,你能夠馬上調用此方法。或者，從XML inflate來的自定義view類型能夠在onFinishInflate回調方法中使用它。

▲ 在Activity中綁定ButterKnife：

因爲每次都要在Activity中的onCreate綁定Activity，因此我的建議寫一個BaseActivity完成綁定，子類繼承便可。綁定Activity 必須在setContentView以後。使用ButterKnife.bind(this)進行綁定。代碼以下：

public class MainActivity extends AppCompatActivity{ @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_main); //綁定初始化ButterKnife ButterKnife.bind(this); } }

▲ 在Fragment中綁定ButterKnife：

Fragment的生命週期不一樣於activity。在onCreateView中綁定一個Fragment時，在onDestroyView中將視圖設置爲null。當你調用bind來爲你綁定一個Fragment時,Butter Knife會返回一個Unbinder的實例。在適當的生命週期（onDestroyView）回調中調用它的unbind方法進行Fragment解綁。使用ButterKnife.bind(this, view)進行綁定。代碼以下：

public class ButterknifeFragment extends Fragment{ private Unbinder unbinder; @Override public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) { View view = inflater.inflate(R.layout.fragment, container, false); //返回一個Unbinder值（進行解綁），注意這裏的this不能使用getActivity() unbinder = ButterKnife.bind(this, view); return view; } /** * onDestroyView中進行解綁操做 */ @Override public void onDestroyView() { super.onDestroyView(); unbinder.unbind(); } }

▲ 在Adapter中綁定ButterKnife：

在Adapter的ViewHolder中使用，將ViewHolder加一個構造方法，在new ViewHolder的時候把view傳遞進去。使用ButterKnife.bind(this, view)進行綁定，代碼以下：

public class MyAdapter extends BaseAdapter { @Override public View getView(int position, View view, ViewGroup parent) { ViewHolder holder; if (view != null) { holder = (ViewHolder) view.getTag(); } else { view = inflater.inflate(R.layout.testlayout, parent, false); holder = new ViewHolder(view); view.setTag(holder); } holder.name.setText("Donkor"); holder.job.setText("Android"); // etc... return view; } static class ViewHolder { @BindView(R.id.title) TextView name; @BindView(R.id.job) TextView job; public ViewHolder(View view) { ButterKnife.bind(this, view); } } }

ButterKnife的基本使用

▲ 綁定View：

控件id 註解： @BindView（）

@BindView( R2.id.button) public Button button;

佈局內多個控件id 註解： @BindViews（）

public class MainActivity extends AppCompatActivity { @BindViews({ R2.id.button1, R2.id.button2, R2.id.button3}) public List<Button> buttonList ; @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_main); ButterKnife.bind(this); buttonList.get( 0 ).setText( "hello 1 "); buttonList.get( 1 ).setText( "hello 2 "); buttonList.get( 2 ).setText( "hello 3 "); } }

▲ 綁定資源：

綁定string 字符串：@BindString()

public class MainActivity extends AppCompatActivity { @BindView(R2.id.button) //綁定button 控件 public Button button ; @BindString(R2.string.app_name) //綁定資源文件中string字符串 String str; @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_main); //綁定activity ButterKnife.bind( this ) ; button.setText( str ); } }

綁定string裏面array數組：@BindArray()

<resources>  
    <string name="app_name">城市</string> <string-array name="city"> <item>北京市</item> <item>天津市</item> <item>哈爾濱市</item> <item>大連市</item> <item>香港市</item> </string-array> </resources> ------------------------------------------------------------------------------ public class MainActivity extends AppCompatActivity { @BindView(R2.id.button) //綁定button 控件 public Button button ; @BindString(R2.string.app_name) //綁定資源文件中string字符串 String str; @BindArray(R2.array.city) //綁定string裏面array數組 String [] citys ; @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_main); //綁定activity ButterKnife.bind( this ) ; button.setText(citys[0]); } }

綁定Bitmap 資源：@BindBitmap( )

public class MainActivity extends AppCompatActivity { @BindView( R2.id.imageView ) //綁定ImageView 控件 public ImageView imageView ; @BindBitmap( R2.mipmap.bm)//綁定Bitmap 資源 public Bitmap bitmap ; @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_main); //綁定activity ButterKnife.bind( this ) ; imageView.setImageBitmap(bitmap); } }

綁定一個顏色值：@BindColor( )

public class MainActivity extends AppCompatActivity { @BindView( R2.id.button) //綁定一個控件 public Button button; @BindColor( R2.color.colorAccent ) //具體色值在color文件中 int black ; //綁定一個顏色值 @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_main); //綁定activity ButterKnife.bind( this ) ; button.setTextColor( black ); } }

▲ 事件綁定：

綁定點擊事件：
- 綁定控件點擊事件：@OnClick( )
- 綁定控件長按事件：@OnLongClick( )

public class MainActivity extends AppCompatActivity { @OnClick(R2.id.button1 ) //給 button1 設置一個點擊事件 public void showToast(){ Toast.makeText(this, "is a click", Toast.LENGTH_SHORT).show(); } @OnLongClick( R2.id.button1 ) //給 button1 設置一個長按事件 public boolean showToast2(){ Toast.makeText(this, "is a long click", Toast.LENGTH_SHORT).show(); return true ; } @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_main); //綁定activity ButterKnife.bind( this ) ; } }

指定多個id綁定事件：

public class MainActivity extends AppCompatActivity { //Tip：當涉及綁定多個id事件時，咱們可使用Android studio的Butterknife //插件zelezny快速自動生成的，以後在下面會有介紹安裝插件與使用 @OnClick({R.id.ll_product_name, R.id.ll_product_lilv, R.id.ll_product_qixian, R.id.ll_product_repayment_methods}) public void onViewClicked(View view) { switch (view.getId()) { case R.id.ll_product_name: System.out.print("我是點擊事件1"); break; case R.id.ll_product_lilv: System.out.print("我是點擊事件2"); break; case R.id.ll_product_qixian: System.out.print("我是點擊事件3"); break; case R.id.ll_product_repayment_methods: System.out.print("我是點擊事件4"); break; } } @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_main); //綁定activity ButterKnife.bind( this ) ; } }

經過上面的例子能夠看出多條點擊事件是沒有用R2的方式，若是必定要使用R2的寫法，能夠單一逐次寫，正確的寫法以下：

public class MainActivity extends AppCompatActivity { @OnClick(R2.id.ll_product_name) public void onViewClicked1(View view) { System.out.print("我是點擊事件1"); } @OnClick(R2.id.ll_product_lilv) public void onViewClicked2(View view) { System.out.print("我是點擊事件2"); } @OnClick(R2.id.ll_product_qixian) public void onViewClicked3(View view) { System.out.print("我是點擊事件3"); } @OnClick(R2.id.ll_product_repayment_methods) public void onViewClicked4(View view) { System.out.print("我是點擊事件4"); } @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_main); //綁定activity ButterKnife.bind( this ) ; } }

自定義View使用綁定事件

不用指定id，直接註解OnClick。看代碼以爲好像跟實現點擊事件的方法相似。實際上並無實現OnClickListener接口。代碼以下：

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

▲ 綁定監聽：

Listeners能夠自動配置到方法中

@OnClick(R.id.submit) public void submit(View view) { // TODO submit data to server... }

對監聽器方法的全部參數都是可選的

@OnClick(R.id.submit) public void submit() { // TODO submit data to server... }

自定義一個特定類型，它將自動被轉換

@OnClick(R.id.submit) public void sayHi(Button button) {//看括號內參數的變化就明白了 button.setText("Hello!"); }

在單個綁定中指定多個id，用於公共事件處理。這裏舉例點擊事件。其餘的事件監聽一樣也是能夠的。

@OnClick(R.id.submitCode,R.id.submitFile,R.id.submitTest) public void sayHi(Button button) {//多個控件對應公共事件 button.setText("Success!"); }

自定義視圖能夠經過不指定ID來綁定到它們本身的監聽器。

public class FancyButton extends Button { @OnClick public void onClick() { // TODO do something! } }

Listener中多方法註解

方法註解，其對應的監聽器有多個回調，可用於綁定到其中任何一個。每一個註解都有一個它綁定的默認回調。使用回調參數指定一個替換。以Spinner爲例。
本來代碼：

Spinner s=new Spinner(this); //原始方法：Spinner 條目選擇監聽事件 正常寫法 s.setOnItemSelectedListener(new AdapterView.OnItemSelectedListener(){ @Override public void onItemSelected(AdapterView<?> parent, View view, int position, long id) { } @Override public void onNothingSelected(AdapterView<?> parent) { } });

經過 Butter Knife 註解方式

public class MainActivity extends AppCompatActivity { /*利用註解對Spinner item 做選擇監聽事件處理方式*/ @OnItemSelected(R.id.my_spiner)//默認callback爲ITEM_SELECTED void onItemSelected(int position) { Toast.makeText(this, "position: " + position, Toast.LENGTH_SHORT).show(); } /* * 註解onNothingSelected，須要在註解參數添加一個callback， * 注意的是Spinner中只要有數據,默認都會選中第0個數據,因此想進入到onNothingSelected()方法,就須要把Adapter中的數據都清空 */ @OnItemSelected(value = R.id.my_spiner, callback = OnItemSelected.Callback.NOTHING_SELECTED) void onNothingSelected() { Toast.makeText(this, "Nothing", Toast.LENGTH_SHORT).show(); } @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_main); //綁定activity ButterKnife.bind( this ) ; Spinner s=new Spinner(this); } }

@OnCheckedChanged監聽的使用

原方法應是：setOnCheckedChangeListener()。使用栗子

<?xml version="1.0" encoding="utf-8"?> <LinearLayout xmlns:android="http://schemas.android.com/apk/res/android" android:layout_width="match_parent" android:layout_height="match_parent" android:orientation="vertical"> <RadioGroup android:id="@+id/rg_main" android:layout_width="fill_parent" android:layout_height="48dp" android:layout_alignParentBottom="true" android:background="@color/white" android:orientation="horizontal"> <RadioButton android:id="@+id/rg_home" android:layout_width="match_parent" android:layout_height="match_parent" android:focusable="false" android:text="@string/nav_one" /> <RadioButton android:id="@+id/rg_wealth" android:layout_width="match_parent" android:layout_height="match_parent" android:focusable="false" android:text="@string/nav_two" /> <RadioButton android:id="@+id/rg_account" android:layout_width="match_parent" android:layout_height="match_parent" android:focusable="false" android:text="@string/nav_four" /> </RadioGroup> </LinearLayout> ------------------------------------------------------------------------- @OnCheckedChanged({R.id.rg_home,R.id.rg_wealth,R.id.rg_account}) public void OnCheckedChangeListener(CompoundButton view, boolean ischanged ){ switch (view.getId()) { case R.id.rg_home: if (ischanged){//注意：這裏必定要有這個判斷，只有對應該id的按鈕被點擊了，ischanged狀態發生改變，纔會執行下面的內容 //這裏寫你的按鈕變化狀態的UI及相關邏輯 } break; case R.id.rg_wealth: if (ischanged) { //這裏寫你的按鈕變化狀態的UI及相關邏輯 } break; case R.id.rg_account: if (ischanged) { //這裏寫你的按鈕變化狀態的UI及相關邏輯 } break; default: break; } }

▲ 使用findById：

Butter Knife仍然包含了findById()方法，用於仍需從一個view ，Activity，或者Dialog上初始化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 iv = ButterKnife.findById(view, R.id.iv);

▲ 設置多個view的屬性：

apply()

做用：容許您當即對列表中的全部視圖進行操做。

Action和Setter接口

做用：Action和Setter接口容許指定簡單的行爲。

public class MainActivity extends AppCompatActivity { @BindViews({R2.id.first_name, R2.id.middle_name, R2.id.last_name}) List<EditText> nameViews; @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_main); //綁定activity ButterKnife.bind(this); //設置多個view的屬性 //方式1：傳遞值 ButterKnife.apply(nameViews, DISABLE); //方式2：指定值 ButterKnife.apply(nameViews, ENABLED, false); ////方式3 設置View的Property ButterKnife.apply(nameViews, View.ALPHA, 0.0f);//一個Android屬性也能夠用於應用的方法。 } /* * Action接口設置屬性 */ static final ButterKnife.Action<View> DISABLE = new ButterKnife.Action<View>() { @Override public void apply(View view, int index) { view.setEnabled(false);//目的是使多個view都具有此屬性 } }; /* * 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);//目的是使多個view都具有此屬性，可變boolean值是能夠傳遞的 } }; }

▲ 使用注意事項：

ButterKinfe的註解標籤因版本不一樣而有所變化。
8.0.0以前的Bind標籤在8.0.0以後變成了BindView，而8.7.0以後在綁定view時，要用R2.id.XXX而再也不是經常使用的R.id.XXX了。

具體變化狀況和查看gitHub上的提交日誌：
https://github.com/JakeWharton/butterknife/blob/master/CHANGELOG.md#version-800-2016-04-25

默認狀況下，@bind和 listener 的綁定是必需的。若是沒法找到目標視圖，將拋出一個異常。
要抑制此行爲並建立可選綁定，能夠將@Nullable註解添加到字段中，或將@Optional註解添加到方法。

任何被命名爲@Nullable的註解均可以用於成員變量。建議使用android的」support-annotations」庫中的@Nullable註解。

@Nullable @BindView(R.id.might_not_be_there) TextView mightNotBeThere; @Optional @OnClick(R.id.maybe_missing) public void onMaybeMissingClicked() { // TODO ... }

▲ 更多綁定註解：

@BindView—->綁定一個view；id爲一個view 變量

@BindViews —-> 綁定多個view；id爲一個view的list變量

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

▲ 更多事件註解：

@OnClick—->點擊事件

@OnCheckedChanged —->選中，取消選中

@OnEditorAction —->軟鍵盤的功能鍵

@OnFocusChange —->焦點改變

@OnItemClick item—->被點擊(注意這裏有坑，若是item裏面有Button等這些有點擊的控件事件的，須要設置這些控件屬性focusable爲false)

@OnItemLongClick item—->長按(返回真能夠攔截onItemClick)

@OnItemSelected —->item被選擇事件

@OnLongClick —->長按事件

@OnPageChange —->頁面改變事件

@OnTextChanged —->EditText裏面的文本變化事件

@OnTouch —->觸摸事件

@Optional —->選擇性注入，若是當前對象不存在，就會拋出一個異常，爲了壓制這個異常，能夠在變量或者方法上加入一下註解,讓注入變成選擇性的,若是目標View存在,則注入, 不存在,則什麼事情都不作

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

ButterKnife的代碼混淆

在混淆文件中，添加以下代碼：

-keep class butterknife.** { *; } -dontwarn butterknife.internal.** -keep class **$$ViewBinder { *; } -keepclasseswithmembernames class * { @butterknife.* <fields>; } -keepclasseswithmembernames class * { @butterknife.* <methods>; }

Butterknife插件：zelezny

插件安裝：

工具欄File 找到Settings…或者使用快捷點Ctrl+Alt+s 打開。搜索zelezny下載插件並安裝，重啓Android Studio

image

插件使用：

安裝完成插件後，會提示重啓AS，重啓完後，能夠寫一個佈局而且新建一個代碼類測試下。測試的過程當中要注意的是，須要將光標移到setContentView(R.layout.acty_login)，將光標放到R.layout.acty_login，而後右鍵Generate就有了。這裏引用一張gif效果圖，更直觀表現出插件帶來的優點。對於多個須要綁定的id，省下了須要本身手動敲打代碼的時間。

做者：lisx_ 連接：https://www.jianshu.com/p/3678aafdabc7 來源：簡書簡書著做權歸做者全部，任何形式的轉載都請聯繫做者得到受權並註明出處。