在比较早的时候预研kotlin解析的时候找到了一个比较好用的kotlin parse的库,但是作者在说明中提到这个项目已经处于不维护的状态了。所以对这个库的稳定性一直存在的一定的疑惑。结果问题就出来了。
问题
测试同学反馈的主要问题是他通过代码diff看到的改动文件是有10+以上的,但是实际上要求代码覆盖的文件只是在2个文件左右,那问题出现在哪里的。
根据以前的经验分析,我自己刚看到问题的时候想到的应该是因为kotlin那块方法diff那块的逻辑没有处理好导致的,或者说变动的文件其实是一个接口类或者说是实体类的原因,所以带着这个疑问开始看下具体的问题。
首先先排查了变动类是接口类或者实体类的问题,因为这个直接代码diff就能够很好的区分出来了。开始进行具体的问题调试,结果问题还没到代码diff的位置, 控制台里面已经出现了具体的报错信息了。
看这个问题的堆栈就有点棘手了。因为这里完全是涉及到解析kotlin的库的逻辑了。
解决方法
Kastree is currently not being actively developed.
Another kotlin AST parsing library is kotlinx.ast
这里作者提到了另外一个库, 尝试去了解了下。发现:
kotlinx.ast does not use the Kotlin Compiler for parsing, it is using ANTLR (the Kotlin variant: https://github.com/Strumenta/antlr-kotlin) using the official Kotlin Grammar (https://kotlinlang.org/docs/reference/grammar.html).
这里就比较麻烦了,kotlinx.ast 并不是使用的kotlin 编译器编译的,得到的ats的数据结构肯定是有所区别的,这个又得增加很大的工作量。相当于之前关于kotlin那块的解析逻辑都得重新调研一遍了。
带着些许的不甘心,又尝试去研究了下出问题的地方。发现并不是所有的文件都有问题,只是部分文件报的错。
public class KotlinASTGenerator {
private final Node.File file;
private final String filePath;
public static final Parser parser = new Parser();
public KotlinASTGenerator(String kotlinText, String filePath) {
this.filePath = filePath;
file = parser.parseFile(kotlinText, false);
}
...
}
由于其实这个调用第三方的库的逻辑很简单,只是需要传一个String的文本数据就可以了,所以我们尝试拿到要解析的文本后,直接main方法中直接调用试试看
// 这里的code1 直接hard code 进行赋值了。
KotlinASTGenerator kotlinASTGenerator1 = new KotlinASTGenerator(code1, "path");
结果意外的发现是竟然是可以解析成功的。这个结果让人重新燃起了有希望能解决的想法,到这里其实很大的可能性去怀疑是因为环境的问题了。
我们一次列举了可能的一些影响因素
- maven库依赖版本的问题
- 多线程解析code导致异常
- parser解析某个文件后导致后续的文件解析都存在某些问题。
- ...
尝试一一排查各个问题,结果无一例外的令人失败,都不是导致问题的原因。
有另外一个同事提到: 既然你怀疑是服务环境的问题,那就起一个新的服务来做解析的逻辑,至少能够确认是环境的问题。
说干就干,重新起了一个简单的服务,纯粹用于解析kotlin代码,通过接口尝试调用解析,可以成功。 那么就把原有的服务解析的逻辑对接到新的服务上吧,结果还是有问题!!!
问题到这里地方,其实不得不把问题放在文本的内容上了,即是通过git diff拿到的文本上是否有啥特殊性的问题,并且经过我们复制,粘贴是不是发生了什么变化。
解决
原本的
复制到vscode 再复制出来的文本
通过如上的对比,我们就能比较明显的发现了,原本的\r\n 变成了 \n 很有可能是因为这块的代码编辑是在windwos上编辑的,然后kastree 针对 方法参数的解析没有处理好回车换行的问题。所以才导致了
所以针对这个问题的解决 我们只要增加一行代码即可
public KotlinASTGenerator(String kotlinText, String filePath) {
this.filePath = filePath;
kotlinText = kotlinText.replaceAll("\r\n", "\n");
file = parser.parseFile(kotlinText, false);
}
替换回车换行符即可。