Android使用ButterKnife

參考資料：

• Android Butterknife使用方法總結
• Android Studio3.0更新之路（遇坑必入）
• AndroidStudio3.1.2 報錯：Could not get unknown property ‘packageForR’ for task ':app:processDebugResour
• ButterKnife官方文件

簡介

ButterKnife是一個專注於Android系統的View注入框架,可以減少大量的findViewById以及setOnClickListener程式碼。最重要的一點，使用ButterKnife對效能基本沒有損失，因為ButterKnife用到的註解並不是在執行時反射的，而是在編譯的時候生成新的class。專案整合起來也是特別方便，使用起來也是特別簡單。

ButterKnife的優勢：

1. 強大的View繫結和Click事件處理功能，簡化程式碼，提升開發效率
2. 方便的處理Adapter裡的ViewHolder繫結問題
3. 執行時不會影響APP效率，使用配置方便
4. 程式碼清晰，可讀性強

在android Studio專案中配置使用ButterKnife

1. 在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'  //新增這一行
       }
   }
    
   

2. 在App的 build.gradle 中新增如下程式碼：

   apply plugin: 'com.jakewharton.butterknife'

   dependencies中新增：

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

解決配置中遇到的問題：

1. Android Studio3.0 報錯Gradle sync failed: Cause: com.android.build.gradle.api.BaseVariant.getOutputs()Ljava/util/List;

   解決方法：把專案中依賴的ButterKnife降級到8.4.0。

2. Android Studio3.* 報錯Could not get unknown property 'packageForR' for task ':app:processDebugResour

   解決方法：刪除在App的 build.gradle 中的apply plugin: 'com.jakewharton.butterknife'。

ButterKnife的註冊與繫結

ButterKnife使用心得與注意事項：

1. 在Activity 類中繫結：ButterKnife.bind(this);必須在setContentView();之後繫結；且父類bind繫結後，子類不需要再bind。

2. 在非Activity 類（eg：Fragment、ViewHold）中繫結：ButterKnife.bind(this，view);，這裡的this不能替換成getActivity()。

3. 在Activity中不需要做解綁操作，在Fragment 中必須在onDestroyView()中做解綁操作。

4. 使用ButterKnife修飾的方法和控制元件，不能用private或static 修飾，否則會報錯。

5. setContentView()不能通過註解實現。（其他的有些註解框架可以）

6. 使用Activity為根檢視繫結任意物件時，如果你使用類似MVC的設計模式，你可以在Activity 呼叫ButterKnife.bind(this, activity)，來繫結Controller。

7. 使用ButterKnife.bind(this，view)繫結一個view的子節點欄位。如果你在子View的佈局裡或者自定義view的構造方法裡 使用了inflate,你可以立刻呼叫此方法。或者，從XML inflate來的自定義view型別可以在onFinishInflate回撥方法中使用它。

1. 在Activity中繫結ButterKnife

繫結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);  
    }  
}

2. 在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();  
    }  
}

3. 在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 );  
      }  
  }  
  

事件繫結

• 繫結點選事件：

  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

外掛使用

安裝完成外掛後，會提示重啟AS，重啟完後，可以寫一個佈局並且新建一個程式碼類測試下。測試的過程中要注意的是，需要將游標移到setContentView(R.layout.acty_login)，將游標放到R.layout.acty_login，然後右鍵Generate就有了。這裡引用一張gif效果圖，更直觀表現出外掛帶來的優勢。對於多個需要繫結的id，省下了需要自己手動敲打程式碼的時間。