jacoco：java代码覆盖率实践

Posted 2023-01-09 One Tester

文章目录

• • 一、jacoco基本了解
  • 二、实践准备
  • 三、jacoco使用
  • • 3.1 插桩
    • 3.2 dump:覆盖率文件导出
    • 3.3 report:可视化报告
    • 3.4 merge:合并覆盖率文件
  • 四、相关命令扩展
  • • 4.1 javaagent
    • 4.2 dump
    • 4.3 merge
    • 4.4 report
  • 五、资源链接

一、jacoco基本了解

• jacoco是一款面向java的代码覆盖率工具，通过ASM字节码插桩技术，计算被覆盖的代码块，最后生成代码覆盖率报告。

• jacoco有两种插桩方式，分别为在线(on the fly)和离线(offline)两种模式。两种方式比较中，on the fly模式在使用中更方便，所以一般使用on the fly模式。但是也需要注意：其代理服务会对被测应用造成一定的性能损耗。

  on the fly插桩：jvm通过 -javaagent参数指定特定的jar文件启动Instrumentation的代理程序，代理程序通过ClassLoader装载一个class前判断是否转换修改class文件，将统计代码插入class 测试覆盖率可以在JVM执行测试代码的过程中完成。
  offline插桩:在测试前先对文件进行插桩，然后生成插桩的class或jar包 测试插过桩的class和jar包后，会生成动态覆盖信息到文件，最后统一对覆盖信息进行处理 并生成报告

二、实践准备

jacoco下载：官网下载jacoco，在后面实践中需要用到lib目录下的jacocoagent.jar和jacococli.jar.

被测应用demo: 编写一个简单的springboot的demo，打成jar包上传到VM虚拟机,并将jacocoagent.jar包也上传上去。

三、jacoco使用

3.1 插桩

插桩：运行服务时使用javaagent设置代理并插桩

java -javaagent:jacocoagent.jar=includes=*,output=tcpserver,port=6300,address=192.168.159.132,append=true -jar springboot-demo-0.0.1-SNAPSHOT.jar

测试：访问部署服务的index接口，后面生成覆盖率预期就是index接口这里的代码是已覆盖的。

3.2 dump:覆盖率文件导出

覆盖率文件导出：在本地使用命令访问前面设置的ip、端口并导出生成覆盖率文件。

java -jar jacococli.jar dump --address 192.168.159.132 --port 6300 --destfile ./jacoco_test1.exec

3.3 report:可视化报告

生成覆盖率报告：通过report 命令生成报告，生成报告这个过程是需要有对应的源代码。

java -jar jacococli.jar report jacoco_test1.exec --classfiles .\\springboot-demo-jacoco\\target\\classes --sourcefiles .\\springboot-demo-jacoco\\src\\main\\java --html report01

3.4 merge:合并覆盖率文件

    在实际场景中，可能被测应用是会部署在不同环境中，最终汇总报告的时候需要是总的报告。所以实际中需要不同环境生成不同的exec文件，通过jacoco合并成一份exec文件，最终生成报告。

    这里访问同样代码部署的另一个环境，只访问另外一个接口，并按照前面的命令生成

merge命令：合并两个exec覆盖率文件，生成一个总的覆盖率文件。

java -jar jacococli.jar merge jacoco_test1.exec jacoco_test2.exec --destfile  jacoco_testall.exec

四、相关命令扩展

参考链接：https://blog.csdn.net/lady_killer9/article/details/108255004

4.1 javaagent

-javaagent:[yourpath/]jacocoagent.jar=[option1]=[value1],[option2]=[value2]

4.2 dump

java -jar jacococli.jar dump [--address <address>] --destfile <path> [--help] [--port <port>] [--quiet] [--reset] [--retry <count>]

4.3 merge

java -jar jacococli.jar merge [<execfiles> ...] --destfile <path> [--help] [--quiet]

4.4 report

java -jar jacococli.jar report [<execfiles>...] --classfiles <path> [--csv <file>] [--encoding <charset>] [--help] [--html <dir>] [--name <name>] [--quiet] [--sourcefiles <path>] [--tabwith <n>] [--xml <file>]

五、资源链接

文章中相关demo资源