Butterknife全方位解析

  1. 云栖社区>
  2. 博客>
  3. 正文

Butterknife全方位解析

玄学酱 2017-08-03 15:15:00 浏览836

概述

Butterknife是供职于Square公司的JakeWharton大神开发的开源库,使用这个库,在AS中搭配Android ButterKnife Zelezny插件,可以大大提高开发的效率,从此摆脱繁琐的findViewById(int id),也不用自己手动@bind(int id) , 直接用插件生成即可。本篇博客将对Butterknife进行深入解析。

项目地址: JakeWharton/butterknife

ButterKnife有以下优点:

1、强大的View绑定和Click事件处理功能,简化代码,提升开发效率

2、方便的处理Adapter里的ViewHolder绑定问题

3、运行时不会影响APP效率,使用配置方便

4、代码清晰,可读性强

如何导入ButterKnife

在项目的build.grade文件中进行如下配置:


  1. buildscript { 
  2.     repositories { 
  3.         jcenter() 
  4.         mavenCentral() 
  5.         maven { 
  6.             url "https://plugins.gradle.org/m2/" 
  7.         } 
  8.     } 
  9.     dependencies { 
  10.         classpath 'com.android.tools.build:gradle:2.2.0' 
  11.         //这里配置 apt 供butterknife使用 
  12.         classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8' 
  13.  
  14.     } 
  15.  

例如:


  1. buildscript { 
  2.     repositories { 
  3.         jcenter() 
  4.         mavenCentral() 
  5.         maven { 
  6.             url "https://plugins.gradle.org/m2/" 
  7.         } 
  8.  
  9.     } 
  10.  
  11.     dependencies { 
  12.         classpath 'com.android.tools.build:gradle:2.2.2' 
  13.         classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8' 
  14.     } 
  15.  
  16. allprojects { 
  17.     repositories { 
  18.         jcenter() 
  19.     } 
  20.  
  21. task clean(type: Delete) { 
  22.     delete rootProject.buildDir 
  23.  

在app的build.grade文件中进行如下配置:


  1. apply plugin: 'com.android.application' 
  2. apply plugin: 'com.neenbedankt.android-apt' 
  3.  
  4. android{...} 
  5.  
  6. dependencies { 
  7.     //视图绑定 butterknife 
  8.     compile 'com.jakewharton:butterknife:8.4.0' 
  9.     apt 'com.jakewharton:butterknife-compiler:8.4.0' 
  10.  

例如:


  1. apply plugin: 'com.android.application' 
  2. apply plugin: 'android-apt' 
  3.  
  4. android { 
  5.     compileSdkVersion 24 
  6.     buildToolsVersion "24.0.3" 
  7.  
  8.     defaultConfig { 
  9.  
  10.         minSdkVersion 14 
  11.         targetSdkVersion 24 
  12.         versionCode 1 
  13.         versionName "1.0" 
  14.     } 
  15.     buildTypes { 
  16.         release { 
  17.             minifyEnabled false 
  18.             proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro' 
  19.         } 
  20.     } 
  21.  
  22. dependencies { 
  23.     compile fileTree(dir: 'libs', include: ['*.jar']) 
  24.  
  25.     compile 'com.jakewharton:butterknife:8.4.0' 
  26.     apt 'com.jakewharton:butterknife-compiler:8.4.0' 
  27.  

如何使用ButterKnife

1) 由于每次都要在Activity中的onCreate绑定Activity,所以个人建议写一个BaseActivity完成绑定,子类继承即可

注:ButterKnife.bind(this);绑定Activity 必须在setContentView之后:

实现如下(FragmentActivity 实现一样):


  1. public abstract class BaseActivity extends Activity {   
  2.     public abstract int getContentViewId();   
  3.  
  4.     @Override   
  5.     protected void onCreate(Bundle savedInstanceState) {   
  6.         super.onCreate(savedInstanceState);   
  7.         setContentView(getContentViewId());   
  8.         ButterKnife.bind(this);   
  9.         initAllMembersView(savedInstanceState);   
  10.     }   
  11.  
  12.     protected abstract void initAllMembersView(Bundle savedInstanceState);   
  13.  
  14.     @Override   
  15.     protected void onDestroy() {   
  16.         super.onDestroy();   
  17.         ButterKnife.unbind(this);//解除绑定,官方文档只对fragment做了解绑   
  18.     }   
  19. }    

2) 绑定fragment


  1. public abstract class BaseFragment extends Fragment {   
  2.     public abstract int getContentViewId();   
  3.     protected Context context;   
  4.     protected View mRootView;   
  5.  
  6.     @Nullable   
  7.     @Override   
  8.     public View onCreateView(LayoutInflater inflater, @Nullable ViewGroup container, @Nullable Bundle savedInstanceState) {   
  9.         mRootView =inflater.inflate(getContentViewId(),container,false);   
  10.         ButterKnife.bind(this,mRootView);//绑定framgent   
  11.         this.context = getActivity();   
  12.         initAllMembersView(savedInstanceState);   
  13.         return mRootView;   
  14.     }   
  15.  
  16.     protected abstract void initAllMembersView(Bundle savedInstanceState);   
  17.  
  18.     @Override   
  19.     public void onDestroyView() {   
  20.         super.onDestroyView();   
  21.         ButterKnife.unbind(this);//解绑   
  22.     }   
  23. }    

3) 控件id 注解: @BindView()


  1. package com.myl.test; 
  2.  
  3. import android.support.v7.app.AppCompatActivity; 
  4. import android.os.Bundle; 
  5. import android.widget.Button; 
  6.  
  7. import butterknife.BindView; 
  8. import butterknife.ButterKnife; 
  9.  
  10. public class ButterknifeActivity extends AppCompatActivity { 
  11.  
  12.     @BindView( R.id.button1 ) 
  13.     public Button button1 ; 
  14.  
  15.     // 注意:button 的修饰类型不能是:private 或者 static 。 否则会报错:错误: @BindView fields must not be private or static. (com.myl.test.ButterknifeActivity.button1) 
  16.  
  17.     @Override 
  18.     protected void onCreate(Bundle savedInstanceState) { 
  19.         super.onCreate(savedInstanceState); 
  20.         setContentView(R.layout.activity_butterknife); 
  21.         //绑定activity 
  22.         ButterKnife.bind( this ) ; 
  23.  
  24.         button1.setText( "I am a button "); 
  25.     } 
  26.  

4) 多个控件id 注解: @BindViews()


  1. package com.myl.test; 
  2.  
  3. import android.support.v7.app.AppCompatActivity; 
  4. import android.os.Bundle; 
  5. import android.widget.Button; 
  6. import java.util.List; 
  7. import butterknife.BindViews; 
  8. import butterknife.ButterKnife; 
  9.  
  10. public class Main2Activity extends AppCompatActivity { 
  11.  
  12.     @BindViews({ R.id.button1  , R.id.button2 ,  R.id.button3 }) 
  13.     public List<Button> buttonList ; 
  14.  
  15.     @Override 
  16.     protected void onCreate(Bundle savedInstanceState) { 
  17.         super.onCreate(savedInstanceState); 
  18.         setContentView(R.layout.activity_main2); 
  19.  
  20.         ButterKnife.bind(this); 
  21.  
  22.         buttonList.get( 0 ).setText( "hello 1 "); 
  23.         buttonList.get( 1 ).setText( "hello 2 "); 
  24.         buttonList.get( 2 ).setText( "hello 3 "); 
  25.     } 
  26.  

5) @BindString() :绑定string 字符串


  1. package com.myl.test; 
  2.  
  3. import android.os.Bundle; 
  4. import android.support.v7.app.AppCompatActivity; 
  5. import android.widget.Button; 
  6.  
  7. import butterknife.BindString; 
  8. import butterknife.BindView; 
  9. import butterknife.ButterKnife; 
  10.  
  11. public class ButterknifeActivity extends AppCompatActivity { 
  12.  
  13.     @BindView( R.id.button1 ) //绑定button 控件 
  14.     public Button button1 ; 
  15.  
  16.     @BindString( R.string.app_name )  //绑定string 字符串 
  17.     String meg; 
  18.  
  19.     @Override 
  20.     protected void onCreate(Bundle savedInstanceState) { 
  21.         super.onCreate(savedInstanceState); 
  22.         setContentView(R.layout.activity_butterknife); 
  23.  
  24.         //绑定activity 
  25.         ButterKnife.bind( this ) ; 
  26.  
  27.         button1.setText( meg ); 
  28.     } 
  29.  

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


  1. <resources> 
  2.     <string name="app_name">校园助手</string> 
  3.  
  4.     <string-array name="city"
  5.         <item>东莞市</item> 
  6.         <item>广州市</item> 
  7.         <item>珠海市</item> 
  8.         <item>肇庆市</item> 
  9.         <item>深圳市</item> 
  10.     </string-array> 
  11.  
  12. </resources> 
  13. ----------------------------------------------------------------- 
  14. package com.myl.test; 
  15.  
  16. import android.os.Bundle; 
  17. import android.support.v7.app.AppCompatActivity; 
  18. import android.widget.Button; 
  19.  
  20. import butterknife.BindArray; 
  21. import butterknife.BindView; 
  22. import butterknife.ButterKnife; 
  23.  
  24. public class ButterknifeActivity extends AppCompatActivity { 
  25.  
  26.     @BindView( R.id.button1 ) //绑定button 控件 
  27.     public Button button1 ; 
  28.  
  29.     @BindArray(R.array.city )  //绑定string里面array数组 
  30.     String [] citys ; 
  31.  
  32.     @Override 
  33.     protected void onCreate(Bundle savedInstanceState) { 
  34.         super.onCreate(savedInstanceState); 
  35.         setContentView(R.layout.activity_butterknife); 
  36.  
  37.         //绑定activity 
  38.         ButterKnife.bind( this ) ; 
  39.  
  40.         button1.setText( citys[0] ); 
  41.     } 
  42.  

7) @BindBitmap( ) : 绑定Bitmap 资源


  1. package com.myl.test; 
  2.  
  3. import android.graphics.Bitmap; 
  4. import android.os.Bundle; 
  5. import android.support.v7.app.AppCompatActivity; 
  6. import android.widget.ImageView; 
  7.  
  8. import butterknife.BindBitmap; 
  9. import butterknife.BindView; 
  10. import butterknife.ButterKnife; 
  11.  
  12. public class ButterknifeActivity extends AppCompatActivity { 
  13.  
  14.     @BindView( R.id.imageView ) //绑定ImageView 控件 
  15.     public ImageView imageView ; 
  16.  
  17.     @BindBitmap( R.mipmap.wifi )  //绑定Bitmap 资源 
  18.     public Bitmap wifi_bitmap ; 
  19.  
  20.     @Override 
  21.     protected void onCreate(Bundle savedInstanceState) { 
  22.         super.onCreate(savedInstanceState); 
  23.         setContentView(R.layout.activity_butterknife); 
  24.  
  25.         //绑定activity 
  26.         ButterKnife.bind( this ) ; 
  27.  
  28.         imageView.setImageBitmap( wifi_bitmap ); 
  29.     } 
  30.  

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


  1. package com.myl.test; 
  2.  
  3. import android.os.Bundle; 
  4. import android.support.v7.app.AppCompatActivity; 
  5. import android.widget.Button; 
  6.  
  7. import butterknife.BindColor; 
  8. import butterknife.BindView; 
  9. import butterknife.ButterKnife; 
  10.  
  11. public class ButterknifeActivity extends AppCompatActivity { 
  12.  
  13.     @BindView( R.id.button1 )  //绑定一个控件 
  14.     public Button button1 ; 
  15.  
  16.     @BindColor( R.color.colorAccent ) int black ;  //绑定一个颜色值 
  17.  
  18.     @Override 
  19.     protected void onCreate(Bundle savedInstanceState) { 
  20.         super.onCreate(savedInstanceState); 
  21.         setContentView(R.layout.activity_butterknife); 
  22.  
  23.         //绑定activity 
  24.         ButterKnife.bind( this ) ; 
  25.  
  26.         button1.setTextColor(  black ); 
  27.  
  28.     } 
  29.  

9) Adapter ViewHolder 绑定


  1. public class TestAdapter extends BaseAdapter {   
  2.     private List<String> list;   
  3.     private Context context;   
  4.  
  5.     public TestAdapter(Context context, List<String> list) {   
  6.         this.list = list;   
  7.         this.context = context;   
  8.     }   
  9.  
  10.     @Override   
  11.     public int getCount() {   
  12.         return list==null ? 0 : list.size();   
  13.     }   
  14.  
  15.     @Override   
  16.     public Object getItem(int position) {   
  17.         return list.get(position);   
  18.     }   
  19.  
  20.     @Override   
  21.     public long getItemId(int position) {   
  22.         return position;   
  23.     }   
  24.  
  25.     @Override   
  26.     public View getView(int position, View convertView, ViewGroup parent) {   
  27.         ViewHolder holder;   
  28.         if (convertView == null) {   
  29.             convertView = LayoutInflater.from(context).inflate(R.layout.layout_list_item, null);   
  30.             holder = new ViewHolder(convertView);   
  31.             convertView.setTag(holder);   
  32.         } else {   
  33.             holder = (ViewHolder) convertView.getTag();   
  34.         }   
  35.         holder.textview.setText("item=====" + position);   
  36.         return convertView;   
  37.     }   
  38.  
  39.     static class ViewHolder {   
  40.         @Bind(R.id.hello_world)   
  41.         TextView textview;   
  42.  
  43.         public ViewHolder(View view) {   
  44.             ButterKnife.bind(this, view);   
  45.         }   
  46.     }   
  47. }    

10) 点击事件的绑定:不用声明view,不用setOnClickLisener()就可以绑定点击事件

a. 直接绑定一个方法


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

b. 所有监听方法的参数是可选的


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

c. 定义一个特定类型,它将自动被转换


  1. @OnClick(R.id.submit)   
  2. public void sayHi(Button button) {   
  3.   button.setText("Hello!");   
  4. }    

d. 多个view统一处理同一个点击事件,很方便,避免抽方法重复调用的麻烦


  1. @OnClick(R.id.submit)   
  2. public void sayHi(Button button) {   
  3.   button.setText("Hello!");   
  4. }   

e. 自定义view可以绑定自己的监听,不指定id


  1. public class FancyButton extends Button {   
  2.   @OnClick   
  3.   public void onClick() {   
  4.     // TODO do something!   
  5.   }   
  6. }    

f. 给EditText加addTextChangedListener(即添加多回调方法的监听的使用方法),利用指定回调,实现想回调的方法即可,哪个注解不会用点进去看下源码上的注释


  1. @OnTextChanged(value = R.id.mobileEditText, callback = OnTextChanged.Callback.BEFORE_TEXT_CHANGED)   
  2. void beforeTextChanged(CharSequence s, int start, int countint 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.  

代码混淆


  1. -keep class butterknife.** { *; }   
  2. -dontwarn butterknife.internal.**   
  3. -keep class **$$ViewBinder { *; }   
  4.  
  5. -keepclasseswithmembernames class * {   
  6.     @butterknife.* <fields>;   
  7. }   
  8.  
  9. -keepclasseswithmembernames class * {   
  10.     @butterknife.* <methods>;   
  11. }    

Zelezny插件的使用

在AndroidStudio->File->Settings->Plugins->搜索Zelezny下载添加就行 ,可以快速生成对应组件的实例对象,不用手动写。使用时,在要导入注解的Activity 或 Fragment 或 ViewHolder的layout资源代码上,右键——>Generate——Generate ButterKnife Injections,然后就出现如图的选择框。

ButterKnife实现原理

对ButterKnife有过了解人 , 注入字段的方式是使用注解@BindView(R.id.tv_account_name),但首先我们需要在Activity声明注入ButterKnife.bind(Activity activity) 。我们知道,注解分为好几类, 有在源码生效的注解,有在类文件生成时生效的注解,有在运行时生效的注解。分别为RetentionPolicy.SOURCE,RetentionPolicy.CLASS,RetentionPolicy.RUNTIME ,其中以RetentionPolicy.RUNTIME最为消耗性能。而ButterKnife使用的则是编译器时期注入,在使用的时候,需要配置classpath ‘com.neenbedankt.gradle.plugins:android-apt:1.8’ , 这个配置说明,在编译的时候,进行注解处理。要对注解进行处理,则需要继承AbstractProcessor , 在boolean process(Set

ButterKnife实现方式

知晓了注解可以在编译的时候进行处理,那么,我们就可以得到注解的字段属性与所在类 , 进而生成注入文件,生成一个注入类的内部类,再进行字段处理 , 编译之后就会合并到注入类中,达到植入新代码段的目的。例如:我们注入@VInjector(R.id.tv_show) TextView tvShow;我们就可以得到tvShow这个变量与R.id.tv_show这个id的值,然后进行模式化处理injectObject.tvShow = injectObject.findViewById(R.id.tv_show); ,再将代码以内部类的心事加入到组件所在的类中 , 完成一次DI(注入) 。

a) 首先创建一个视图注解

b) 创建一个注解处理器,用来得到注解的属性与所属类

c) 解析注解,分离组合Class与属性

d) 组合Class与属性,生成新的Java File

APT生成的Java File , 以及模式代码

使用Javac , 编译时期生成注入类的子类

项目UML图

简要说明:

主要类:

VInjectProcessor —-> 注解处理器 , 需要配置注解处理器


  1. resources 
  2.         - META-INF 
  3.               - services 
  4.                     - javax.annotation.processing.Processor  

Processor内容:


  1. com.myl.viewinject.apt.VInjectProcessor   # 指定处理器全类名  

VInjectHandler —-> 注解处理类 , 主要进行注入类与注解字段进行解析与封装,将同类的字段使用map集合进行映射。exp: Map

自定义ButterKnife具体实现

因微信字数限制,请点击左下角原文链接查看!~







本文作者:佚名
来源:51CTO