ButterKnife 原理解读

ButterKnife 原理

最近在研究 Java 中的 Annotation,初衷是先了解注解,然后再了解下 Android 开发中常用框架的原理。经历的 Android 项目中,使用注解比较多的是:ButterKnife, Roboguice, Dagger 。ButterKnife 主要是 View Binding, 而 Roboguice 和 Dagger 则主要是做 DI(Dependency Injection)。本文主要研究 ButterKnife 的原理。

开始之前,还是应该向 ButterKnife 的作者 Jake Wharton 大神以及开源社区致敬。

ButterKnife 初瞰

ButterKnife 到底是什么?看看官方的解释:

Bind Android views and callbacks to fields and methods.

通过 ButterKnife 官方文档,我们可以很快速的使用它。并且可以看到 ButterKnife 主要是实例化 View 或者给某个 View 添加各种事件 Listenters。

ButterKnife View Binding

所以使用 ButterKnife 主要有几步:

1.Gradle 中引入 ButterKnife 框架:

compile 'com.jakewharton:butterknife:8.0.1'

2.ButterKnife 初始化:

@Override
protected void onCreate(Bundle savedInstanceState) {          
    super.onCreate(savedInstanceState);   
    setContentView(getLayoutResourceId());    
    ButterKnife.bind(this);
}}

3.声明 Field/Method

@Bind(R.id.btn_home)ImageView homeBtn;
@Bind(R.id.btn_explore)ImageView exploreBtn;
@OnClick(R.id.btn_home) void clickHomeBtn() {      
    // Handle the home btn click
}

Java Annotation

如果你对注解了解比较少,在进一步了解 ButterKnife 之前,有必要了解一下 Java Annotation 的基础知识。可以参考如下两份资料:

  1. Mkyong Java Custom Annotations
  2. Trenia Java Annotations

通过上面的例子以及讲解,我们可以知道如何自定义注解。自定义注解我们需要知道两个基础的元注解@Retention@Target.

元注解 @Retention

@Retention 保留时间:有三类值可以选择,SOURCE RUNTIME CLASS

SOURCE 源码时保留:使用此类的注解多为标记注解,比如 @Override@Deprecated@SuppressWarnings 等。

RUNTIME 运行时保留:程序在运行过程中,使用这些 Annotation, 比如我们常用的 @Test

CLASS 编译时保留:Java 文件在编译时由 apt 自动解析,需要自定义类继承自 AbstractProcessor 并重写 Process 函数。比如 ButterKnife 中使用的 @BindView, @OnClick 等就是声明为 CLASS 的。

元注解 @Target

Target 表示注解可以用来修饰哪些元素。可选值包括 TYPE, METHOD, CONSTRUCTOR, FIELD, PARAMETER 等。

ButterKnifeProcessor

ButterKnife 中所有的注解都使用 Retention 为 CLASS 保留。所以在 ButterKnife 中,有个很重要的 ButterKnifeProcessor。当 java 文件进行编译时,ButterKnifeProcessor 的 process() 方法被调用,生成相关的 ViewBinder 类,用于将 View 或者 Listener 进行绑定。

ButterKnifeProcessor 的关键逻辑如下:

ButterKnifeProcessor.process()

process() 会找到所有 ButterKnife 相关的 annotation,并将这些相应的注解生成为 ViewBinder 类,一个 ViewBinder 示例如下:

Screen Shot 2016-05-11 at 2.52.20 PM.png

ViewBinder 通过 findViewById 实例化 Activity 中页面上的组件,并且能够设置各控件的点击时间,滑动事件等。

为什么 ButterKnife Annotation 的字段或者方法不能声明为 private?

bind() 方法中,通过 activity.homeBtn 对 View 赋值。因此所有 ButterKnife annotation 标记的 field 或者 method 都不能声明为 private, 因为 private 没办法在 ViewBinder 中直接访问。由此可见:

ButterKnife 并不是依靠反射实现 View Injection 的!

ButterKnife.bind(this)

在 ButterKnife 工作之前,我们一定得在设置 View 后调用 ButterKnife.bind(Activity) ,这样才能使 ButterKnife View 注入成功。那么 ButterKnife.bind(Activity) 是如何工作的呢?

ButterKnife.bind(this)

App 在打包时,ButterKnife Processor 就为所有使用 ButterKnife 注解的 Activity 生成 ViewBinder()。通过上述代码可以看到,ButterKnife 会尝试实例化当前 Activity 所关联的所有 ViewBinder 类。实例化之后再调用 ViewBinder.bind(...) 方法,bind() 方法是在 App 运行过程中才会被调用的。于是当前 Avtivity 的 View 被实例化赋值,如果有点击事件的注解,也会绑定相应的事件。

结语

ButterKnife 主要是做 View 注入的,使用起来比较简便。当然如果你想做一些 依赖注入,比如 Android MVP 架构中 Activity 与 Presenter 的依赖。你可能需要借助一些其他的库, 比如 Dagger。研究下 ButterKnife 的原理,才发现这个库做得如此的睿智。

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

推荐阅读更多精彩内容