Lombok导致代码单元测试覆盖率崩塌

这篇具有很好参考价值的文章主要介绍了Lombok导致代码单元测试覆盖率崩塌。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

Lombok 由于其使用的便利性, 目前流传非常广泛。甚至有呼声希望其能被Java官方引入,成为JDK的一部分。

当然凡事都有两面性,Lombok的引入也是有代价的。一时注释一时爽,结果导致代码在不知不觉中翻了好几倍。

例如以下几个简单的注解,背后是N多个自动生成的方法:

  • @Data注解:这是若干个注解的组合,包括有@Setter、@Getter、@ToString和@EqualsAndHashCode的功能,还会添加一个公共的构造方法。staticConstructor 参数可将构造方法置为private,并提供一个获取对象的静态方法。
  • @Builder:使用私有构造函数生成一个名为TBuilder的内部类,创建一个构造器。
  • @NoArgsConstructor:该注解使用在类上,该注解提供一个无参构造
  • @AllArgsConstructor:该注解使用在类上,该注解提供一个全参数的构造方法,默认不提供无参构造方法。

这其中尤其是@Data这个注解,会附带相当多的方法。

默认情况下,由于Jacoco不会区分Lombok生成的代码和正常的源代码。结果,在引入Lombok后就会发现,覆盖率通常会低得让人匪夷所思。例如某个项目,通过Jacoco获取到的代码行数以及覆盖率为:

可见,这个覆盖率是非常低的,会被质量门禁判违规(常见会要求>50%甚至>80%)。

这种情况下,开发者一般会有两个选择:

  1. 专门为这些生成的代码编写单元测试用例
  2. 要求降低质量门禁中的覆盖率要求

通常这两个方案都是不可取的。

专门为这些生成的代码编写用例是没有意义的。既然使用了Lombok,一个默认的前提就是Lombok是正确可靠的,为这些自动生成的代码进行单元测试不是一件高优先级的事情,还是放过已经996的码农和他们的头发吧,要爱护那些愿意写单元测试的好同志。

第二种方案也不可取,这会引入一个非常不好的开始,因为破窗效应,马上质量门禁也没有意义了。千万个教训告诉我们,千万不要去考验人性。

两种选择都没有意义,也都不可取,于是马上就有人想到了第三种方法。

3 手工排除Bean

无论是Jacoco还是Sonar,都提供了exclude的方式,通过配置项来指定统计时排除某些特定的包或者类。如对于Jacoco可以在jacoco-maven-plugin的<configuration>中有如下配置,用于排除指定的内容。

<plugin>
                <groupId>org.jacoco</groupId>
                <artifactId>jacoco-maven-plugin</artifactId>
                <version>0.8.7</version>
                <configuration>
                        <excludes>
                            <exclude>**/*DTO.*</exclude>
                            <exclude>**/domain/**/*</exclude>
                        </excludes>
                    </excludes>
                </configuration>
                <executions>
                    <execution>
                        <id>default-prepare-agent</id>
                        <goals>
                            <goal>prepare-agent</goal>
                        </goals>
                    </execution>
                    <execution>
                        <id>default-report</id>
                        <goals>
                            <goal>report</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>

第一个<exclude>标签将吧所有DTO结尾的类排除,而第二个<exclude>标签将把domain目录和子目录下的所有类都排除出去。

通过这个方式,也可以在数据源头上进行排除。

类似的,还可以通过基于jacoco覆盖率报告来自研解析工具,进行覆盖率或者增量覆盖率计算。这个过程中,也可以指定需要排除的包或者类,实现类似的做法。

当然,这种方式也需要项目有一些项目结构和命名上的约定,以保证过滤的正确。另外,既然放开了过滤的条件,有可能会让人钻空子。

4 使用Sonarqube 而不是Jacoco的结果

虽然Jacoco中的数据受到了lombok的污染,但是SonarQube由于有自身代码行的计算是根据扫描的源码,再根据自身的算法进行计算,并不是根据Jacoco提供的数据。再由此计算覆盖率的时候,就可以部分规避掉这个问题了。所以这是一个正解。当然,由于SonarQube和Jacoco的代码行、覆盖率等算法有差异,最好是保持指标数据源前后的一致性,避免混用。

5 使用lombok.addLombokGeneratedAnnotation

其实从Jacoco 0.8.0开始,其实就具备了可以将lobmok生成的代码从Jacoco报告中排除的能力。发布说明可以参见

https://github.com/jacoco/jacoco/pull/513

具体做法是,在项目的根目录下新建一个名字为lombok.config的文件,里面有如下的内容,

config.stopBubbling = true
lombok.addLombokGeneratedAnnotation = true

Lombok在为由其生成的构造方法、方法、字段和类型中增加@Generated注解,然后Jacoco借助这个注解来实现更为准去的排除。排除以后的结果如下,

当然,这个方案对两者的版本也有限制,要求Lombok >= 1.16.14, jacoco>0.8.0

总结一下,面对lombok,有如下五种解决方案,推荐后两种哦。

1专门为这些生成的代码编写单元测试用例 【X】

2要求降低质量门禁中的覆盖率要求【X】

3手工排除Bean 【X】

4使用Sonarqube 而不是Jacoco的结果【OK】

5使用lombok.addLombokGeneratedAnnotation 【OK】文章来源地址https://www.toymoban.com/news/detail-471576.html

到了这里,关于Lombok导致代码单元测试覆盖率崩塌的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • 特性介绍 | MySQL 测试框架 MTR 系列教程(二):进阶篇 - 内存/线程/代码覆盖率/单元/压力测试

    作者:卢文双 资深数据库内核研发 序言: 以前对 MySQL 测试框架 MTR 的使用,主要集中于 SQL 正确性验证。近期由于工作需要,深入了解了 MTR 的方方面面,发现 MTR 的能力不仅限于此,还支持单元测试、压力测试、代码覆盖率测试、内存错误检测、线程竞争与死锁等功能,因

    2024年02月03日
    浏览(36)
  • springboot项目使用Junit5 + mockito + jacoco 实现单元测试以及代码覆盖率检查

    在创建springboot项目时会默认添加spring-boot-starter-test依赖,其中已经包含了junit、mockito依赖,根据springboot版本的不同junit和mockito的版本也会有所不同 先说一下各自功能: junit只说一点,junt4和junit5的注解不同,使用方式略有差异,其他不赘述了,基本用法都懂。 mockito是mock的

    2023年04月23日
    浏览(43)
  • IDFA 单元测试以及单元测试覆盖率步骤

    1、新建java类 随意选择java类文件,新建一个Java类CountVowel,用来统计字符串中元音的个数,代码如下: 2、生成测试类 一)、对写好的类新建测试类,有以下两种方法: 将鼠标光标移动到类名上,使用 Alt+Enter 组合键,如下图,选择 Create Test ,从而新建一个测试类; 右键点

    2024年02月16日
    浏览(29)
  • 如何计算单元测试的覆盖率

    单元测试的覆盖率有:语句覆盖率(即行覆盖率)、分支覆盖率、条件覆盖率、分支条件覆盖率、路径覆盖率等。 语句覆盖率 所谓语句就是那些非分支、非判断的语句。 计算公式:程序执行到的语句总数 / 全部语句的总数 分支覆盖率 有判定语句的地方都会出现2个分支。

    2024年01月21日
    浏览(40)
  • java 单元测试覆盖率调研

    根据网上的资料搜索发现,现在常用的 java 单元测试覆盖率工具主要有: Emma Cobertura Jacoco Clover(商用) 工具 Jacoco Emma Cobertura 原理 使用 ASM 修改字节码 修改 jar 文件,class 文件字节码文件 基于 jcoverage,基于 asm 框架对 class 文件插桩 覆盖粒度 行,类,方法,指令,分支 行,类

    2024年02月12日
    浏览(28)
  • Sonarqube-8.9版本测试单元测试覆盖率

    junit testNG Spock Jacoco Cobertura SonarQube 不会运行测试或生成报告。要在分析中包含覆盖结果,需要设置第三方覆盖工具来生成报告并配置 SonarQube 以导入这些报告。 生成单元测试覆盖率需要按照以下步骤操作: SonarQube 使用导入的覆盖率报告中的覆盖行和可执行行(或要覆盖的行

    2024年02月02日
    浏览(42)
  • 13.Springboot整合junit5单元测试与生成单元测试覆盖率

    现在基本大公司都要求单元测试了,保证我们代码得质量,而我司更是要求覆盖率要达到60%以上,所以搞一下。 这里有两个方法: 1.使用maven自带得test,idea右侧maven模块执行项目下得test 2.使用cmd命令,在你的项目pom文件所在目录 ,打开cmd,执行如下: 结果如下:打开site文

    2024年02月16日
    浏览(30)
  • 【Maven】单元测试、统计、覆盖率相关插件使用介绍

    maven-surefire-plugin 是 maven 执行单元测试的插件,不显性配置也可以直接使用。 这个插件的 surefire:test 命令会默认绑定 maven 执行的 test 阶段。 执行结束后,默认在 target/surefire-reports 目录下会生成 txt 和 xml 两种格式的结果,不利于直观展示,需要结合其它插件一起使用。 如果

    2024年02月08日
    浏览(27)
  • maven sonar 扫描单元测试覆盖率为0,但是单元测试数不为0

    最初配置如下: sonar 扫描后的单元测试覆盖率为0。但是但与测试数量不为0. 而配置的 sonar : 单元测试数基于 maven-surefire-plugin 插件 单元测试覆盖率基于 jacoco-maven-plugin 插件。 发现 maven 执行后没有 jacoco.exec 文件。导致 sonar 单元测试覆盖率为 0。并且没有下面的 jacoco 结果文

    2024年02月11日
    浏览(25)
  • Springboot 多模块项目集成Jacoco统计单元测试覆盖率

    jenkis服务器需要配置Jacoco 常见报错: Not compiling test sources Skipping JaCoCo execution due to missing execution data file. 修改插件配置

    2024年02月09日
    浏览(28)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包