Butter Knife 8.4.0 用法记录

Butter Knife的性能与原生差不多,而且使用起来方便。所以,项目中还是比较常用的。记录一下常见的用法。

1、Android studio配置

1.1、 在项目工程的 build.gradle 文件中 引入android-apt插件:
加入:classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'
如下图:

buildscript {
  repositories {
     ...
   }
  dependencies {
    classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'
  }
}

1.2、在Module的 build.gradle里配置:
android-apt插件应用到module的build.gradle中,然后加入相应的依赖包。

apply plugin: 'android-apt'

android {
  ...
}

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

2、使用注解

2.1、在Activity中使用注解

class ExampleActivity extends Activity {
  @BindView(R.id.title) TextView title;
  @BindView(R.id.subtitle) TextView subtitle;
  @BindView(R.id.footer) TextView footer;

  @Override public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.simple_activity);
    ButterKnife.bind(this);      //这个必须有
    // TODO Use fields...
  }
}

相比与缓慢的反射机制,Butter Knife的代码是生成的,因此不必担心注解的性能问题。调用 bind来生成这些代码,你可以查看或调试这些代码。
例如上面的例子,生成的代码大致如下所示:

public void bind(ExampleActivity activity) {
  activity.subtitle = (android.widget.TextView) activity.findViewById(2130968578);
  activity.footer = (android.widget.TextView) activity.findViewById(2130968579);
  activity.title = (android.widget.TextView) activity.findViewById(2130968577);
}

注意一点,必须 ButterKnife.bind() 注解才能生效。

2.2、资源注解

class ExampleActivity 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
  // ...
}

通过@BindBool, @BindColor, @BindDimen, @BindDrawable, @BindInt,@BindString可以给变量绑定一个已经定义好的资源。

2.3、在非activity中使用注解

2.3.1、Fragment中使用注解

public class FancyFragment extends Fragment {
  @BindView(R.id.button1) Button button1;
  @BindView(R.id.button2) Button button2;

   private Unbinder unbinder;  

  @Override public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) {
    View view = inflater.inflate(R.layout.fancy_fragment, container, false);
    unbinder = ButterKnife.bind(this, view);
    // TODO Use fields...
    return view;
  }

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

}

Fragment的生命周期与Activity不同。在Fragment中,我们可能会在onCreateView中绑定一个布局,并在onDestroyView中设置所有view为null.此时,你就需要Butter Knife提供的undind函数来做此事。

2.3.2、在Adapter中使用注解

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);
    }

    holder.name.setText("John Doe");
    // 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);
    }
  }
}

2.4、View列表

2.4.1、将多个view组成一组,加到list或者array中

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

2.4.2、设置View的属性

其中apply方法可以设置view的属性:

ButterKnife.apply(nameViews, View.ALPHA, 0.0f);    //设置nameViews里每个EditText的ALPHA属性为0.0f

2.4.3、对列表中每一个元素上进行调用

首先使用ActionSetter接口指定一些简单的动作:

static final ButterKnife.Action<View> DISABLE = new ButterKnife.Action<View>() {
  @Override public void apply(View view, int index) {
    view.setEnabled(false);
  }
};
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);
  }
};

然后调用apply方法对列表中每一个元素上进行调用:

ButterKnife.apply(nameViews, DISABLE);    //设置nameViews里每个EditText的为非活动状态
ButterKnife.apply(nameViews, ENABLED, true); //设置nameViews里每个EditText的为活动状态

2.5、监听器注解

使用方法如下:

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

函数的参数是可选的,也可以不带。但是如果带参数,则参数必须与控件的类型对应。

@OnClick(R.id.submit)
public void submit() {      //不带参数
  // TODO submit data to server...
}
@OnClick(R.id.submit)
public void sayHi(Button button) {    //必须与R.id.submit指定控件的类型对应
  button.setText("Hello!");
}

多个不同的ID也可以绑定同一个函数。

@OnClick({ R.id.door1, R.id.door2, R.id.door3 })
public void pickDoor(DoorView door) {
  if (door.hasPrizeBehind()) {
    Toast.makeText(this, "You win!", LENGTH_SHORT).show();
  } else {
    Toast.makeText(this, "Try again", LENGTH_SHORT).show();
  }
}

自定义控件绑定监听器时不需要ID

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

2.6、@Nullable或@optional注释

在默认情况下, @bind和监听器的绑定都是需要的,如果目标view没有找到的话,Butter Knife将会抛出一个异常。
如果你并不想接收到这样的信息,那么就在你的方法或变量上使用@Nullable注释字段或@optional注释。
Note: 关于@Nullable注解,可查看androd官方库文件Android's "support-annotations" library.

@Nullable @BindView(R.id.might_not_be_there) TextView mightNotBeThere;

@Optional @OnClick(R.id.maybe_missing) void onMaybeMissingClicked() { 
      // TODO ...
}

2.7、ButterKnife.findById

Butter knife仍然包含了findById方法,用于仍需从一个view ,Activity,或者Dialog上 find 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 photo = ButterKnife.findById(view, R.id.photo);

2.8、其他的监听器接口

在之前项目中,发现老版本的ButterKnife居然没有办法处理RadioGroup的setOnCheckedChangeListener。但是似乎在8.4.0中添加了新的接口了。这里整理一下其他的接口。

Annotation Associated Interface
@OnCheckedChange android.widget.CompoundButton.OnCheckedChangeListener
@OnClick butterknife.internal.DebouncingOnClickListener
@OnEditorAction android.widget.TextView.OnEditorActionListener
@OnFocusChange android.view.View.OnFocusChangeListener
@OnItemClick android.widget.AdapterView.OnItemClickListener
@OnItemLongClick android.widget.AdapterView.OnItemLongClickListener
@OnLongClick android.view.View.OnLongClickListener
@OnTouch android.view.View.OnTouchListener

2.9、写在最后

ButterKnife还是挺强大的,但是常见的用法应该也就这些了。它还有很多别的用法,可以参考下面的文章。
http://craftedcourses.io/all-about-butter-knife-part-3/

参考:

http://craftedcourses.io/all-about-butter-knife-part-3/
https://github.com/JakeWharton/butterknife
http://jakewharton.github.io/butterknife/
http://www.jianshu.com/p/9ad21e548b69

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,088评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,715评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,361评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,099评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 60,987评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,063评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,486评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,175评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,440评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,518评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,305评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,190评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,550评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,880评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,152评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,451评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,637评论 2 335

推荐阅读更多精彩内容