构建与依赖 / 系统课时

生成测试覆盖率报告

生成测试覆盖率报告

覆盖率报告要同时解决两件事:测试运行时采集哪些代码被执行,以及构建结束后怎样把执行数据转成可读报告。本课使用 JaCoCo Maven Plugin 0.8.15 配置 Agent 与 report,再用具体数字判断 LINE 与 BRANCH 指标是否真的反映测试质量。

学习目标

  • 配置 prepare-agent 在测试 JVM 中采集覆盖率,并生成 target/jacoco.exec。
  • 在 verify 阶段生成 HTML、XML、CSV 覆盖率报告并定位输出目录。
  • 用 LINE、BRANCH 等指标和 80% 阈值做可执行的质量检查,而不是只追求一个总百分比。

让 Agent 收集执行数据

prepare-agent 默认绑定到 initialize,会为测试 JVM 准备 JaCoCo Java Agent;测试结束后执行数据默认写入 target/jacoco.exec。本例固定使用正式版 0.8.15,避免在课程配置中引用 0.8.16-SNAPSHOT 这类快照版本。

JaCoCo 覆盖率数据流

如果项目在 Surefire 中自定义了 JVM 参数,不要直接用新的 <argLine> 覆盖 JaCoCo 注入值。Surefire 3.x 中可写成 @{argLine} -Xmx512m,保留 Agent 参数后再追加自己的 JVM 选项。

配置 Agent 与报告目标

下面是 pom.xml 中 build/plugins 下的片段示例。report 本身默认绑定 verify,这里显式写出阶段,方便阅读生命周期。0.8.15 默认可以生成 HTML、XML 和 CSV 三种格式。

xml
<plugin>
  <groupId>org.jacoco</groupId>
  <artifactId>jacoco-maven-plugin</artifactId>
  <version>0.8.15</version>
  <executions>
    <execution>
      <id>prepare-agent</id>
      <goals>
        <goal>prepare-agent</goal>
      </goals>
    </execution>
    <execution>
      <id>coverage-report</id>
      <phase>verify</phase>
      <goals>
        <goal>report</goal>
      </goals>
    </execution>
  </executions>
</plugin>

这段配置不需要手工指定输出路径:执行数据默认是 target/jacoco.exec,报告默认进入 target/site/jacoco。如果项目只运行集成测试并希望单独统计,可改用 prepare-agent-integration 与 report-integration,其默认执行数据文件为 target/jacoco-it.exec。

执行测试并检查生成物

在包含可运行单元测试的 Maven 项目根目录执行:

bash
mvn clean verify

预期结果:

text
[INFO] BUILD SUCCESS
target/jacoco.exec
target/site/jacoco/index.html
target/site/jacoco/jacoco.xml
target/site/jacoco/jacoco.csv

实际控制台还会包含项目名、类数量和本机路径等动态值。验收时最直接的是打开 target/site/jacoco/index.html:包、类和方法应能逐层展开,源码行会按覆盖状态着色;如果 jacoco.exec 不存在,先检查测试是否真的启动了独立 JVM,以及 Surefire/Failsafe 的 argLine 是否覆盖了 JaCoCo Agent 参数。

用多个指标判断覆盖缺口

LINE 适合快速看“哪些可执行行完全没跑到”,但单独使用容易产生误判。假设一个类有 100 条可执行行,测试覆盖 82 条,LINE 是 82%;同一类有 20 个分支结果,只覆盖 12 个,BRANCH 只有 60%,说明条件分支仍有明显空洞。

指标 直接含义 适合检查什么
LINE 至少有指令映射到该源码行并被执行 未执行的大块业务路径
BRANCH if、switch 等分支结果的覆盖情况 条件组合和边界分支
METHOD 方法是否至少被执行过 大量未触达的方法
CLASS 类是否至少被执行过 模块或包级漏测

例如服务层 LINE 82% 但 BRANCH 60% 时,不应因为“超过 80%”就停止补测;应先查看未覆盖的异常分支、空值分支和权限判断,再决定是否补用例。

设置 80% 门槛并验证失败路径

需要让 CI 自动阻止覆盖率回退时,可以增加 check 执行。下面的片段把整个模块的 LINE 覆盖率下限设为 0.80;这是构建规则,不等于“80% 就代表测试充分”。

xml
<execution>
  <id>coverage-check</id>
  <phase>verify</phase>
  <goals>
    <goal>check</goal>
  </goals>
  <configuration>
    <rules>
      <rule>
        <element>BUNDLE</element>
        <limits>
          <limit>
            <counter>LINE</counter>
            <value>COVEREDRATIO</value>
            <minimum>0.80</minimum>
          </limit>
        </limits>
      </rule>
    </rules>
  </configuration>
</execution>

验证时先记录一次通过的 mvn verify,再临时删除一个覆盖关键分支的测试并重跑。若模块 LINE 低于 80%,预期最终结果为:

text
[INFO] BUILD FAILURE

覆盖率规则适合防止明显回退,不适合替代断言质量、变异测试或业务场景评审。对自动生成代码、DTO 或框架代理做排除时,应只排除确实不承载业务逻辑的类,并在项目配置中保留可审查的排除原因。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

生成测试覆盖率报告

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通