AsmButterknife:不一样的Butterknife

前言

在 Android 开发中,对于View的绑定和事件响应回调,相信大家都使用过大名鼎鼎的 Butterknife

笔者也是 Butterknife 忠实使用者,但是在长期的使用过程中,却也发现 Butterknife 还是存在一些缺陷的,或者是说用着爽之余,却总是存在一丝芥蒂。

Butterknife 旨在消除findViewById()这种无趣却又必须的重复性代码,结合注解通过编译期注入代码方式自动为我们注入这些重复性代码。然而,现在大家很多都已经熟知 Butterknife 的实现原理:其实就是使用注解处理器在源文件编译时根据相关注解提取出所需的内容,然后生成一个新的 Java 文件,完成注入事件功能。

借助注解处理器,Butterknife 很好的实现了相应的事件注入功能,然而,也是因为注解处理器,使得其对注入事件的成员或函数的访问权限具备一定的要求(事件注入成员或函数访问权限不能为private,因为事件注入代码生成在同包下的一个类中),无法像手写代码一样,可以是任意权限。

总结一下,笔者认为 Butterknife 具备两个相对来说比较明显的缺点:

  1. 事件注入成员和函数不能使用私有访问权限,封装性不彻底。
  2. 事件注入会经过一个反射调用生成类过程,在 Android 领域,一涉及到反射,总是会担心其性能受到限制(其实对绝大多数情况,一点反射对性能来说应该是影响不大的,毕竟 Butterknife 作为一个老牌框架,必须的缓存机制还是存在的,除了第一次反射加载生成类,后续使用都无需再次反射获取,因为已经缓存了)。

就像是 Jake Wharton 大神只是为了消除 findViewById()这类重复性代码,就撸出了 Butterknife,我在使用过程中,觉得上面两个地方是可以消除的,做到真正的像手写代码一致的效果,于是就尝试撸出了 AsmButterknife.

原理

AsmButterknife 实现的功能与 Butterknife 完全一致,只是我认为其更接近 Butterknife 的实现意图,去除手动书写findViewById()以及其他事件响应注册,通过注解在编译期间自动完成事件注入。之所以说更接近,是因为使用 AsmButterknife 生成的类文件与手动书写findViewById()和其他事件响应生成的字节码完全相同,只是在编译期间,自动注入findViewById()和事件响应这些字节码到源文件中。

因此,AsmButterknife 的实现原理其实就是 字节码注入,在 Java 编译器将源文件编译成 class 文件后,通过扫描类文件的相关注解信息,完成对应事件的字节码注入,其生成的字节码与手动书写生成的字节码是一样的,所以,在源码中使用@BindView@OnClick这些注解的时候,对注入的类成员与事件响应函数的访问权限完全与手动书写代码的一致(即可以使用privatepackageprotectedpublic修饰),也无需使用Butterknife.bind()方法去加载事件注入类,而只需通过注解指定事件注入方法,具体操作看下文。

简而言之,使用 AsmButterknife,就相当于手动书写了这些事件响应代码,只是采用了与 Butterknife 相似的注解方式。

下载

首先,配置 classpath:

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
      classpath 'com.whyn:asmbutterknife-plugin:<latest-version>'
    }
}

最新版本请查看:asmbutterknife-plugin
然后,apply 到你的 module:

apply plugin: 'com.whyn.plugin.asmbutterknife'

使用方法

AsmButterknife 意在实现与 Butterknife 相同的功能,因此其接口会最大限度与 Butterknife 保持一致。上文已经提及,由于底层实现的不同,AsmButterknife 无需手动去加载事件注入类,即Butterknife.bind()函数无需使用,而其他的注解@BindView,@OnClick等会保持与 Butterknife 相同的命名与作用,在 Butterknife 中怎么使用,在 AsmButterknife 中就怎么使用。

下面介绍具体使用方法

  • 注入事件,比如注入findViewByIdOnClickListener:
static class ViewHolderTest extends RecyclerView.ViewHolder {

    @BindView(R.id.item)
    private TextView tv; //note that we can use private modifier

    @ViewInject //default value: @ViewInject(ViewInject.ViewHolder)
    public ViewHolderTest (View item) {
        super(item);
        this.tv.setText("with @ViewInject,event bytecodes will be inject below super(item)"); //correct,no NullpointerException
    }

    @OnClick(R.id.item)
    private void onClick() { //note that we can use private method
        Toast.makeText(this.tv.getContext(), (String) this.tv.getTag(), Toast.LENGTH_SHORT).show();
    }
}

rebuild一下,看下生成的类文件:

ViewHolder

红色方框中的代码就是注入的字节码反编译后的 Java 源码。

  • 注入Activity:注入Activity也可以使用上面的 @ViewInject(ViewInject.ViewHolder)方法,但是需要手动在适当的地方调用,比如:
public class MainActivity extends AppCompatActivity {

    @BindView(R.id.tv)
    private TextView mTextView;

    @Override
    public void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        View view = this.getWindow().getDecorView(); 
        this.inject(view); //you have to call the view inject method
    }

    @ViewInject
    private void inject(@NonNull View view){ //View must be the first argumnet
        //leave it empty,bytecode will be injected into this method 
    }

    @OnClick(R.id.tv)
    private void onTextViewClick() {
        Toast.makeText(this, "onTextViewClick", Toast.LENGTH_SHORT).show();
    }
}

如果注入的是Activity,那么更简单的方式如下:

public class MainActivity extends AppCompatActivity {

    @BindView(R.id.tv)
    private TextView mTextView;

    @Override
    @ViewInject(ViewInject.ACTIVITY) //specify Activity
    public void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        //with @ViewInject(ViewInject.Activity),bytcode will be injected after setContentView
    }


    @OnClick(R.id.tv)
    private void onTextViewClick() {
        Toast.makeText(this, "onTextViewClick", Toast.LENGTH_SHORT).show();
    }
}

rebuild一下,看下生成的类文件:

Activity

红色方框中的代码就是注入的字节码反编译后的 Java 源码。可以看到,如果@ViewInject指定的是Activity,那么事件字节码会注入到onCreatesetContentView方法下面。

TODO

目前功能只完成了@BindView@OnClick ( ╯□╰ ),其他功能后续会不定时添加。

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

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 172,032评论 25 707
  • 文/霍辉 XX老师: 您好,感谢您一学期来对佳禾的关心与鼓励。我们知道佳禾有很多毛病,上课不太听讲,也不太懂事,作...
    霍霍的小世界阅读 701评论 1 5
  • 下雨天和发小游苏州,让人很放松的一座城~
    陈ED尔东阅读 55评论 0 0
  • 闲逸的梦醒了 我窥见瓶枝的苍白 于是 在静默的夜里 揉碎自己 就这样魂归泥土 寻回血脉根系 我知道郁结着怎样的期待...
    袭瞬阅读 191评论 2 1