jacoco关于getter setter的方法的过滤

在java中我们经常会定义一些JavaBean的对象比如说 xxxDto, xxxVo等等。里面总是或多或少会出现getter setter的方法, 然后这些方法并不是业务测试人员真正关心的内容,同时这些方法往往还会降低覆盖率的情况。在github的issue中搜索了一番后,还真的找到了相关的信息。

Add filter for plain getter and setter

这个issue中将关于ant, cli, core, gradle等方式的逻辑都处理了, 例子如下:

private String name;
private boolean valid;

// Ignored because of the name 'getName' and the body
public String getName() {
   return name;  
}

// Ignored because of the name 'setName' and the body
public void setName(String name) {
   this.name = name; 
}

// Not ignored because of the custom body
public void setName(String name) {
   if (name.length() > 0) {
      this.name = name; 
   }
}

// Ignored because of the name 'isValid' and the body
public boolean isValid() {
   return valid; 
}

// Not ignored because of the custom name 'valid'
public boolean valid() {
   return valid; 
}

我们重点就看core这块的处理逻辑就好了。

public class PlainGetterAndSetterFilter implements IFilter {

    public void filter(final MethodNode methodNode,
                       final IFilterContext context, final IFilterOutput output) {

        if (isCandidate(methodNode, context)) {
            output.ignore(methodNode.instructions.getFirst(),
                    methodNode.instructions.getLast());
        }
    }
    ...
}

代码主要是通过isCandidate来判断这个方法是否需要被忽略掉,不需要进行jacoco的方法处理。

private boolean isCandidate(final MethodNode methodNode,
                                final IFilterContext context) {
    return methodNode.instructions.getFirst() != null
            && (isGetter(methodNode, context)
            || isSetter(methodNode, context));
}

private boolean dependsOnAttribute(final MethodNode methodNode,
                                   final IFilterContext context, final int split) {
    final String attributeName = methodNode.name.substring(split, split + 1)
            .toLowerCase() + methodNode.name.substring(split + 1);
    return context.getClassFields().contains(attributeName);
}

private boolean isGetter(final MethodNode methodNode,
                         final IFilterContext context) {
    if (methodNode.name.startsWith("get") && methodNode.name.length() > 3) {
        return dependsOnAttribute(methodNode, context, 3)
                && new GetterMatcher().match(methodNode);
    } else if (methodNode.name.startsWith("is")
            && methodNode.name.length() > 2) {
        return dependsOnAttribute(methodNode, context, 2)
                && new GetterMatcher().match(methodNode);
    }
    return false;
}

isCandidate 中判断了对应的方法是否是isGetter 或者 isSetter

关于判断是否是getter的逻辑其实不难, 这里主要是:

  1. 判断方法的名称是否是is或者get开头, 同时方法的名称剩余部分的名称必须是类的成员变量的名称一致。
  2. new GetterMatcher().match(methodNode) 方法体必须满足这个条件。

这里我们需要重点看下 GetterMatcher的逻辑

 private static class GetterMatcher extends AbstractMatcher {
    private boolean match(final MethodNode methodNode) {
        firstIsALoad0(methodNode);
        nextIs(Opcodes.GETFIELD);
        nextIsReturn();
        return cursor != null;
    }

    private void nextIsReturn() {
        next();
        if (cursor == null) {
            return;
        }
        if (cursor.getOpcode() < Opcodes.IRETURN
                || cursor.getOpcode() > Opcodes.ARETURN) {
            cursor = null;
        }
    }
}

这个内容看起来真的有点懵,因为这块其实是涉及到了字节码的逻辑了。这里讲起来其实很复杂, 所以我们就举个栗子来说明下:

package com.xx.dto;

public class AppDto {

    private int jarStatus;
    private int projectType;

    public int getProjectType() {
        return projectType;
    }

    public void setProjectType(int projectType) {
        this.projectType = projectType;
    }

    public int getJarStatus() {
        return jarStatus;
    }

    public void setJarStatus(int jarStatus) {
        this.jarStatus = jarStatus;
    }
}

假设我们现在有个类是这样子的,那么通过javac 编译以后,我们看到的字节码的内容是如何的呢?

我们可以针对编译后的class进行反编译进行查看

javap -c AppDto.class 

就能得到如下的结果:

image

针对getProjectType 的方法内容 return projectType; 直接变成了

0: aload_0
1: getfield      #2                  // Field projectType:I
4: ireturn

再回来看match的逻辑就大概能够看懂了, 它其中已经严格要求了你的getter以及setter的具体逻辑是如何了。

所以我们思考下假设我们的getter方法是如下的是否能够被成功过滤掉呢?

public Date getUpdatedAt() {
    return this.updatedAt == null ? new Date() : this.updatedAt;
}

很明显这个是不行的,我们不妨也反编译下看下具体的内容是怎么样的

image

已经不不符合我们的预期了。

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

推荐阅读更多精彩内容