Android Butterknife使用详解以及Zelezny插件的安装与使用

优势

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

添加依赖

build.gradle

dependencies {
  //view,事件绑定
    implementation 'com.jakewharton:butterknife:8.8.1'
    annotationProcessor 'com.jakewharton:butterknife-compiler:8.8.1'
}

单个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就可以随心所欲的使用了,方便吧!

在Fragment、Adapter中使用

除了Activity,我们常用的场景还有Fragment,以及Adapter。用法跟在Activity中大致相似。

Fragment中

  • 例:绑定布局中的TextViewButtonEditText
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中

例:绑定布局中的TextViewButton

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的ActionSetter接口来执行一些简单的操作

隐藏指定的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一样,方法也不能为privatestatic类型

资源绑定

可以利用@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',所有绑定的代码自动生成。厉害了

安装插件

安装插件1.png
安装插件2.png
安装插件3.png

使用

然后只要右键布局id上,选择Generate,点击Generate Butterknife Injections,该插件会从对应的布局中查找有id属性的View,然后会出现在对应的选择页面。点击Confirm即可。

使用1.png

使用2.png

最后的提示

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

  • Activity: ButterKnife.bind(this);
    必须在setContentView();之后,且父类bind绑定后,子类不需要再bind
  • Fragment :ButterKnife.bind(this, mRootView);
  • 属性布局不能用privatestatic 修饰,否则会报错
  • setContentView()不能通过注解实现。
  • ButterKnife已经更新到版本8.x了,以前的版本中叫做@InjectView,7.x中叫@Bind,而现在改用叫@BindView
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,980评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,178评论 2 380
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,868评论 0 336
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,498评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,492评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,521评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,910评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,569评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,793评论 1 296
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,559评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,639评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,342评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,931评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,904评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,144评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,833评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,350评论 2 342