记录我修改JakeWharton的ButterKnife bug的实用经验

前言

不得不说ButterKnife是一个很有学习价值的项目。我从学习源码,修改bug后,最后pull request,学到了很多东西。如果你对Butterknife 源码还不了解,建议先看一下这篇文章。本文章不介绍基础的源码流程,主要是深入一部分代码,分享一些我在调试bug,修改bug的经验。

与其拿着一个黑盒子看着表面,不停得猜测里面到底哪里出了问题,不如打开盒子看一下,看懂它的逻辑,比在外面猜要容易的多。

找个bug去练手

在前不久学习完了ButterKnife 源码后,总有一种纸上得来终觉浅,绝知此事要躬行的感觉,于是我打算去issue中找一些bug改改,顺便看看自己是否完全了解了这个源码。最后找了一个多人反映的问题Missing resource ID for OnClick annotation,就开启源码,进行bug的定位。

简单描述一个问题,当子module使用kotlin时,对于相同的资源,如果在事件注解(例如:@OnClick)之前不使用其他注解(例如:@bindview),就会出现崩溃。

Bug 定位

调试后发现,在生成view_binding.java之后,Utils.findRequiredView() 使用原始整数而不是 R 引用,发现这个整数在apk中R文件,没有对应的参数值。也就是说没有这个资源。

正常情况:

在这里插入图片描述

ButterKnife生成代码如下,可以看到上面都是使用的R引用,所以不会出现资源找不到的问题

在这里插入图片描述

异常情况

注释掉@BindView的代码

在这里插入图片描述

ButterKnife生成代码如下,这里直接使用了数字,但是这个数字,在R文件中没有对应的值

在这里插入图片描述

问题来了:

1、这个整数值是哪里来的,为什么没有与代码中的资源对应起来?

2、为什么@OnClick之前使用了 @OnBindView 就正常呢?

3、是butterknife 生成代码的时候出问题?

4、是传递给butterknife的时候,就已经是数字了?

Bug 分析思路

调试后发现这个整数值是子module R文件里的值,但是在打包资源合并后,这个值发生了变化

打包合并资源时,R文件的静态值会被更改。 所以导致 Missing resource ID 。

下图是在反编译apk,观察其中的R文件和R2 文件。(R2是对R的复制,把R中的静态变量,更改为R2中静态常量,变量名和值不变)

在这里插入图片描述

思考过程:

静态常量,编译期常量,编译时就确定值。常量值存储在JVM内存中的常量区中,在类不加载时即可访问。

静态变量,需要类加载后,才能确定具体的值。

难道是因为R2的引入,导致的?但是仔细一想,如果是编译期进行静态常量值替换,那么为什么 不注释掉@BindView的代码,R的引用值就没有被替换呢?所以我把焦点转移到了对View_Binding 文件生成的过程。

因为ButterKnife是在编译期根据注解生成代码的,所以需要在编译期调试代码。

如果是Java,使用注解处理AnnotationProcessor,就使用远程调试,很容易搞定。但是项目是Kotlin,使用注解处理 Kapt,和Java的远程调试不太一样,当时搞了好久断点没作用。

后来决定把这个子module改为Java,先把问题找到,解决了。kapt的调试放后边处理。结果发现使用Java没有任何问题,就是Kotlin有问题,没办法,各种尝试,功夫不负有心人,终于找到了如何调试kapt,可查看我的这篇文章 Java AnnotationProcessor 和 Kotlin Kapt 编译期调试代码——实践与原理

于是开始了愉快的调试,发现在生成Id(Butterknife 中的Id类)就已经使用了整数

在这里插入图片描述

那么就会导致,在生成方法的时候,使用了数字,而不是R引用。我们希望的情况是下图的code 是个R.引用。

在这里插入图片描述

为什么@OnClick之前使用了 @OnBindView 就正常呢?

因为在处理@OnBindView 传入的是R引用,所以在生成代码的时候,上图的code是个R 引用。

同一个资源id(例子中的textview2),会使用相同的Id(Butterknife 中的Id类),所以@OnClick之前使用了 @OnBindView是正常的。

于是我想如果能让上图的code的值,不是数字,而是R引用,那么就可以解决这个问题了。于是一路往上找,看看哪里让他发生了变化。

方法getTree ,返回的JCTree 就已经是整数了,那么跟进去getTree,最后是在一个map中获取对应的值,那我们就继续跟一下,这个map是怎么传值进去的。断点打好,在来一次

在这里插入图片描述

原来传进来的时候就是数字

在这里插入图片描述

后来发现网上也有人遇到这个问题,详见

在跟下去就是kapt的代码了,能力有限,跟不下去了,去网上查了一下kapt。因为这是在注解处理器的过程,难道是kapt的原因?kapt是怎么处理kotlin文件的呢?

kapt 生成的stub中的java文件,已经把静态常量进行了替换。(关于kapt,推荐一篇文章,文章中提到的stub和我真是看到的不太一样,可能因为kapt已经更新了吧)

在这里插入图片描述

能力有限,我修改不了kapt ,所以只能想着怎么在注解处理过程,让这个整数值替换为对应的R引用

Bug的解决思路

总思路:在生成Id(Butterknife 中的Id类)类的时候,通过遍历R引用,把整数替换为对应的R引用,

怎么实现呢?

1、刚开始想到通过反射来修改class文件,代码都写好了,每次调试都发现,找不到class。仔细一想,这个阶段还处在编译期,还没有生成class文件,所以这个方法行不通

2、效仿butterknife 使用语法数JCTree的方式,可不可以获取到R文件的语法树JCTree呢?

根据env中的获取到R 文件的Element ,就获取到JCTree,于是问题迎刃而解

在这里插入图片描述

代码编译过程中,不同阶段使用不同的方式修改编译期代码

最后对之前学到一些知识进行归纳总结

在字节码生成之前

1、JCTree 获取一些源码信息

2、使用JavaPot生成代码类

在字节码生成之后

1、可通过反射修改代码

2、通过ASM、Javassit修改class 代码(实际应用:Android字节码插桩——详细讲解 附带Demo

图片来自

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

推荐阅读更多精彩内容