急！学会 JaCoCo，使用接口自动化测试提高代码覆盖率刻不容缓-优快云博客

本文链接：https://blog.youkuaiyun.com/software_test010/article/details/148698664

📝 面试求职： 「面试试题小程序」，内容涵盖测试基础、Linux操作系统、MySQL数据库、Web功能测试、接口测试、APPium移动端测试、Python知识、Selenium自动化测试相关、性能测试、性能测试、计算机网络知识、Jmeter、HR面试，命中率杠杠的。（大家刷起来…）

📝 职场经验干货：

软件测试工程师简历上如何编写个人信息（一周8个面试）

软件测试工程师简历上如何编写专业技能（一周8个面试）

软件测试工程师简历上如何编写项目经验（一周8个面试）

软件测试工程师简历上如何编写个人荣誉（一周8个面试）

软件测试行情分享（这些都不了解就别贸然冲了.）

软件测试面试重点，搞清楚这些轻松拿到年薪30W+

软件测试面试刷题小程序免费使用（永久使用）

JaCoCo 是什么

JaCoCo是一个开源的Java代码覆盖率工具，全称为Java Code Coverage。它能够帮助开发人员和测试人员了解测试用例对代码的覆盖程度，进而评估测试的完整性和有效性。在软件开发过程中，测试是确保代码质量的重要环节，而代码覆盖率则是衡量测试质量的关键指标之一。通过JaCoCo，我们可以清晰地知道哪些代码被测试覆盖，哪些代码还存在测试盲区，从而有针对性地改进测试用例，提高代码质量。

JaCoCo 具有以下几个显著特点

1.详细的覆盖率报告：可以生成包括行覆盖率、分支覆盖率、方法覆盖率、类覆盖率等多种维度的详细报告，帮助全面了解代码的测试覆盖情况。例如，行覆盖率能直观展示每行代码是否被执行，分支覆盖率则针对条件语句（如if - else、switch - case）的分支执行情况进行统计。

2.轻量级且易于集成：对被测试应用的性能影响极小，并且能够方便地与常见的Java构建工具（如Maven、Gradle）和测试框架（如JUnit、TestNG）集成。在Maven项目中，只需在pom.xml文件中添加相应的插件配置，即可轻松启用 JaCoCo进行代码覆盖率分析。

3.实时覆盖率监测：支持在测试执行过程中实时监测代码覆盖率，及时发现测试覆盖不足的地方，方便开发者及时调整测试策略。

4.多种报告格式：生成的覆盖率报告支持多种格式，如HTML、XML、CSV等。其中，HTML格式的报告具有良好的可视化效果，通过不同颜色区分已覆盖和未覆盖的代码，使开发人员能够一目了然地查看代码覆盖情况，便于分析和定位问题。

代码覆盖率的重要性

在软件开发过程中，代码覆盖率起着举足轻重的作用，它是衡量软件测试有效性和软件质量的关键指标，对软件开发的各个环节都有着深远的影响。

1.衡量测试充分度：代码覆盖率为我们提供了一个直观的量化标准，用以判断测试用例对代码的覆盖程度。较高的代码覆盖率通常意味着测试用例覆盖了更多的代码逻辑和执行路径，测试的全面性更好。

2.发现潜在问题：通过分析代码覆盖率报告，我们能够精准定位到那些未被测试覆盖的代码区域。这些未覆盖的代码很可能隐藏着各种问题，如逻辑错误、边界条件处理不当等。

3.提高代码可维护性：当代码具有较高的覆盖率时，意味着开发人员在编写代码时充分考虑了各种可能的情况，并通过测试用例进行了验证。这使得代码结构更加清晰，逻辑更加严谨，从而提高了代码的可维护性。在后续的代码修改和扩展过程中，基于良好的测试覆盖，开发人员可以更加自信地进行操作，降低引入新问题的风险。

JaCoCo 的工作原理

JaCoCo的核心工作原理是通过字节码插桩（Bytecode Instrumentation）技术来收集代码执行信息，进而计算出代码覆盖率。字节码插桩是一种在字节码层面修改类文件的技术，通过在其中插入特定的代码（即探针，Probe），来实现对代码执行情况的监控和记录。

插桩的概念类似于在代码中设置一些 “观察点”，当程序执行到这些点时，会触发相应的记录操作。在 JaCoCo中，这些观察点被插入到字节码中，以记录代码的执行路径和状态。

JaCoCo主要通过以下两种方式进行字节码插桩

1.On-the-fly 模式（动态插桩）：在JVM启动时，通过-javaagent参数指定jacocoagent.jar文件来启动代理程序。当类被ClassLoader加载之前，代理程序会判断是否需要修改该类文件，并将探针插入到字节码中。这种方式不需要提前对字节码进行处理，使用起来较为方便。例如，在启动一个Spring Boot应用时，可以通过以下命令启用On-the-fly模式的插桩：

# /path/to/jacocoagent.jar是jacocoagent.jar文件的实际路径
# includes=com.testerroad.*表示只对com.testerroad包及其子包下的类进行插桩
# output=tcpserver指定输出方式为 TCP 服务器
# address=127.0.0.1和port=6300分别指定了服务器的地址和端口
java -javaagent:/path/to/jacocoagent.jar=includes=com.testerroad.*,output=tcpserver,address=127.0.0.1,port=6300 -jar your - application.jar

2.Offline 模式（静态插桩）：在测试之前，先对字节码文件（.class文件或.jar包）进行插桩处理，生成插过桩的文件。然后在测试过程中使用这些插过桩的文件，收集覆盖率信息并生成报告。这种方式适用于一些无法使用-javaagent参数的场景，如在不支持Java Agent的环境中。使用 JaCoCo的命令行工具jacococli.jar进行Offline插桩的示例命令如下：

# --dest /path/to/instrumented - classes指定了插桩后的文件输出目录
# /path/to/classes是原始字节码文件的目录
java -jar jacococli.jar instrument --dest /path/to/instrumented - classes /path/to/classes

无论采用哪种插桩方式，JaCoCo插入的探针本质上是一些额外的字节码指令，它们被插入到方法的关键位置，如方法入口、分支点（如if - else、switch - case语句）、循环结构等。这些探针不会改变原有方法的逻辑和行为，只是在代码执行到该位置时，记录下相关信息，例如某个方法是否被调用、某个分支是否被执行等。

具体来说，JaCoCo会为每个被插桩的类创建一个布尔数组，数组中的每个元素对应一个探针。当探针被执行时，相应的数组元素会被设置为true。例如，假设一个类中有多个方法，每个方法中的关键位置都插入了探针，在测试运行过程中，当某个方法被调用时，该方法对应的探针被执行，相应的数组元素就会被标记为true，以此来记录该方法被执行过。

通过这种方式，JaCoCo能够准确地收集到代码在测试过程中的执行信息，然后根据这些信息计算出各种维度的代码覆盖率，如行覆盖率、分支覆盖率、方法覆盖率和类覆盖率等。

使用 JaCoCo 统计代码覆盖率

以Maven项目为例，在项目的pom.xml文件中添加 JaCoCo插件，配置如下：

执行测试并生成报告

完成插件配置后，执行测试命令mvn clean test。这条命令会先清理项目的目标目录（target目录），然后执行所有的测试用例。在测试执行过程中，JaCoCo会收集代码的执行信息，并在测试完成后生成代码覆盖率报告。

代码覆盖率报告生成在target/site/jacoco目录下，主要包含以下几种格式的报告文件：

1.index.html：HTML格式的报告，具有直观的可视化界面，通过不同颜色区分已覆盖和未覆盖的代码，方便开发人员查看和分析。在浏览器中打开index.html文件，会看到一个包含项目结构、包、类以及各种覆盖率指标的详细报告页面。例如，类名以列表形式展示，已覆盖的代码行显示为绿色，未覆盖的代码行显示为红色，部分覆盖的代码行显示为黄色。

2.jacoco.xml：XML格式的报告，适合被其他工具（如持续集成工具、自动化脚本等）解析和处理，以便进行更深入的数据分析和统计。该文件以XML标签的形式记录了每个类、方法、行的覆盖率数据，以及总的覆盖率统计信息。

3.jacoco.csv：CSV格式的报告，以逗号分隔的文本文件形式呈现覆盖率数据，便于导入到电子表格软件（如Excel）中进行数据处理和分析。文件中的每一行代表一个类或包的覆盖率数据，各列分别记录了类名、指令覆盖率、分支覆盖率、行覆盖率等指标。

报告中各项指标的含义如下

1.指令覆盖率（Instruction Coverage）：基于Java字节码指令，计算被执行的指令数占总指令数的百分比。它是最细粒度的覆盖率指标，能够精确反映每条字节码指令是否被执行。例如，对于一个简单的方法public int add(int a, int b) { return a + b; }，其字节码指令包括加载参数、执行加法运算、返回结果等。如果测试用例能够使这些指令都被执行，那么指令覆盖率就是100% 。

2.分支覆盖率（Branch Coverage）：针对每个控制流语句（如if - else、switch - case），计算被执行的分支数占总分支数的百分比。例如，对于

if (a > 10) { // 分支1 } else { // 分支2 }

这样的if - else语句，总共有2个分支，如果测试用例能够覆盖到这两个分支，分支覆盖率就是100%；如果只覆盖了其中一个分支，分支覆盖率则为50% 。

3.行覆盖率（Line Coverage）：计算执行了至少一次的代码行占总代码行的百分比。这里的代码行是指源代码中的物理行，只要某一行中的至少一条指令被执行，该行就被认为是被覆盖的。例如，在一段代码中，有10行代码，其中8行的指令被执行过，那么行覆盖率就是80% 。

4.方法覆盖率（Method Coverage）：计算至少被调用一次的方法数占总方法数的百分比。对于一个类中的所有非抽象方法，如果某个方法在测试过程中被调用了，那么该方法就被视为被覆盖。例如，一个类中有5个非抽象方法，其中3个方法被测试调用，方法覆盖率就是60% 。

5.类覆盖率（Class Coverage）：计算至少被加载一次的类数占总类数的百分比。在测试过程中，如果一个类中的任何方法被执行，或者该类被实例化，那么这个类就被认为是被覆盖的。例如，项目中有10个类，其中8个类在测试中被加载和使用，类覆盖率就是80%。

示例代码分析

给出一个简单的Java类Calculator和对应的单元测试代码，使用 JaCoCo统计其代码覆盖率，以此展示如何通过覆盖率报告发现测试中的不足。

对应的单元测试代码如下：

执行mvn clean test命令后，查看生成的 JaCoCo覆盖率报告。在HTML报告中，可以看到Calculator类的各个方法的覆盖率情况。如果此时没有测试divide方法中除数为0的异常情况，那么在报告中，divide方法中if (b == 0)条件分支的代码行就会显示为未覆盖（红色），这就提示我们测试用例存在不足，需要添加针对该异常情况的测试用例，以提高代码覆盖率。例如，可以添加如下测试用例：

添加上述测试用例后，再次执行测试并查看报告，会发现divide方法的覆盖率得到了提升，之前未覆盖的分支代码行也被覆盖了（显示为绿色或黄色，取决于具体的覆盖情况）。通过这样的方式，我们可以不断完善测试用例，确保代码的质量和可靠性。

JaCoCo 的高级应用

配置覆盖率目标

在pom.xml文件中进一步配置JaCoCo插件，以设置覆盖率目标。例如，我们希望行覆盖率至少达到80%，配置如下：

<execution>标签下的<id>check-coverage</id>用于标识该执行配置，可自定义 。
<goal>check</goal>表示启用 JaCoCo的覆盖率检查功能 。
<configuration>标签下的<rules>用于定义覆盖率规则 。
<rule>标签中的<element>BUNDLE</element>表示规则应用于整个项目（BUNDLE代表项目的集合） 。
<limits>标签定义了具体的覆盖率限制 。
<limit>标签中的<counter>LINE</counter>表示针对行覆盖率进行限制；<value>COVEREDRATIO</value>表示使用覆盖率比率作为衡量标准；<minimum>0.80</minimum>则明确指定了行覆盖率的最小值为80%。

当执行mvn clean test命令时，如果行覆盖率未达到80%，构建将失败，并在控制台输出相关的错误信息，提示开发团队需要改进测试用例，以提高代码覆盖率。通过这种方式，可以确保项目在每次构建时都能满足一定的测试质量标准，避免低质量的代码进入生产环境。

集成到 CI/CD 流程

将JaCoCo集成到CI/CD工具中，能够实现每次代码提交时自动生成覆盖率报告，并进行覆盖率检查，从而及时发现代码质量问题，保障软件的持续集成和交付质量。下面以Jenkins为例进行介绍。
1.安装 JaCoCo 插件：在Jenkins插件管理中，找到并安装JaCoCo plugin 。
2.配置 Maven 项目：在Maven项目的pom.xml文件中添加JaCoCo插件配置（如前文所述）。
3.配置 Jenkins 任务：在Jenkins中创建一个新的自由风格项目，在项目配置页面的Build步骤中添加Execute shell或Execute Windows batch command步骤，输入命令mvn clean test，以执行测试并生成覆盖率报告。
4.配置 JaCoCo 报告路径：在项目配置页面的Post-build Actions中，选择Publish JaCoCo Coverage Report，在Exec File字段中填写覆盖率数据文件路径（通常为target/jacoco.exec），在Class Directories字段中填写类文件目录（通常为target/classes），在Source Directories字段中填写源代码目录。
5.设置覆盖率阈值：在Publish JaCoCo Coverage Report配置中，可以设置覆盖率阈值。例如，设置行覆盖率的最低阈值为80%，当实际覆盖率低于该阈值时，Jenkins构建将标记为失败。

注意事项与常见问题

插件兼容性

在使用JaCoCo时，需确保其插件版本与项目中使用的其他插件（如Maven插件、Gradle插件、测试框架插件等）兼容。不同插件之间可能会因为版本差异而产生冲突，影响JaCoCo的正常运行。例如，在Maven项目中，如果JaCoCo插件版本与maven-surefire-plugin版本不兼容，可能会导致测试执行失败或覆盖率报告生成异常。为避免此类问题，在引入新插件或升级插件版本时，应查阅相关插件的官方文档，了解版本兼容性信息，并在测试环境中进行充分的测试。

测试用例调整

为了获得更准确的覆盖率数据，可能需要对测试用例进行调整。有时候，已有的测试用例虽然能够覆盖大部分的代码路径，但可能会遗漏一些特殊情况或边界条件。以一个处理用户登录的方法为例，常规的测试用例可能只覆盖了用户名和密码正确的情况，而忽略了用户名或密码为空、用户名不存在、密码错误次数过多等异常情况。通过分析JaCoCo的覆盖率报告，我们可以发现这些未覆盖的代码区域，进而针对性地补充测试用例，确保它们能够覆盖更多的代码路径，提高代码覆盖率的准确性和可靠性。

解决常见问题

在使用JaCoCo过程中，可能会遇到一些常见问题，以下是针对这些问题的解决方案和排查思路：
1.覆盖率报告中显示的覆盖率不准确
可能是测试用例执行不完整，部分测试用例因为依赖问题、环境问题等未能正常执行；也可能是代码存在动态加载、反射等情况，导致JaCoCo无法准确插桩和收集覆盖率数据；另外，多个测试运行的覆盖率数据合并时出现错误，也会影响最终的覆盖率结果。

排查思路与解决方案：首先，检查测试用例的执行日志，确认是否有测试用例失败或跳过的情况。对于依赖问题，确保测试环境中所需的依赖项都已正确配置和安装。针对动态加载和反射的代码，需要特殊处理，可以通过在测试代码中显式地调用相关方法，使 JaCoCo能够插桩和收集数据。在合并覆盖率数据时，仔细检查合并的配置和命令，确保数据合并正确。

2.报告生成失败
可能是 JaCoCo插件配置错误，如报告生成路径设置不正确、数据文件路径错误等；也可能是测试执行过程中出现异常，导致覆盖率数据没有正确生成；还可能是项目构建过程中存在其他错误，影响了报告的生成。

排查思路与解决方案：检查pom.xml中JaCoCo插件的配置，确保报告生成路径和数据文件路径正确无误。查看测试执行的日志，找出测试过程中出现的异常并解决。如果是项目构建问题，先解决构建错误，再重新生成覆盖率报告。例如，在Maven项目中，如果报告生成路径设置为target/JaCoCo-report，但实际生成报告时发现该目录不存在，就需要检查配置并确保目录可写。

总结

JaCoCo作为一款强大的Java代码覆盖率工具，在保障软件质量和提升测试效率方面发挥着重要作用。它通过字节码插桩技术，精准地收集代码执行信息，为开发人员提供详细的代码覆盖率报告，帮助识别测试中的薄弱环节，从而有针对性地改进测试用例，提高代码的健壮性和可靠性。

在实际应用中，JaCoCo具有广泛的适用性，无论是小型项目还是大型企业级应用，都能借助其优势实现有效的代码覆盖率分析。从简单的单元测试覆盖率统计，到复杂的多模块项目的跨测试运行覆盖率聚合，JaCoCo都能提供全面而准确的支持。同时，它与常见的构建工具和测试框架的无缝集成，以及在CI/CD流程中的自动化应用，使得代码覆盖率的分析能够融入到日常的开发工作流中，成为保障软件持续集成和交付质量的关键环节。

对于广大测试人员来说，积极掌握和运用JaCoCo这样的代码覆盖率工具，不仅能够提升个人的测试技能，更能够为团队和项目的成功提供有力保障。在不断追求高质量软件的道路上，代码覆盖率工具将持续发挥重要作用，助力开发者打造更加可靠、稳定的软件产品。

最后： 下方这份完整的软件测试视频教程已经整理上传完成，需要的朋友们可以自行领取【保证100%免费】