Butter Knife,专门为Android View设计的绑定注解,专业解决各种findViewById

简介

对一个成员变量使用@BindView注解,并传入一个View ID, ButterKnife 就能够帮你找到对应的View,并自动的进行转换(将View转换为特定的子类):

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使用再编译时生成的代码来执行View的查找,因此不必担心注解的性能问题。调用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);
}

资源绑定

绑定资源到类成员上可以使用@BindBool@BindColor@BindDimen@BindDrawable@BindInt@BindString。使用时对应的注解需要传入对应的id资源,例如@BindString你需要传入R.string.id_string的字符串的资源id。

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

在非Activity中使用绑定

Butter Knife提供了bind的几个重载,只要传入跟布局,便可以在任何对象中使用注解绑定。

例如在Fragment中:

public class FancyFragment extends Fragment {
@BindView(R.id.button1)
Button button1;
@BindView(R.id.button2)
Button button2; @Override
public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) {
View view = inflater.inflate(R.layout.fancy_fragment, container, false);
ButterKnife.bind(this, view);
// TODO Use fields...
return view;
}
}

还有一种比较常见的场景,就是在ListView的Adapter中,我们常常会使用ViewHolder:

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

ButterKnife.bind的调用可以被放在任何你想调用findViewById的地方。

提供的其他绑定API:

  • 使用Activity作为跟布局在任意对象中进行绑定。如果你使用了类似MVC的编程模式,你可以对controller使用它的Activity用ButterKnife.bind(this, activity)进行绑定。

  • 使用ButterKnife.bind(this)绑定一个布局的子布局。如果你在布局中使用了<merge>标签并且在自定义的控件构造时inflate这个布局,你可以在inflate之后立即调用它。或者,你可以在onFinishInflate()回调中使用它。

View 列表

你可以一次性将多个views绑定到一个List或数组中:

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

apply函数,该函数一次性在列表中的所有View上执行一个动作:

ButterKnife.apply(nameViews, DISABLE);
ButterKnife.apply(nameViews, ENABLED, false);

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

Android中的Property属性也可以使用apply方法进行设置:

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

监听器绑定

使用本框架,监听器能够自动的绑定到特定的执行方法上:

@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...
}

指定一个特定的类型,Butter Knife也能识别:

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

可以指定多个View ID到一个方法上,这样,这个方法就成为了这些View的共同事件处理。

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

自定义View时,绑定事件监听不需要指定ID

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

重置绑定:

Fragment的生命周期与Activity不同。在Fragment中,如果你在onCreateView中使用绑定,那么你需要在onDestroyView中设置所有view为null。为此,ButterKnife返回一个Unbinder实例以便于你进行这项处理。在合适的生命周期回调中调用unbind函数就可完成重置。

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

可选绑定:

在默认情况下, @bind和监听器的绑定都是必须的,如果目标view没有找到的话,Butter Knife将会抛出个异常。

如果你并不想使用这样的默认行为而是想创建一个可选的绑定,那么你只需要在变量上使用@Nullable注解或在函数上使用@Option注解。

注意:任何名为@Nullable的注解都可以使用在变量上。但还时强烈建议使用Android注解库中的@Nullable

@Nullable
@BindView(R.id.might_not_be_there)
TextView mightNotBeThere; @Optional
@OnClick(R.id.maybe_missing)
void onMaybeMissingClicked() {
// TODO ...
}

对于包含多个方法的监听

当一个监听器包含多个回调函数时,使用函数的注解能够对其中任何一个函数进行绑定。每一个注解都会绑定到一个默认的回调。你也可以使用callback参数来指定一个其他函数作为回调。

@OnItemSelected(R.id.list_view)
void onItemSelected(int position) {
// TODO ...
} @OnItemSelected(value = R.id.maybe_missing, callback = NOTHING_SELECTED)
void onNothingSelected() {
// TODO ...
}

Butter Knife提供了一个findViewById的简化代码:findById,用这个方法可以在ViewActivityDialog中找到想要View,而且,该方法使用的泛型来对返回值进行转换,也就是说,你可以省去findViewById前面的强制转换了。

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

  

最新文章

  1. Duilib源码分析(四)绘制管理器—CPaintManagerUI—(前期准备一)
  2. Python 从零学起(纯基础) 笔记 之 迭代器、生成器和修饰器
  3. springMVC,mybatis配置事务
  4. 顽皮的小球II
  5. args
  6. All thanks
  7. 初学JDBC,JDBC工具类的简单封装
  8. H3C S3600-28TP-SI配置命令
  9. 我的android学习经历30
  10. 转 图片资源加密,Lua文件加密
  11. SqlBulkCopy 批量插入数据库
  12. 深入理解C指针之三:指针和函数
  13. 纪中集训 Day 6
  14. (转)Spring并发访问的线程安全性问题(高度总结)
  15. Java 浏览器兼容模式
  16. 【读书笔记】【深入理解ES6】#7-Set集合和Map集合
  17. Could not find property &#39;outputFile
  18. 移动端,input、textarea滚动至可视区域
  19. inline temp 内联临时变量
  20. SourceInsight宏插件3(非常好用,强力推荐)

热门文章

  1. flex布局 一侧固定宽度 一侧自适应
  2. 蚂蚁SOFA系列(2) - SOFABoot的Readiness健康检查机制
  3. stm32f10x基于freeRTOS的低功耗实现
  4. Vue兄弟组件通信
  5. 大数据平台搭建 - cdh5.11.1 - hive客户端安装
  6. flink有什么优势值得大家这么热衷
  7. Cookie的删除
  8. Linux环境下进行分布式压测踩过的坑
  9. 视频转成在github的readme中展示项目的gif动图
  10. Docker 01 - CentOS 7 中安装 Docker 的详细步骤