Android 之ButterKnife配置和使用详解

• ButterKnife 简介

  ButterKnife是一个专注于Android系统的View注入框架,可以减少大量的findViewById以及setOnClickListener代码，可视化一键生成。

• ButterKnife 优势

  1、强大的View绑定和Click事件处理功能，简化代码，提升开发效率
  2、方便的处理Adapter里的ViewHolder绑定问题
  3、运行时不会影响APP效率，使用配置方便
  4、代码清晰，可读性强

• Butter Knife 配置及使用入门详解

  
  

配置

配置Butter Knife 只需要3个步骤: 
1. 安装AS插件 Android ButterKnife Zelezny 
2. 在项目中添加项目依赖 
3. 开始使用注解

步骤1

首先打开AS, 打开 Settings -> Plugins -> 搜索Android ButterKnife Zelezny, 找到插件点击安装. 我下面的截图是安装之后的, 大家都懂, 不用多解释.重启生效 

步骤2

创建Android项目, 分别找到Project Gradle配置文件和Modle Gradle配置文件. 

在Project Gradle 配置文件中添加:

// Top-level build file where you can add configuration options common to all sub-projects/modules.buildscript {    repositories {        jcenter()    }    dependencies {        classpath 'com.android.tools.build:gradle:2.0.0'        classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8' // 添加这行    }}allprojects {    repositories {        jcenter()    }}task clean(type: Delete) {    delete rootProject.buildDir}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

再在 Module Gradle配置文件中添加:

apply plugin: 'com.android.application'android {    compileSdkVersion 24    buildToolsVersion "24.0.0"    defaultConfig {        applicationId "org.yxm.butterknifesimple"        minSdkVersion 15        targetSdkVersion 24        versionCode 1        versionName "1.0"    }    buildTypes {        release {            minifyEnabled false            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'        }    }}apply plugin: 'com.neenbedankt.android-apt' //添加这行dependencies {    compile fileTree(dir: 'libs', include: ['*.jar'])    testCompile 'junit:junit:4.12'    compile 'com.android.support:appcompat-v7:24.0.0'    compile 'com.jakewharton:butterknife:8.2.1' //添加这行    apt 'com.jakewharton:butterknife-compiler:8.2.1' //添加这行}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

然后点击 Sync Now, 更新配置, 稍等片刻等待完成 

如何使用

• 控件id 注解： @BindView（）

package com.zyj.wifi;import android.support.v7.app.AppCompatActivity;import android.os.Bundle;import android.widget.Button;import butterknife.BindView;import butterknife.ButterKnife;public class ButterknifeActivity extends AppCompatActivity {    @BindView( R.id.button1 )    public Button button1 ;        // 注意：button 的修饰类型不能是：private 或者 static 。 否则会报错：错误: @BindView fields must not be private or static. (com.zyj.wifi.ButterknifeActivity.button1)    @Override    protected void onCreate(Bundle savedInstanceState) {        super.onCreate(savedInstanceState);        setContentView(R.layout.activity_butterknife);        //绑定activity        ButterKnife.bind( this ) ;        button1.setText( "I am a button ");    }}

• 多个控件id 注解： @BindViews（）

package com.zyj.wifi;import android.support.v7.app.AppCompatActivity;import android.os.Bundle;import android.widget.Button;import java.util.List;import butterknife.BindViews;import butterknife.ButterKnife;public class Main2Activity extends AppCompatActivity {    @BindViews({ R.id.button1  , R.id.button2 ,  R.id.button3 })    public List<Button> buttonList ;    @Override    protected void onCreate(Bundle savedInstanceState) {        super.onCreate(savedInstanceState);        setContentView(R.layout.activity_main2);        ButterKnife.bind(this);        buttonList.get( 0 ).setText( "hello 1 ");        buttonList.get( 1 ).setText( "hello 2 ");        buttonList.get( 2 ).setText( "hello 3 ");    }}

• fragment 使用

package com.zyj.wifi;import android.os.Bundle;import android.support.v4.app.Fragment;import android.view.LayoutInflater;import android.view.View;import android.view.ViewGroup;import android.widget.Button;import butterknife.BindView;import butterknife.ButterKnife;public class ButterknifeFragment extends Fragment {    @BindView( R.id.button1 )    public Button button1 ;    @Override    public View onCreateView(LayoutInflater inflater, ViewGroup container,                             Bundle savedInstanceState) {        View view = inflater.inflate(R.layout.fragment_butterknife, container, false);        //绑定fragment        ButterKnife.bind( this , view ) ;        button1.setText( "I am a button ");        return view ;    }}

• @BindString() ：绑定string 字符串

package com.zyj.wifi;import android.os.Bundle;import android.support.v7.app.AppCompatActivity;import android.widget.Button;import butterknife.BindString;import butterknife.BindView;import butterknife.ButterKnife;public class ButterknifeActivity extends AppCompatActivity {    @BindView( R.id.button1 ) //绑定button 控件    public Button button1 ;    @BindString( R.string.app_name )  //绑定string 字符串    String meg;    @Override    protected void onCreate(Bundle savedInstanceState) {        super.onCreate(savedInstanceState);        setContentView(R.layout.activity_butterknife);        //绑定activity        ButterKnife.bind( this ) ;        button1.setText( meg );    }}

• @BindArray() : 绑定string里面array数组

<resources>    <string name="app_name">WiFi管家</string>        <string-array name="city">        <item>厦门市</item>        <item>福州市</item>        <item>泉州市</item>        <item>漳州市</item>        <item>龙岩市</item>    </string-array>    </resources>package com.zyj.wifi;import android.os.Bundle;import android.support.v7.app.AppCompatActivity;import android.widget.Button;import butterknife.BindArray;import butterknife.BindView;import butterknife.ButterKnife;public class ButterknifeActivity extends AppCompatActivity {    @BindView( R.id.button1 ) //绑定button 控件    public Button button1 ;    @BindArray(R.array.city )  //绑定string里面array数组    String [] citys ;    @Override    protected void onCreate(Bundle savedInstanceState) {        super.onCreate(savedInstanceState);        setContentView(R.layout.activity_butterknife);        //绑定activity        ButterKnife.bind( this ) ;        button1.setText( citys[0] );    }}

• @BindBitmap( ) : 绑定Bitmap 资源

package com.zyj.wifi;import android.graphics.Bitmap;import android.os.Bundle;import android.support.v7.app.AppCompatActivity;import android.widget.ImageView;import butterknife.BindBitmap;import butterknife.BindView;import butterknife.ButterKnife;public class ButterknifeActivity extends AppCompatActivity {    @BindView( R.id.imageView ) //绑定ImageView 控件    public ImageView imageView ;    @BindBitmap( R.mipmap.wifi )  //绑定Bitmap 资源    public Bitmap wifi_bitmap ;    @Override    protected void onCreate(Bundle savedInstanceState) {        super.onCreate(savedInstanceState);        setContentView(R.layout.activity_butterknife);        //绑定activity        ButterKnife.bind( this ) ;        imageView.setImageBitmap( wifi_bitmap );    }}

• @BindColor( ) : 绑定一个颜色值

package com.zyj.wifi;import android.os.Bundle;import android.support.v7.app.AppCompatActivity;import android.widget.Button;import butterknife.BindColor;import butterknife.BindView;import butterknife.ButterKnife;public class ButterknifeActivity extends AppCompatActivity {    @BindView( R.id.button1 )  //绑定一个控件    public Button button1 ;    @BindColor( R.color.colorAccent ) int black ;  //绑定一个颜色值    @Override    protected void onCreate(Bundle savedInstanceState) {        super.onCreate(savedInstanceState);        setContentView(R.layout.activity_butterknife);        //绑定activity        ButterKnife.bind( this ) ;        button1.setTextColor(  black );    }}

• @OnClick( ) : 绑定控件点击事件
• @OnLongClick( ) ： 绑定控件长按事件

package com.zyj.wifi;import android.os.Bundle;import android.support.v7.app.AppCompatActivity;import android.widget.Toast;import butterknife.ButterKnife;import butterknife.OnClick;import butterknife.OnLongClick;public class ButterknifeActivity extends AppCompatActivity {    @OnClick(R.id.button1 )   //给 button1 设置一个点击事件    public void showToast(){        Toast.makeText(this, "is a click", Toast.LENGTH_SHORT).show();    }    @OnLongClick( R.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_butterknife);        //绑定activity        ButterKnife.bind( this ) ;    }}

给EditText加addTextChangedListener（即添加多回调方法的监听的使用方法），利用指定回调，实现想回调的方法即可，哪个注解不会用点进去看下源码上的注释就会用了

[java] view plain copy

1. @OnTextChanged(value = R.id.mobileEditText, callback = OnTextChanged.Callback.BEFORE_TEXT_CHANGED)  
2. void beforeTextChanged(CharSequence s, int start, int count, int after) {  
3.   
4. }  
5. @OnTextChanged(value = R.id.mobileEditText, callback = OnTextChanged.Callback.TEXT_CHANGED)  
6. void onTextChanged(CharSequence s, int start, int before, int count) {  
7.   
8. }  
9. @OnTextChanged(value = R.id.mobileEditText, callback = OnTextChanged.Callback.AFTER_TEXT_CHANGED)  
10. void afterTextChanged(Editable s) {  
11.   
12. }  

对一组View进行统一操作

装入一个list

[java] view plain copy

1. @Bind({ R.id.first_name, R.id.middle_name, R.id.last_name })  
2. List<EditText> nameViews;  

设置统一处理

[java] view plain copy

1. static final ButterKnife.Action<View> DISABLE = new ButterKnife.Action<View>() {  
2.   @Override public void apply(View view, int index) {  
3.     view.setEnabled(false);  
4.   }  
5. };  
6. static final ButterKnife.Setter<View, Boolean> ENABLED = new ButterKnife.Setter<View, Boolean>() {  
7.   @Override public void set(View view, Boolean value, int index) {  
8.     view.setEnabled(value);  
9.   }  
10. };  

统一操作处理，例如设置是否可点，属性等

[java] view plain copy

1. ButterKnife.apply(nameViews, DISABLE);  
2. ButterKnife.apply(nameViews, ENABLED, false);  

可选绑定：默认情况下，“绑定”和“监听”绑定都是必需的。如果不能找到目标视图，则将抛出异常。所以做空处理

[java] view plain copy

1. @Nullable @Bind(R.id.might_not_be_there) TextView mightNotBeThere;  
2.   
3. @Nullable @OnClick(R.id.maybe_missing) void onMaybeMissingClicked() {  
4.   // TODO ...  
5. }