ButterKnife的使用詳解

1,概述:
ButterKnife則是注解中相對簡單易懂的很不錯的開源框架.
ButterKnife是目前常用的一種依托Java注解機制實現輔助代碼生成的框架；用到了注解處理器。
它是一個專注於Android系統的View注入框架,將Android視圖和回調方法綁定到成員變量和方法上；可視化一鍵生成；可以減少大量的findViewById以及setOnClickListener代碼，是注解中相對簡單易懂的開源框架 。

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

翻譯:黃油刀/
英文使用說明地址：http://jakewharton.github.io/butterknife/
API文檔地址：http://jakewharton.github.io/butterknife/javadoc/

 

2,ButterKnife 優勢：
1.強大的View綁定和Click事件處理功能，簡化代碼，提升開發效率
2.方便的處理Adapter里的ViewHolder綁定問題
3.運行時不會影響APP效率，使用配置方便
4.代碼清晰，可讀性強
3,注意事項
使用心得：
1.Activity ButterKnife.bind(this);必須在setContentView();之后，且父類bind綁定后，子類不需要再bind
2.Fragment ButterKnife.bind(this, mRootView);
3.屬性布局不能用private or static 修飾，否則會報錯
4.setContentView()不能通過注解實現。（其他的有些注解框架可以）
官網http://jakewharton.github.io/butterknife/
4,安裝Butterknife插件自動生成功能.
file-->setting-->plugins-->Browse repositories-->
Android ButterKnife Zelezny-->install
-->點擊Restart激活已安裝的插件
5,項目配置：
1,在module的build.gradle 文件中的dependencies標簽中添加代碼如下（導入庫的依賴）:
dependencies {
//compile 'com.jakewharton:butterknife:8.8.1'
implementation 'com.jakewharton:butterknife:8.8.1'
annotationProcessor 'com.jakewharton:butterknife-compiler:8.8.1'
}
6,Butter Knife的注冊綁定
6.1使用注意事項
（注：不理解可以繼續往下看，都有詳細說明，或者自己動手寫寫就明白了。）
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 or 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回調方法中使用它。

6.2在Activity中綁定ButterKnife
ButterKnife.bind(this);

6.3在Fragment中綁定ButterKnife
ButterKnife.bind(this, view);

6.4在Adapter中綁定ButterKnife
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("諾諾");
// etc...

return view;
}

static class ViewHolder {
@BindView(R.id.title) TextView name;
@BindView(R.id.job_title) TextView jobTitle;

public ViewHolder(View view) {
ButterKnife.bind(this, view);
}
}
}

 

7,Butter Knife的使用
1.快速生成注解view和onclick代碼
//首先將鼠標放置在初始化view布局文件的位置上，然后按快捷鍵Shift+Alt+S --> Alt+Insert -->Ctrl+Shif+F12，
//最后選擇生成view和點擊事件。

 

 

2.使用注意事項
1）ButterKinfe的注解標簽因版本不同而有所變化。8.0.0之前的Bind標簽在8.0.0之后變成了BindView，
2）默認情況下，@bind和 listener 的綁定是必需的。如果無法找到目標視圖，將拋出一個異常。
要抑制此行為並創建可選綁定，可以將@Nullable注解添加到字段中，或將@Optional注解添加到方法。

 

3.綁定注解
@BindView---->綁定一個view；id為一個view 變量
@BindView(R.id.tv_fm1)
TextView tvFm1;
@BindViews ---->綁定多個view；id為一個view的list變量
@BindViews({ R.id.btn1,R.id.btn2 })
List<Button> buttons;
@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;

 

 

4,事件注解
@OnClick---->點擊事件
@OnCheckedChanged ---->選中，取消選中
@OnEditorAction ---->軟鍵盤的功能鍵
@OnFocusChange ---->焦點改變
@OnItemClick item---->被點擊(注意這里有坑，如果item里面有Button等這些有點擊的控件事件的，需要設置這些控件屬性focusable為false)
@OnItemLongClick item---->長按(返回真可以攔截onItemClick)
@OnItemSelected ---->item被選擇事件
@OnLongClick ---->長按事件
@OnPageChange ---->頁面改變事件
@OnTextChanged ---->EditText里面的文本變化事件
@OnTouch ---->觸摸事件

 

 

5,綁定view

1）@BindView() : 布局id 注解
@BindView( R2.id.button)
public Button button;
button 的修飾類型不能是：private 或者 static 。

2）@BindViews(): 布局內多個控件 id 注解
@BindViews({ R2.id.button1, R2.id.button2, R2.id.button3})
public List<Button> buttonList ;
ButterKnife.bind(this);
buttonList.get( 0 ).setText( "hello 1 ");
buttonList.get( 1 ).setText( "hello 2 ");
buttonList.get( 2 ).setText( "hello 3 ");

 

 

 

6.綁定資源
1）@BindString() ：綁定string 字符串
@BindString(R2.string.app_name) //綁定資源文件中string字符串
String str;
button.setText( str );

2）@BindArray() : 綁定string里面array數組
@BindArray(R2.array.city) //綁定string里面array數組
String [] citys ;
button.setText(citys[0]);

3）@BindBitmap( ) : 綁定Bitmap 資源
@BindBitmap(R2.drawable.bm)//綁定Bitmap 資源
public Bitmap bitmap ;
imageView.setImageBitmap(bitmap);
drawable文件夾下的圖片使用R或R2引用都沒問題；但是mipmap文件夾下的圖片資源引用目前只能使用R

4）@BindColor( ) : 綁定一個顏色值
@BindColor( R2.color.colorAccent ) //具體色值在color文件中
int black ; //綁定一個顏色值
button.setTextColor( black );

 

 

 

7,點擊事件綁定
不用聲明view，不用setOnClickLisener（）就可以綁定點擊事件
1）綁定事件
@OnClick( ) : 綁定控件點擊事件
@OnLongClick( ) ： 綁定控件長按事件
@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 ;
}

2）指定多個id綁定事件
@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;
}
}
多條點擊事件不可以用R2的方式
如果一定要使用R2的寫法，可以單一逐次寫

3）自定義View使用注解事件
不用指定id，直接注解OnClick
public class MyButton extends Button {
@OnClick
public void onClick() {}
}

 

 

8,.使用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);

 

 

9,設置多個view的屬性
允許您立即對列表中的所有視圖進行操作
apply()

Action和Setter接口允許指定簡單的行為
Action和Setter接口
public class ButterknifeActivity 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_butterknife);

//綁定activity
ButterKnife.bind(this);
//看不懂的小伙伴，多敲幾遍代碼，實際操作一下自然就懂了。相信我！如果你重復敲了10遍以上的代碼，並認真思考了還沒懂，歡迎給我評論留言。

//設置多個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值是可以傳遞的
}
};
}
8,Butter Knife的代碼混淆
在混淆文件中，添加如下代碼：
-keep class butterknife.** { *; }
-dontwarn butterknife.internal.**
-keep class **$$ViewBinder { *; }

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

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

代碼實現：

 

public class MainActivity extends AppCompatActivity {

    @BindView(R.id.tv)
    TextView tv;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        ButterKnife.bind(this);
        tv.setText("ButterKnife,在Activity中使用!");
    }


    @OnClick(R.id.tv)
    public void onViewClicked() {
        DemonstrateUtil.showToastResult(this,"布局中含有Fragment!");
    }
}

 

 

 

 

 

 

 

public class TempActivity extends AppCompatActivity {

    @BindView(R.id.btn)
    Button btn;
    @BindView(R.id.tv)
    TextView tv;
    @BindView(R.id.iv)
    ImageView iv;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_temp);
        ButterKnife.bind(this);
        tv.setTextColor(getResources().getColor(R.color.colorAccent));
        tv.setText("ButterKnife!");
    }

    @OnClick(R.id.btn)
    public void onViewClicked() {
        DemonstrateUtil.showLogResult("OnClick");
        DemonstrateUtil.showToastResult(this,"OnClick");
    }

 

 

 

 

public class Temp2Activity extends AppCompatActivity {

    @BindView(R.id.iv1)
    ImageView iv1;
    @BindView(R.id.tv1)
    TextView tv1;

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

    @OnClick(R.id.tv1)
    public void onViewClicked() {
    }
}

 

 

 

public class MyAdapter extends BaseAdapter {



    private List<ItemInfo> mList;

    public MyAdapter(List<ItemInfo> list) {
        mList = list;
    }

    @Override
    public int getCount() {
        return mList == null ? 0 : mList.size();
    }

    @Override
    public Object getItem(int position) {
        return mList.get(position);
    }

    @Override
    public long getItemId(int position) {
        return position;
    }

    @Override
    public View getView(int position, View convertView, ViewGroup parent) {
        ViewHolder viewHolder = null;
        if (convertView == null) {
            convertView = View.inflate(parent.getContext(), R.layout.item_list, null);
            viewHolder = new ViewHolder(convertView);
            convertView.setTag(viewHolder);
        } else {
            viewHolder = (ViewHolder) convertView.getTag();
        }
        viewHolder.tvItem.setText(mList.get(position).name);
        if (position % 2 == 0) {
            viewHolder.iv.setImageBitmap(viewHolder.bitmap);
        }else {
            viewHolder.iv.setImageResource(R.mipmap.ic_launcher_round);
        }
        return convertView;
    }

    static class ViewHolder {
        @BindView(R.id.tv_item)
        TextView tvItem;
        @BindView(R.id.iv)
        ImageView iv;
        @BindBitmap(R.mipmap.ic_launcher)
        Bitmap bitmap;
        ViewHolder(View view) {
            ButterKnife.bind(this, view);
        }
    }

}

 

 

 

public class BlankFragment extends Fragment {


    @BindView(R.id.tv_fm1)
    TextView tvFm1;
    Unbinder unbinder;
    @BindViews({ R.id.btn1,R.id.btn2 })
    List<Button> buttons;
    @BindColor(R.color.colorAccent)
    int colorAccent;


    @Override
    public View onCreateView(LayoutInflater inflater, ViewGroup container,
                             Bundle savedInstanceState) {
        View view = View.inflate(getContext(), R.layout.fragment_blank, null);
        unbinder = ButterKnife.bind(this, view);
        tvFm1.setText("fragment中使用ButterKnife!");
        tvFm1.setTextColor(colorAccent);
        Button btn2 = buttons.get(1);
        btn2.setText("適配器使用ButterKnife");
        return view;
    }

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

    @OnClick({R.id.btn1, R.id.btn2})
    public void onViewClicked(View view) {
        switch (view.getId()) {
            case R.id.btn1:
                DemonstrateUtil.showToastResult(getContext(),"fragment中的第1個按鈕!");
                break;
            case R.id.btn2:
                startActivity(new Intent(getActivity(),AdpActivity.class));
                break;
        }
    }
}

 

 

 

public class AdpActivity extends AppCompatActivity {

    @BindView(R.id.lv)
    ListView lv;

    @BindArray(R.array.names)
    String[] names;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_adp);
        ButterKnife.bind(this);
        List<ItemInfo> list = new ArrayList<>();
        for (int i = 0; i < names.length; i++) {
            ItemInfo info = new ItemInfo();
            info.name = names[i];
            info.age = "age"+i;
            list.add(info);
        }
        lv.setAdapter(new MyAdapter(list));
    }

}