文档章节

Android ButterKnife使用

肖朝胜
 肖朝胜
发布于 2016/10/12 12:40
字数 1362
阅读 181
收藏 1

该框架是一个绑定注解的框架,可以简化安卓中findViewById()和设置监听器等代码,简单实用,可参考官网连接:http://jakewharton.github.io/butterknife/

希望大家多多交流学习,让安卓开发更加方便

注意 :目前butterknife的版本已经升级,新版本的使用方式和旧版本有所区别,请大家看好自己所使用的butterknife版本吧

简介:

使用 @Bind注解并传入一个View ID,Butter Knife 就可以找到并且自动地对你的布局中的View进行转换并绑定到类成员上。

classExampleActivityextendsActivity {@Bind(R.id.title) TextView title;
  @Bind(R.id.subtitle) TextView subtitle;
  @Bind(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来生成这些代码,你可以查看或调试这些代码。

资源绑定

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

classExampleActivityextendsActivity {@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的几个重载,只要传入根布局,便可以在任何对象中使用注解绑定。

 

public classFancyFragmentextendsFragment {@Bind(R.id.button1) Button button1;
  @Bind(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:
static classViewHolder {@Bind(R.id.title) TextView name;
    @Bind(R.id.job_title) TextView jobTitle;

    public ViewHolder(View view) {
      ButterKnife.bind(this, view);
    }
  }

 

提供的其他绑定API:

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

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


 

View 列表

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

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

使用这种绑定时,你可以使用apple函数。该函数相当于将在这个列表中每一个元素上进行调用:

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

ActionSetter接口能够让你指定一些简单的动作:

staticfinal ButterKnife.Action<View> DISABLE = new ButterKnife.Action<View>() {
  @Overridepublicvoidapply(View view, int index){
    view.setEnabled(false);
  }
};
staticfinal ButterKnife.Setter<View, Boolean> ENABLED = new ButterKnife.Setter<View, Boolean>() {
  @Overridepublicvoidset(View view, Boolean value, int index){
    view.setEnabled(value);
  }
};

Android的Property也可以使用到apple方法中:

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

监听器绑定

在Butter Knife中,监听器也自动地配置到方法上:

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

监听器所有的参数都是可选的:

@OnClick(R.id.submit)
publicvoidsubmit(){
  // TODO submit data to server...
}

定义一个其他的类型,Butter Knife也能识别:

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

同时指定多个id的控件到同一个事件监听上:

@OnClick({ R.id.door1, R.id.door2, R.id.door3 })
publicvoidpickDoor(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 classFancyButtonextendsButton {@OnClick
  public void onClick() {
    // TODO do something!
  }
}

Fragment绑定注意:

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

public classFancyFragmentextendsFragment {@Bind(R.id.button1) Button button1;
  @Bind(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;
  }

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

对于包含多个方法的监听器

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

@OnItemSelected(R.id.list_view)
voidonItemSelected(int position){
  // TODO ...
}

@OnItemSelected(value = R.id.maybe_missing, callback = NOTHING_SELECTED)
voidonNothingSelected(){
  // TODO ...
}

简单的findViewById

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

如果你只是使用这个方法,可以使用静态引入ButterKnife.findById

使用

Butter Knife的代码和例子都可以在GitHub上找到:Butter Knife GitHub

查看Butter Knife的API文档现在也可以查看:Butter Knife Javadoc

MAVEN

声明以下依赖库:

<dependency>
  <groupId>com.jakewharton</groupId>
  <artifactId>butterknife</artifactId>
  <version>(insert latest version)</version>
</dependency>

GRADLE

我在android studio 2.2中添加这个库的时候也报了Error:Could not find com.android.support:support-annotations:24.1.0.这个错误,希望找到解决方法的同学指出。

compile 'com.jakewharton:butterknife:(insert latest version)'

注意在build.gradle中取消lint的如下警告:

lintOptions {
  disable 'InvalidPackage'
}

你也有可能需要如下配置:

packagingOptions {
  exclude 'META-INF/services/javax.annotation.processing.Processor'
}

ProGuard

Butter Knife使用动态生成的代码,这可能使ProGuard认为这些代码是无用的。为了避免这些代码被混淆,你可以添加如下代码到你的ProGuard中:

-keep class butterknife.** { *; }
-dontwarn butterknife.internal.**
-keep class **$$ViewBinder { *; }

-keepclasseswithmembernames class * {
    @butterknife.* <fields>;
}

-keepclasseswithmembernames class * {
    @butterknife.* <methods>;
}

 

详情查看原文章:http://www.jianshu.com/p/9ad21e548b69

本文转载自:http://www.jianshu.com/p/9ad21e548b69

肖朝胜
粉丝 0
博文 7
码字总数 5009
作品 0
程序员
私信 提问
Android组件化demo实现以及遇坑分享

首先贴出demo的github地址:GitHub - TenzLiu/TenzModuleDemo: android组件化demo 前言 前段时间看到最近一直很火的Android组件化然后就自己撸了一个demo,期间遇到了不少问题以及坑,在此记...

codeGoogle
2018/07/26
0
0
ButterKnife 牛油刀使用

一、butterknife介绍   ①官网 butterknife        ②Field and method binding for Android Views which uses annotation processing to generate boilerplate code for you   【......

小群子0618
2018/09/14
0
0
Android Butterknife(黄油刀) 使用方法总结

前言: ButterKnife是一个专注于Android系统的View注入框架,以前总是要写很多findViewById来找到View对象,有了ButterKnife可以很轻松的省去这些步骤。是大神JakeWharton的力作,目前使用很广...

技术小能手
2018/08/24
0
0
Android注解神器 ButterKnife框架

前言: 本人是一个只有几个月工作经验的码小渣。这是我写的第一篇博客,如有不足之处还请大家不要介意,还请大佬可以指出问题。 在这几个月的实战开发中自己也遇到了很多问题,真的是举步艰难...

码小渣
2018/11/03
0
0
【Android】如何实现ButterKnife

如何实现ButterKnife ButterKnife的原理简述 示例代码ButterKnifeProcedure Pluggable Annotation Processing 注解处理器Java5 中叫APT(Annotation Processing Tool),在Java6开始,规范化为......

xesam
2015/06/08
2.1K
0

没有更多内容

加载失败,请刷新页面

加载更多

Mybatis Plus删除

/** @author beth @data 2019-10-17 00:30 */ @RunWith(SpringRunner.class) @SpringBootTest public class DeleteTest { @Autowired private UserInfoMapper userInfoMapper; /** 根据id删除......

一个yuanbeth
59分钟前
4
0
总结

一、设计模式 简单工厂:一个简单而且比较杂的工厂,可以创建任何对象给你 复杂工厂:先创建一种基础类型的工厂接口,然后各自集成实现这个接口,但是每个工厂都是这个基础类的扩展分类,spr...

BobwithB
今天
4
0
java内存模型

前言 Java作为一种面向对象的,跨平台语言,其对象、内存等一直是比较难的知识点。而且很多概念的名称看起来又那么相似,很多人会傻傻分不清楚。比如本文我们要讨论的JVM内存结构、Java内存模...

ls_cherish
今天
4
0
友元函数强制转换

友元函数强制转换 p522

天王盖地虎626
昨天
5
0
js中实现页面跳转(返回前一页、后一页)

本文转载于:专业的前端网站➸js中实现页面跳转(返回前一页、后一页) 一:JS 重载页面,本地刷新,返回上一页 复制代码代码如下: <a href="javascript:history.go(-1)">返回上一页</a> <a h...

前端老手
昨天
5
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部