修改ButterKnife bug的实战经验

Posted 2022-03-30 薛瑄

前言

不得不说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，推荐如何让注解处理器支持 Kotlin？，KAPT(Annotation Processing for Kotlin)是什么，文章中提到的stub和我实际看到的不太一样，可能因为kapt已经更新了吧）

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

Bug的解决思路

总思路：在生成Id（Butterknife 中的Id类）类的时候，通过遍历R引用，把整数替换为对应的R引用，

怎么实现呢？

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

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

根据env中的获取到R 文件的Element ，就获取到JCTree，可能拿到R文件的所有内容，于是问题迎刃而解

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

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

在字节码生成之前

1、JCTree 获取一些源码信息
2、使用JavaPot生成代码类

在字节码生成之后

1、可通过反射修改代码
2、通过ASM、Javassit修改class 代码（实际应用：Android字节码插桩——详细讲解 附带Demo）

图片来自