关于处理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;
        }

    }

}