kotlin碰到的坑-kotlin No field Companion of type

kotlin碰到的坑

No field Companion of type

tl;dr

• 这是在开发sdk碰到坑
• 本质是kotlin编译器问题，也就是kotlin编译前端的问题，如果sdk版本的类文件Companion+JvmStatic标识静态函数的做法改变了应该直接提示编译错误，终止编译
• 引起的原因：
  • sdk A 版本1的类文件 YourClass里面有个Companion对象
  • sdk A 版本2中类文件 YourClass去掉了Companion对象
  • sdk B 版本1依赖了sdk A 版本1
  • app[依赖A和B]中A被强制升级到了版本2， runtime过程中报error如下

java.lang.NoSuchFieldError: No field Companion of type Lcom/*/*/YourClass$Companion;

• 解决方法：
  • 重新编译sdk B， 依赖最新的A的去掉了Companion的版本

dive into detail

简述

当前我们在开发sdk过程中，一个基本的框架sdk原来有个类，譬如YourClass

class YourClass {
    companion object {
        @JvmStatic
        fun install(application: Application) {
        }
        
		@JvmStatic
		fun opertiaon() {
		}
		//......bla bla....
	}
}

后来经过了大半年的迭代，有同事改成了这样子：

object  YourClass{
        @JvmStatic
        fun install(application: Application) {
        }
        
		@JvmStatic
		fun opertiaon() {
		}
		//......bla bla....
}

这个类是一个基本的专门用于函数调用的类，里面没有别的公有或者私有变量，就仅仅是标识了JvmStatic的函数
从class companion改为object，熟悉kotlin的我们都觉得无可厚非，甚至有强迫症的同学看到Companion+JvmStatic标识静态函数这种情形，都会顺手把它改了。

版本迭代

在原来版本中，sdk B的原来版本是1， 也就是带有Companion的版本， 后来迭代更新到了版本2，如下图。
由此可见，app依赖的sdk从原来的A1 、B1， 变成了A1、B2， 在这个过程中经历了大半年，我们也把对应的sdk发布到了生产环境，测试了多轮也没有发现问题。

直到后来，我们在新项目中更新了AS和kotlin plugin, 终于把问题暴露了出来，或者说是新版本的kotlin compiler的兼容性问题。

java.lang.NoSuchFieldError: No field Companion of type Lcom///YourClass$Companion;

查看字节码， jadx VS AS

在runtime中报了一个error， 在此期间我们通过jadx以及as自带的工具查看过dex。

• 在jadx中是能发现问题的，jadx中转译过来的源码类并没有compinion这个field
• AS直接查看从主dex中class.dex直接查看源码结构，里面竟然赫然显示着的确是有compinion这个field的

在jadx和AndroidStudio之间，我们选择了相信AS， 这些工具都是通过字节码读取属性然后再转译出来，有理由相信jadx把compinion忽略了把所有函数直接转为static函数展示.

事实证明这是错误的, jadx是正确的。class.dex中字节码里面并没有compinion这个字段。

验证问题

后来我们直接把A sdk直接基于B2 sdk重新编译一个版本，问题解决。

问题复盘

• 这个是一个kotlin编译器问题，kotlin 编译器应该在编译期间发现这个问题直接终止构建 或者兼容这种写法
• google研究了一下 okhttp 、koin等热门库也有人提出过这种issue，
  • https://github.com/InsertKoinIO/koin/issues/949
  • https://github.com/square/okhttp/issues/5818