Butterknife——注解框架

╰半橙微兮° 2022-04-21 23:45 207阅读 0赞

## 前言 ##

Butterknife——相信多同学都知道，这是一个注解框架，一般在绑定`View`的时候使用。不得不说，这个框架"有毒"，用了就上瘾，连写个Demo都要去导这个库。  
想必大多数同学都用过ButterKnife，可能你会说“不就是代替了`findViewById()`吗？”。我想说，确实不只是有`findViewById()`这个功能。不得不承认，在这之前，我对ButterKnife的使用，也只停留在绑定视图和点击事件上。???

## 介绍 ##

ButterKnife我已经用了好一段时间了，它除了方便，还是方便。ButterKnife为我们简化了很多代码，具体有的作用，可以下面的例子来了解。

看看官方的介绍：

Field and method binding for Android views which uses annotation processing to generate boilerplate code for you  
使用注解生成模块代码，用于把一些字段和方法绑定到 Android 的 View。

## 优势 ##

*  强大的`View`绑定和`Click`事件等处理功能，简化代码，提升开发效率
 *  运行时不会影响APP效率，使用配置方便
 *  代码清晰，可读性强

## 申明 ##

可能有些人对ButterKnife有一些误解，认为ButterKnife是通过反射来实现的。其实不然，相比缓慢的反射机制，ButterKnife用的APT(Annotation Processing Tool)编译时解析技术。动态生成绑定事件或者控件的java代码，然后在运行的时候，直接调用`bind`方法完成绑定，因此你不必担心注解的性能问题。骚年，放心去用吧。  
如果你对原理感兴趣，可以点击[这里][Link 1]

## 使用 ##

啰嗦了半天，终于说到正题了~~

依赖

Project的`build.gradle`文件中：

buildscript {
      repositories {
        mavenCentral()
         }
      dependencies {
        classpath 'com.jakewharton:butterknife-gradle-plugin:8.4.0'
        }
    }

Module的`build.gradle`文件中:

apply plugin: 'com.android.library'
    apply plugin: 'com.jakewharton.butterknife'

dependencies { 
        compile 'com.jakewharton:butterknife:8.4.0' 
        annotationProcessor 'com.jakewharton:butterknife-compiler:8.4.0'
    }

单个View——@BindView

*  **在Activity中使用**  
    例：绑定布局中的`TextView`、`Button`、`EditText`。
 *  没有ButterKnife时，各种烦人的`findViewById()`和强转：

TextView textView = (TextView) findViewById(R.id.text_view);
    Button button = (Button) findViewById(R.id.button);
    EditText editText = (EditText) findViewById(R.id.edit_text);

*  使用ButterKnife后：  
    先绑定对应的`View`

@BindView(R.id.text_view)
    TextView mTextView;
    @BindView(R.id.button)
    Button mButton;
    @BindView(R.id.edit_text)
    EditText mEditText;

然后在`onCreate()`的`setContentView()`下添加`ButterKnife.bind(this);`：

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

然后这些`View`就可以随心所欲的使用了，方便吧！

> **注意**：这里的`View`不可以是`private`或`static`类型

*  **在Fragment、Adapter中使用**  
    除了`Activity`，我们常用的场景还有`Fragment`，以及`Adapter`。用法跟在`Activity`中大致相似。
 *  Fragment中  
    例：绑定布局中的`TextView`、`Button`、`EditText`。

public class MainFragment extends Fragment {
        @BindView(R.id.text_view)
        TextView mTextView;
        @BindView(R.id.button)
        Button mButton;
        @BindView(R.id.edit_text)
        EditText mEditText;
        @Override
        public View onCreateView(LayoutInflater inflater,ViewGroup container, Bundle savedInstanceState) {
            View rootView = inflater.inflate(R.layout.frag_main, container, false);
            ButterKnife.bind(this, rootView);//这里有些不同
            return rootView;
          }
    }

> 提示：如果我们需要在某个时候将`Fragment`中的`view`设置为`null`，这时候需要用到`Unbinder`。在`onCreateView`中使用`bind`方法时，会返回一个`Unbinder`对象，该对象中有的`unbinder`方法，可以将`Fragment`中的`View`设置为`null`

*  Adapter中  
    例：绑定布局中的`TextView`、`Button`。

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.whatever, parent, false);
              holder = new ViewHolder(view);
              view.setTag(holder);
            }
             //....
            return view;
          }
          static class ViewHolder {
            @BindView(R.id.text_view) TextView mTextView;
            @BindView(R.id.button) Button mButton;;
            public ViewHolder(View view) {
               ButterKnife.bind(this, view);
            }
          }
    }

> 提示：在使用`BindView`方法的时候，如果目标`View`没有找的的话，会抛出异常。如果不想受到这个异常，可以使用`@Nullable`

@Nullable @BindView(R.id.text_view)

多个View——@BindViews

使用这种绑定时，你可以使用`apply()`方法。该函数相当于将在这个列表中每一个元素上进行调用.利用ButterKnife的`Action`或`Setter`接口来执行一些简单的操作

*  例：隐藏指定的`View`。  
    先使用`List<View>`绑定视图

@BindViews({R.id.text_view, R.id.button, R.id.edit_text})
    List<View> mViews;

*  使用`Action`

final ButterKnife.Action<View> VIEWS_GONE = new ButterKnife.Action<View>() {
        @Override
        public void apply(@NonNull View view, int index) {
            view.setVisibility(View.GONE);
        }
    };
    ButterKnife.apply(mViews, VIEWS_GONE);

*  使用Setter

final ButterKnife.Setter<View, Boolean> VIEWS_VISIAVLE = new ButterKnife.Setter<View, Boolean>() {
        @Override
        public void set(@NonNull View view, Boolean value, int index) {
            final int IS_VISIAVLE = value ? View.VISIBLE : View.GONE;
            view.setVisibility(IS_VISIAVLE);
        }
    };
    ButterKnife.apply(mViews, VIEWS_VISIAVLE, false);

*  Android属性也可以和`apply`方法一起使用。

ButterKnife.apply(nameViews, View.ALPHA, 0.0f);

点击事件——@OnClick

在使用的过程中，除了`@BindView`，还有`@OnClick`也是经常用到的。

*  例：为`Button`设置点击事件

@OnClick(R.id.button)
    public void onButtonClick(View view) {
        Toast.makeText(this, "button被点击了", Toast.LENGTH_SHORT).show();
    }

参数`View`就是被点击的视图  
如果可以确认View的具体类型，可以这样写。如：已知为`Button`类型

@OnClick(R.id.button)
    public void onButtonClick(Button button) {
        Toast.makeText(this, "button被点击了", Toast.LENGTH_SHORT).show();
    }

如果不需要用到参数`View`，也可以去掉

@OnClick(R.id.button)
    public void onButtonClick() {
        Toast.makeText(this, "button被点击了", Toast.LENGTH_SHORT).show();
    }

*  例：多个点击事件

@OnClick({R.id.text_view, R.id.button, R.id.edit_text})
    public void onTextviewClick(View view) {
        switch (view.getId()){
            case R.id.text_view:
                Toast.makeText(this, "text_view被点击了", Toast.LENGTH_SHORT).show();
                break;
            case R.id.button:
                Toast.makeText(this, "button被点击了", Toast.LENGTH_SHORT).show();
                break;
            case R.id.edit_text:
                Toast.makeText(this, "edit_text被点击了", Toast.LENGTH_SHORT).show();
                break;
        }
    }

*  例：`item`的点击事件

@BindView(R.id.list_view)
    ListView mListView;
    private String[] strs = {"1","2","3","4","5"};

mListView.setAdapter(new ArrayAdapter<String>(getContext(), 
            android.R.layout.simple_list_item_1, strs));

@OnItemClick(R.id.list_view)
    void onItemClick(int potion) {
        Toast.makeText(getContext(), "点击了:" + potion, Toast.LENGTH_SHORT).show();
    }

有`@OnItemClick`，当然也有`@OnItemLongClick`。具体的用法我就不写了...

*  自定义`View`绑定事件监听时无需ID

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

> **注意:**  
> 1、方法名可以随便取  
> 2、跟`View`一样，方法也不能为`private`或`static`类型

资源绑定

可以利用`@BindBool`,`@BindColor`,`@BindDimen`,`@BindDrawable`,`@BindInt`,`@BindString`来绑定资源，如下

class MainActivity extends Activity {
      @BindString(R.string.title) String title;
      @BindDrawable(R.drawable.graphic) Drawable graphic;
      @BindColor(R.color.red) int red; // int or ColorStateList field
      @BindDimen(R.dimen.spacer) Float spacer; // int (for pixel size) or float (for exact value) field
      // ...
    }

findById方法

如果在某些场景下，你真的需要用到`findViewById()`方法。不用担心，ButterKnife中包含了`findById()`方法来替代`findViewById()`，可以在`View`,`Activity`, 或`Dialog`中使用

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 photo = ButterKnife.findById(view, R.id.photo);

## Zelezny插件 ##

如果你是像我一样高（lan）效（duo）的程序员，一点都不想写这些东西。那么福利来了，那就是Zelezny插件（Android Studio）。只要在布局中写上'id'，所有绑定的代码自动生成。厉害了

*  安装插件
    
     
    
    ![Image 1][]
    
    安装插件
 *  使用  
    然后只要右键**布局id**上，选择Generate，点击Generate Butterknife Injections，该插件会从对应的布局中查找**有id属性**的View，然后会出现在对应的选择页面。点击Confirm即可。
    
    ![Image 1][]
    
    操作

## 最后的提示 ##

几点有关ButterKnife的提示，使用时避免踩坑。

*  Activity： `ButterKnife.bind(this)`;  
    必须在`setContentView();`之后，且父类`bind`绑定后，子类不需要再`bind`
 *  Fragment ：`ButterKnife.bind(this, mRootView);`
 *  属性布局不能用`private` 或`static` 修饰，否则会报错
 *  `setContentView()`不能通过注解实现。
 *  ButterKnife已经更新到版本8.x了，以前的版本中叫做`@InjectView`，7.x中叫`@Bind`，而现在改用叫`@BindView`。

作者：带心情去旅行  
链接：https://www.jianshu.com/p/5dead31a84f6  
來源：简书  
简书著作权归作者所有，任何形式的转载都请联系作者获得授权并注明出处。

[Link 1]: https://www.jianshu.com/p/0f3f4f7ca505#
[Image 1]: