开源中国源码学习（六）——ButterKnife的使用

最新推荐文章于 2021-07-31 16:36:52 发布
最新推荐文章于 2021-07-31 16:36:52 发布
阅读量1.6w 收藏 16
点赞数 7
分类专栏： 读源码&学技术 文章标签： 源码

本文翻译自 Butter Knife官方网站： ButterKnife

简介

用@Bind给字段进行注释并且Butter Knife会根据给定的View ID去查找并自动转换为与你的layout中相匹配的View。

Activity Binding

Activity绑定示例代码如下：

class ExampleActivity extends Activity {
  @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...
  }
}

代替缓慢的反射，代码通常表现的跟View看起来的样子。调用bind委托这些通用的代码你可以看到和debug.

上面的例子中的通用代码生成的代码大概是下面的样子：

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

NON-ACTIVITY BINDING（对inflate得来的View进行绑定）

你也可以绑定在自定义对象上来支持你自己的view root。

public class FancyFragment extends Fragment {
  @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;
  }
}

对View Holder 进行绑定

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 {
    @Bind(R.id.title) TextView name;
    @Bind(R.id.job_title) TextView jobTitle;

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

你可以上述提供的例子中看到这些技巧的具体应用：

你可以在任何地方调用ButterKnife.bind而不是调用findViewById.

其它的已提供的绑定API：

绑定自定义对象，使用一个Activity作为view根节点。如果你使用了像MVC这样的模式你可以使用它的Activity来绑定控制器，借助 ButterKnife.bing(this , activity).

使用ButterKnife.bind(this)绑定一个view的子节点字段.如果你用了节点在你的布局里或者自定义view的构造方法里使用了inflate,你可以立刻调用此方法。或者，从XML反射的来的自定义view类型可以使用它在onFinishInflate回调方法中。

VIEW LISTS

你可以组织复杂的views到一个list或者array中。

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

apply方法允许你对在list中的所有view进行操作.

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

Action和Setter接口允许你具体声明简单的表现

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方法中，作为apply方法的参数。

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

LISTENER BINDING

监听器也可以自动配置进方法中：

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

自定义view可以绑定在他们自己的监听器上并且不需要具体声明一个ID。

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

BINDING RESET

Fragment和Activity相比有不同的生命周期。当在一个Fragment的onCreateView中绑定的时候，需要在onDestoryView中设置Views为null。但是，Butter Knife 有一个 unbind 方法来自动的做这件事。

public class FancyFragment extends Fragment {
  @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);
  }
}

OPTIONAL BINDINGS

默认情况下，@Bind 和 监听器的绑定都是必须的。如果目标view没有被找到的话一个异常将会被抛出。

为了压制这个表现和创建一个可选择的绑定，为字段或者是方法添加一个@Nullable注解

注意：任何名字为@Nullable的注解可以被这样使用。鼓励你使用Android自己的注解库”support-annotations”中的@Nullable注解，参见Android Tools Project.

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

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

MULTI-METHOD LISTENERS

与方法注解相匹配的监听器有多个回调可以被用来绑定在他们中间的任何一个身上。每一个注解都有默认的回调跟它绑定在一起。可以使用callback参数声明一个可替代的回调。

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

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

BONUS

Butter Knife同时还包含了findById方法，这个精简的方法依然可以找到目标view在一个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);
Add a static import for ButterKnife.findById and enjoy even more fun.

下载

Butter Knife v7.0.1 JAR 下载
Butter Knife Github 地址
Butter Knife Java Docs 地址

MAVEN

如果你使用Maven进行编译，你可以声明这个library作为你的依赖

<dependency>
  <groupId>com.jakewharton</groupId>
  <artifactId>butterknife</artifactId>
  <version>7.0.1</version>
</dependency>

GRADLE

compile ‘com.jakewharton:butterknife:7.0.1’

确定压制住这个lint 警告在你的build.gradle文件中。

lintOptions {
  disable 'InvalidPackage'
}

一些配置可能也需要单独的处理

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

IDE CONFIGURATION

一些IDE需要额外的配置为了使注解能够使用

  • IntelliJ IDEA —— 如果你的工程使用了额外的配置（比如 Maven 的 pom.xml）那么annotation 进程就可以工作了。如果没有，试试 manual configuration
  • Eclipse —— 设置 manual configuration

PROGUARD

Butter Knife 动态的生成和使用class，这意味着静态的分析工具像ProGuard可能会认为这是无用的。为了阻止他们被移除，明确的标明他们将要被保持。为了阻止ProGuard 重命名class，在该class中使用了@Bind来注解一个成员变量，因此需要使用keepclasseswithmembernames 。

混淆代码如下

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

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

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

总结

在项目中碰到的问题，如下：

在开源中国源码中，Butter Knife 使用的是：ButterKnife.inject(this)

    @InjectView(R.id.quick_option_iv)
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        ButterKnife.inject(this);
    }

而在读官网doc时，发现该方法并不存在，却是: ButterKnife.bind(this)

     @Bind(R.id.tv1) TextView tv1;
    @Bind(R.id.tv2) TextView tv2;
    @Bind(R.id.tv3) TextView tv3;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        ButterKnife.bind(this);

        tv1.setText("tv1");
        tv2.setText("tv2");
        tv3.setText("tv3");
    }

并且在代码中进行试验 inject也不可以使用，后来找到了原因:

  1. 在开源中国中使用的是——butterknife-6.1.0.jar
  2. 官网文档配套的是——butterknife-7.0.1.jar

找到了答案，这应该是版本问题

关于这类的注解，其实我并不喜欢，使用快捷键也不怎么费事，相反，我总是担心过度的使用ButterKnife反而会因为要寻找组件带来的其它的额外开销 ，总之，有个度就行

张庚
关注
  • 7
    点赞
  • 踩
  • 16
    收藏
    觉得还不错? 一键收藏
  • 7
    评论
专栏目录
ButterKnifeDemo
06-05
解决ButterKnife 8.8.1版本在library中不能使用的问题，博客地址https://blog.csdn.net/zyw0101/article/details/80399225
Android Butterknife（黄油刀） 使用方法总结
Sahara_Savage
09-07 8万+
转载请标明出处：http://blog.csdn.net/donkor_/article/details/77879630 前言： ButterKnife是一个专注于Android系统的View注入框架,以前总是要写很多findViewById来找到View对象，有了ButterKnife可以很轻松的省去这些步骤。是大神JakeWharton的力作，目前使用很广。最重要的一点，使用Butter...
ButterKnife使用详解
热门推荐
ITjianghuxiaoxiong的专栏
12-04 9万+
在android编程过程中，我们会写大量的布局和点击事件，像初始view、设置view监听这样简单而重复的操作让人觉得麻烦类，所以可以采用注解的方式去实现，而ButterKnife则是注解中相对简单易懂的很不错的开源框架，接下来就介绍一下如何使用。基本参照官方文档，加上自己的心得。 使用心得： 1.Activity ButterKnife.bind(this);必须在setConten
butterknife使用
xyy20154528的博客
03-23 137
只在工程里配置没有用，一定一定要下插件！ 1.下插件 2.使用教程链接：https://blog.csdn.net/woaixuexihhh/article/details/90639970?depth_1-utm_source=distribute.pc_relevant.none-task&utm_source=distribute.pc_relevant.none-task ...
ButterKnife 使用
tlxzuo的博客
05-07 211
setting--&gt;Plugins  找到安装 Android ButterKnife Zelezny工程build.gradle中添加 dependencies { classpath 'com.jakewharton:butterknife-gradle-plugin:8.5.1' }项目app build.gradle中添加apply plugin...
安卓Android源码——Oschina客户端.zip
10-12
Oschina客户端是基于Android平台开发的一款开源中国（Oschina）社区的应用程序，它允许用户浏览技术资讯、参与讨论论坛和管理个人博客等。 1. **项目结构分析** Oschina客户端的源码通常会遵循MVP（Model-View-...
安卓Android源码——AnjoyoSinaWeibo.zip
10-14
《安卓Android源码解析——基于AnjoyoSinaWeibo项目》 在移动开发领域，安卓Android作为主流操作系统，其源码研究对于开发者来说至关重要。本文将深入探讨AnjoyoSinaWeibo项目，这是一个针对Android平台的新浪微博...
安卓Android源码——LumaQQ- qq 代码.zip
10-12
LumaQQ可能使用了第三方库，如RxJava进行响应式编程，Dagger进行依赖注入，Retrofit进行网络请求，ButterKnife进行视图绑定，这些都可能在源码中有所体现。 10. **代码版本控制** 开源项目通常使用Git进行版本...
安卓Android源码——精典源码之精品生活.zip
10-14
8. **第三方库集成**：许多开源库简化了Android开发，如Glide用于图片加载，Dagger2进行依赖注入，Retrofit进行网络请求，ButterKnife进行视图绑定等。源码中可能有这些库的使用示例。 9. **动画效果**：Android...
安卓Android源码——超炫丽viewpager用户引导.zip
10-11
本资源"安卓Android源码——超炫丽viewpager用户引导.zip"提供了一个基于ViewPager实现的超炫丽用户引导示例，有助于开发者学习如何创建具有视觉吸引力的用户引导流程。 首先，让我们深入理解ViewPager的工作原理。...
ButterKnife使用Demo
08-12
Android注解框架ButterKnife使用Demo，详情见博客http://blog.csdn.net/u012702547/article/details/52194594
butterknife-7.0.1.jar 及使用demo
09-29
最新的butterknife jar包，版本7.0.1及使用demo。如有不懂可以留言
ButterKnife 控件事件基本实现demo
04-13
学习ButterKnife的好demo，思路清晰，注解全面，欢迎下载品尝
butterknife-6.1.0.jar
03-29
butterknife-6.1.0.jar，安卓开发中用来做view依赖注入的jar包，提高开发效率
ButterKnife的使用
cdc的博客
06-21 243
ButterKnife的使用 引入，在app的build.gradle里面添加： dependencies { implementation 'com.jakewharton:butterknife:8.8.1' annotationProcessor 'com.jakewharton:butterknife-compiler:8.8.1' } 使用 为字段或方法添加...
Butterknife使用(学习总结)
唯鹿的博客
08-31 2380
首先开源项目地址：https://github.com/JakeWharton/butterknife 这里汇总一下使用方法： 1、Butterknife最新7.0.1 使用教程：点击打开链接 2、Butterknife 7.0之前使用教程：点击打开链接 这里需要注意eclipse的配置：配置完成后重启eclipse， 确保你的项目的根目录里有一个.apt_generat
ButterKnife 用法
qq_26787409的博客
07-31 155
介绍 ButterKnife是一个专注于Android系统的View注入框架,以前总是要写很多findViewById来找到View对象，有了ButterKnife可以很轻松的省去这些步骤。使用ButterKnife对性能基本没有损失，因为ButterKnife用到的注解并不是在运行时反射的，而是在编译的时候生成新的class。 GitHub地址：https://github.com/JakeWharton/butterknife 原理 利用了IOC的(Inverse of Controll)控制反转结
ButterKnife简单使用
xieyu1999的博客
12-26 229
在项目的build.gradle中添加一行代码 dependencies { classpath 'com.android.tools.build:gradle:3.2.0' //Butterknife classpath 'com.jakewharton:butterknife-gradle-plugin:8.8.1' } 在你的a...
butterknife 使用
最新发布
07-27
要使用ButterKnife，需要进行以下步骤： 1. 在项目的build.gradle文件中添加ButterKnife的依赖： ```groovy dependencies { implementation 'com.jakewharton:butterknife:10.2.3' annotationProcessor '...
评论 7
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值