ButterKnife基本使用

Butter Knife处理字段和方法绑定.
 
重要更新: 目前(2016.4.29), ButterKnife的最新版本是8.0.1.
以下原文是针对ButterKnife v6.1.0的, v8.0.1主要的不同在以下几个关键词:
  1. @InjectView -> @BindView
  2. @InjectViews -> @BindViews
  3. ButterKnife.inject(this) -> ButterKnife.bind(this)
  4.  
  5. ButterKnife.reset(this) ->
  6.  
  7. private Unbinder unbinder;
  8. unbinder = ButterKnife.bind(this, view);
  9. @Override
  10. public void onDestroyView() {
  11. unbinder.unbind();
  12. super.onDestroyView();
  13. }
 

配置:

用gradle配置的时候加入:
  1. compile 'com.jakewharton:butterknife:6.1.0'
注意是加在Module: app的gradle文件中.
加上之后不用运行什么命令,直接Sync一下就可以在External Libraries里面看到butterknife.
 

功能1: 再也不用写findViewById()啦.

以前的:
  1. mTextView1 = (TextView) findViewById(R.id.butter_text_view_1);
现在可以这样实现:
首先在变量声明的时候加上注解:
  1. @InjectView(R.id.butter_text_view_2)
  2. TextView mTextView2;
如果id找不到,会在编译的时候报错.
 
之后在设置好布局之后调用ButterKnife.inject():
  1. @Override
  2. protected void onCreate(Bundle savedInstanceState) {
  3. super.onCreate(savedInstanceState);
  4. setContentView(R.layout.demo_butter_knife);
  5.  
  6. //using butter knife
  7. ButterKnife.inject(this);
  8. }
之后View对象就可以直接使用了.
 
需要注意的是View变量声明的时候不能为private或者static.
除了Activity之外,你可以提供其他的View Root,来获取对象(执行注入).
还可以用来简化Adapter里面的ViewHolder:
 

ButterKnife in Fragment

在Fragment中也可以使用ButterKnife来获取View:
  1. public class SimpleFragment extends Fragment {
  2.  
  3. @InjectView(R.id.fragment_text_view)
  4. TextView mTextView;
  5.  
  6. public SimpleFragment() {
  7. }
  8.  
  9. @Override
  10. public View onCreateView(LayoutInflater inflater, ViewGroup container,
  11. Bundle savedInstanceState) {
  12. View view = inflater.inflate(R.layout.fragment_simple, container, false);
  13. ButterKnife.inject(this, view);
  14. mTextView.setText("TextView in Fragment are found!");
  15. return view;
  16. }
  17. }
ButterKnife in Adapter ViewHolder
Adapter有一种常用的优化策略,就是使用ViewHolder来减少findViewById()的重复调用.
以前写过相关的博文: http://www.cnblogs.com/mengdd/p/3254323.html
 
用了ButterKnife之后, ViewHolder的使用可以变成这样:
  1. @Override
  2. public View getView(int position, View convertView, ViewGroup parent) {
  3. ViewHolder holder;
  4. if (convertView == null) {
  5. convertView = mInflater.inflate(R.layout.person_item_layout, null);
  6. holder = new ViewHolder(convertView);
  7. convertView.setTag(holder);
  8. } else {
  9. holder = (ViewHolder) convertView.getTag();
  10. }
  11. Person person = getItem(position);
  12. if (null != person) {
  13. holder.name.setText(person.getName());
  14. holder.age.setText(String.valueOf(person.getAge()));
  15. holder.location.setText(person.getLocation());
  16. holder.work.setText(person.getWork());
  17. }
  18.  
  19. return convertView;
  20. }
  21.  
  22. static class ViewHolder {
  23. @InjectView(R.id.person_name)
  24. TextView name;
  25. @InjectView(R.id.person_age)
  26. TextView age;
  27. @InjectView(R.id.person_location)
  28. TextView location;
  29. @InjectView(R.id.person_work)
  30. TextView work;
  31.  
  32. public ViewHolder(View view) {
  33. ButterKnife.inject(this, view);
  34. }
  35. }
可以看到ViewHolder类加了一个带参数View的构造方法,用注解标记每个字段,再也不需要在getView()方法里调用findViewById()方法了.
  

功能2: 再也不用写setOnClickListener()啦.

比如之前的:
  1. finishButton.setOnClickListener(new View.OnClickListener() {
  2. @Override
  3. public void onClick(View v) {
  4. finish();
  5. }
  6. });
现在可以写成:
  1. @OnClick(R.id.basic_finish_a_button)
  2. void finishA(View view) {
  3. finish();
  4. }
注意这里方法仍然不能是private和static, 并且可以有一个参数View,也可不写.
所有listener的参数都是optional的,可以写,也可以不写.
并且写的时候可以直接写一个具体的子类,比如参数View可以写成Button,这里的cast是自动完成的.
 
注意还是需要调用一下ButterKnife.inject(this);
否则事件绑定不成功.
忘记调用ButterKnife.inject(this);对于findView来说会报错,但是对于绑定事件来说不会报错,只是没有事情发生.
 
除了点击事件@OnClick,还有ListView的点击@OnItemClick, CheckBox的@OnCheckedChanged等等.
可以一次指定多个id,为多个View绑定一个事件处理方法,比如:
  1. //you can bind listener to multiple views
  2. @OnClick({R.id.button_enable, R.id.button_disable, R.id.button_alpha_0, R.id.button_alpha_1})
  3. void editViewsClicked() {
  4. Toast.makeText(this, "You click the Button!", Toast.LENGTH_SHORT).show();
  5. } 
 

功能3: 组建View List: 把多个View放在一起用

可以同时获取多个View,放在一个List中:
  1. @InjectViews({R.id.label_first_name, R.id.label_middle_name, R.id.label_last_name})
  2. List<TextView> labelViews;
  3.  
  4. @InjectViews({R.id.first_name, R.id.middle_name, R.id.last_name})
  5. List<EditText> nameViews; 
注意id用逗号分隔,大括号包围,外面才是小括号.
 
apply()方法允许你为一组对象批量地设置值.
apply()方法共有3种形式:
  1. public static <T extends View> void apply(List<T> list, Action<? super T> action)
  2. public static <T extends View, V> void apply(List<T> list, Setter<? super T, V> setter, V value)
  3. public static <T extends View, V> void apply(List<T> list, Property<? super T, V> setter, V value)
即Action, Setter和Property三种.
其中Action和Setter都是ButterKnife的类,需要继承,写自己的子类实现,然后传入对象.
Setter的第三个参数可以指定要set到什么值.
 
 
具体的使用可以参见例子:
 
 

其他实用方法

1.注入重置(Injection Rest):

可以用reset()方法将ButterKnife注入的View引用设置为null.
比如在Fragment的onCreateView()里调用ButterKnife.inject()方法注入了一些View,在onDestroyView()里想把它们置为null,可以直接调用ButterKnife.reset(this);方法.
 

2.选择性注入(Optional Injection): 

默认情况下,@InjectView和listener的注入都是必须的,如果target view没有被发现,则会报错.
为了抑制这种行为,可以用@Optional注解来标记field和方法,让注入变成选择性的,如果targetView存在,则注入, 不存在,则什么事情都不做.
当布局被复用时,这个@Optional注解很有用.
 

3.多方法的listener(Multi-method Listeners):

有一些View的listener是有多个回调方法的,比如Spinner的onItemSelectedListener:
  1. mSpinner.setOnItemSelectedListener(new AdapterView.OnItemSelectedListener() {
  2. @Override
  3. public void onItemSelected(AdapterView<?> parent, View view, int position, long id) {
  4. }
  5.  
  6. @Override
  7. public void onNothingSelected(AdapterView<?> parent) {
  8. }
  9. });
方法注解可以用来绑定到这些方法中的任何一个.
每一个注解有一个默认的callback,指定它绑定到什么方法上;可以通过callback参数指定为一个特定的方法.
比如:
没有指定callback,默认对应onItemSelected()方法:
  1. @OnItemSelected(R.id.my_spinner)
  2. //default callback : ITEM_SELECTED
  3. void onItemSelected(int position) {
  4. Toast.makeText(this, "position: " + position, Toast.LENGTH_SHORT).show();
  5. }
 
指定了callback,对应onNothingSelected()方法:
  1. @OnItemSelected(value = R.id.my_spinner, callback = OnItemSelected.Callback.NOTHING_SELECTED)
  2. void onNothingSelected() {
  3. Toast.makeText(this, "Nothing", Toast.LENGTH_SHORT).show();
  4. }
 
注意的是Spinner中只要有数据,默认都会选中第0个数据,所以想进入到onNothingSelected()方法,就需要把Adapter中的数据都清空.
具体完整例子见:

4.findById()方法

ButterKnife.findById()可以用来获取Activity,Dialog或View中的任何View.
ButterKnife自动完成了类型转换,所以获取出来以后不用进行显式强转,直接赋值给具体的View类型引用即可.
 
 

Resources:

Sample Project:
 

ButterKnife基本使用的更多相关文章

  1. Android注解使用之通过annotationProcessor注解生成代码实现自己的ButterKnife框架

    前言: Annotation注解在Android的开发中的使用越来越普遍,例如EventBus.ButterKnife.Dagger2等,之前使用注解的时候需要利用反射机制势必影响到运行效率及性能,直 ...

  2. Android Butterknife 8.4.0 使用方法总结

    转载请标明出处:http://www.cnblogs.com/zhaoyanjun/p/6016341.html 本文出自[赵彦军的博客] 前言 ButterKnife 简介 ButterKnife是 ...

  3. Android开发学习之路-使用annotationProcessor配置Butterknife

    Apt工具的作者宣布了不再维护该工具了,而且Android Studio也有了自己的插件,并且可以通过gradle来简单的配置. 其实用Butterknife的都知道,没有apt,onClick绑定不 ...

  4. Android ButterKnife配置使用

    ButterKnife在GitHub的地址:https://github.com/JakeWharton/butterknife 最新的版本是:8.4.0 app 模块的build.gradle: a ...

  5. Android注解使用之ButterKnife 8.0注解使用介绍

    前言: App项目开发大部分时候还是以UI页面为主,这时我们需要调用大量的findViewById以及setOnClickListener等代码,控件的少的时候我们还能接受,控件多起来有时候就会有一种 ...

  6. ButterKnife Zelezny从配置到使用

    插件介绍:ButterKnife是一个专注于Android系统的View注入框架,可以减少大量的findViewById以及setOnClickListener代码,可视化一键生成.又一神器,完美告别 ...

  7. Android Studio插件之快速findViewById(butterknife和Android CodeGenerator的使用)

    首先在设置里面的Plugins里面下载安装插件: 安装之后会提示重启, 然后就是怎么使用了: butterknife的使用: 首先在build.gradle(app)里面添加这句话: compile ...

  8. 使用Android Butterknife

    我之前浏览过android butterknife 的使用 在android studio 中,很惊喜,已经成为一个插件来使用 这个android butterknife 最大的用处,就是直接生成la ...

  9. 手把手教android studio中安装Android Butterknife Zelezny (转)

    原文地址:http://blog.csdn.net/xin917480852/article/details/51176524 用来快速生成findViewById() 安装方法: 打开Android ...

随机推荐

  1. OpenCASCADE Root-Finding Algorithm

    OpenCASCADE Root-Finding Algorithm eryar@163.com Abstract. A root-finding algorithm is a numerical m ...

  2. Makefile

    原文链接:http://www.orlion.ga/816/ 一.基本规则 对于一个拥有多个文件的c项目,编译时可能是这样的指令: gcc main.c stack.c -o main 如果编译之后又 ...

  3. JavaScript 中的类方法,对象方法,Prototype方法

    <script type="text/javascript"> function baseClass() { this.showMsg = function() { a ...

  4. 准备 LVM Volume Provider - 每天5分钟玩转 OpenStack(49)

    Cinder 真正负责 Volume 管理的组件是 volume provider. Cinder 支持多种 volume provider,LVM 是默认的 volume provider.Devs ...

  5. 关于SubSonic3.0插件使用SqlQuery或Select查询时产生的System.NullReferenceException异常修复

    早上在编写执行用例时,突然爆异常System.NullReferenceException: 未将对象引用设置到对象的实例 执行代码:

  6. HTML中哪些标签的值会被提交到服务器呢?

    <form> <input name="">标签 <select name="">标签 <textarea name= ...

  7. 【经验之谈】Windows环境下配置WordPress

    前言 wordpress全球著名的开放博客平台,拥有成千上万个各式插件和不计其数的主题模板样式,使用php和mysql搭建,下面说下载windows环境下配置wordpress,经验之谈. 安装 关于 ...

  8. 【HBase】HBase Getting Started(HBase 入门指南)

    入门指南 1. 简介 Quickstart 会让你启动和运行一个单节点单机HBase. 2. 快速启动 – 单点HBase 这部分描述单节点单机HBase的配置.一个单例拥有所有的HBase守护线程- ...

  9. c/c++系列的运算符优先级总结

    经常写程序的时候,遇到运算符优先级的问题,令我汗颜的是,查书的次数挺多的……狠狠心,总结下.不过还要结合大量的编程实践来深入脑海. 1.首先永远忘不了的是,逗号运算符级别最低,毫无争议的还有()括起来 ...

  10. 用MVC做支付宝手机网页支付问题

    支付宝支付接口手机网页支付 从官网扒下来的demo阿里做得还是相当不错的,只要参数改正确了基本上都是能跑通,WebForm的没什么大问题,这次要讲的主要是几个要注意的问题,因为是用MVC来做. 1.要 ...