关于处理jacoco代码diff-Java篇

之前针对jacoco这块代码覆盖率的增量逻辑的处理只是拿到改动的代码的方法后进行对比jacoco中方法的名称, 如果相同我们就认为这个是改动的方法,但是这里就有一个很大的漏洞,java类里面同名方法其实很多的,也就是我们所说的函数的重载这种情况。所以如果按照这种方式,必定导致一个问题就是有一个方法改动后,另外一个方法也需要要求代码覆盖。所以针对这种情况我们不单单需要判断方法的名称,还需要判断方法的参数才行。

JVM方法签名

这里我们需要先了解一个事情就是class文件也就是jacoco解析出来的方法签名(参数是什么样的);

假设我们的源码内容是这样的。

public class Hello {
    public static void main(String[] args) {
        System.out.println("Hello, World");
    }
}

我们通过javap -s 跟上编译后的class文件以后就可以看到对应的方法签名了。

javap -s Hello  
Compiled from "Hello.java"
public class Hello {
  public Hello();
    descriptor: ()V
  public static void main(java.lang.String[]);
    descriptor: ([Ljava/lang/String;)V
}

可以看到 main 函数的方法签名是 ([Ljava/lang/String;)V。JVM 内部使用方法签名与我们日常阅读的方法签名不太一样

字段描述符(Field Descriptor),是一个表示类、实例或局部变量的语法符号,它的表示形式是紧凑的,比如 int 是用 I 表示的。完整的类型描述符如下表

方法描述符(Method Descriptor)表示一个方法所需参数和返回值信息,表示形式为( ParameterDescriptor* ) ReturnDescriptor。 ParameterDescriptor 表示参数类型,ReturnDescriptor表示返回值信息,当没有返回值时用V表示。比如方法Object foo(int i, double d, Thread t)的描述符为(IDLjava/lang/Thread;)Ljava/lang/Object;

所以我们在通过解析到方法是这个的时候(java.lang.String[])需要能够对比jvm中提供的方法签名 ([Ljava/lang/String;)V。

解决

我们使用了比较蠢的方式。就是分别都进行处理解析,然后进行对比。

首先是针对jvm的方法签名的解析

private List<String> parseJvmMethodParams(String desc) {
    // https://juejin.cn/book/6844733778389106702/section/6844733778561105934
    // JVM 使用一个前置的[来表示数组类型,如int[]类型描述符为[I,字符串数组String[]的描述符为[Ljava/lang/String;。
    // 多维数组描述符只是多加了几个[而已,比如 Object[][][] 类型描述符为[[[Ljava/lang/Object;。
    // 去掉数组行的内容
    desc = desc.replaceAll("\\[", "");
    Matcher mat = Pattern.compile("(?<=\\()(\\S+)(?=\\))").matcher(desc);
    String params = "";
    List<String> paramTypes = new ArrayList<String>();
    while(mat.find()){
        params = mat.group();
        break;
    }
    if (!params.equals("")) {
        String[] paramsArray = params.split(";");

        for (String paramsStr: paramsArray) {
            // 这里需要针对paramsStr 做处理,因为有可能参数都是基本的参数类型 比如说 a(int a, int b) 就会变成 II; 其中就没有;
            paramsStr = getBasicParam(paramTypes, paramsStr);
            // 针对剩下的字符串进行处理
            if (!paramsStr.equals("")) {
                String path[] = paramsStr.split("/");
                String methodParam = path[path.length -1];
                // 这里还需要处理下 是否是一个内部类的情况 如: Lcom/seewo/iot/remote/service/impl/setting/AutoPowerOffHandler$TimeMinute
                if (methodParam.contains("$")) {
                    methodParam = methodParam.split("\\$")[1];
                }
                // https://juejin.cn/post/6844903856879435790  针对kotlin的接口 可以实现具体的方法,所以kotlin接口编译的类会
                // 带上DefaultImpls 会导致方法调用里面也会带上对应的类 所以需要过滤 去掉
                if (this.name.endsWith("$DefaultImpls") && this.className.endsWith(methodParam)) {
                    continue;
                }
                paramTypes.add(methodParam);
            }

        }
    }
    return paramTypes;
}

    
    
/**
 * 获取基本的参数类型
 * @param paramTypes 参数类型列表
 * @param paramsStr 参数内容
 */
private String getBasicParam(List<String> paramTypes, String paramsStr) {
    if (!paramsStr.startsWith("L")) {
        // 如果不是引用类型
        if (paramsStr.length() == 1) {
            paramTypes.add(paramTypeMap.get(paramsStr));
            return "";
        }else {
            String basicParamType = paramsStr.substring(0, 1);
            paramTypes.add(paramTypeMap.get(basicParamType));
            return getBasicParam(paramTypes, paramsStr.substring(1, paramsStr.length()));
        }
    }else {
        return paramsStr;
    }

}

再来是我们对比的方法

private boolean isMethodSame(MethodInfo methodInfo, String desc) {
    // 这里比较参数的的情况

    List<String> paramTypes = parseJvmMethodParams(desc);

    // 处理diff java代码的方法解析
    String methodParams = methodInfo.getParameters();
    methodParams = methodParams.substring(1, methodParams.length() - 1);
    // 针对 @RequestBody JSONObject params, @CurrentUser User user,
    // @RequestHeader(value = ENConstant.AUTH_USER_AGENT, required = false, defaultValue = "") String userAgent
    // 这样子的数据处理 去掉()中的内容
    methodParams = methodParams.replaceAll("\\(.*?\\)", "");
    // Map<String,String> uidNickNameMap 类似于这种参数
    methodParams = methodParams.replaceAll("\\<.*?\\>", "");
    // 主要是通过,分割进行获取到各个参数,但是这里面有其他因素影响到,所以需要做前面的字符串的替换。
    String [] diffMethodParams = methodParams.split(",");

    // 参数为空的情况处理 直接返回true;
    if (paramTypes.size() == 0 && methodParams.equals("")) {
        return true;
    } else if (paramTypes.size() != diffMethodParams.length) {
        return false;
    }else {
        if (paramTypes.size() == 0 && diffMethodParams.length == 0) {
            return true;
        }else {
            for (int i =0; i< paramTypes.size(); i++ ) {
                if (!diffMethodParams[i].contains(paramTypes.get(i))) {
                    return false;
                }
            }
            return true;
        }

    }

}

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

推荐阅读更多精彩内容