Jacoco 单元测试配置

news2024/11/18 8:23:09

前言

编写单元测试是开发健壮程序的有效途径，单元测试写的好不好可以从多个指标考量，其中一个就是单元测试的覆盖率。单元测试覆盖率可以看到我们的单元测试覆盖了多少代码行、类、分支等。查看单元测试覆盖率可以使用一些工具帮助我们计算，如 Idea 自带的单元测试工具、Jacoco 等。Jacoco 是一款开源的单元测试工具，可以方便地整合到 Maven 中，提供了更丰富的配置及通过规则，可以生成单元测试报告，也可以方便地和自动化流水线整合。所以更推荐使用 Jacoco 作为单元测试工具。
在这里插入图片描述

配置

Maven 配置

可以通过 Maven 插件的方式整合 Jacoco，这样使用 mvn test 命令就可以生成 Jacoco 的测试报告了。

要配置 Jacoco，在 build 中添加 Jacoco 插件即可。

<build>
    <plugins>
        <!-- Jacoco -->
        <plugin>
            <groupId>org.jacoco</groupId>
            <artifactId>jacoco-maven-plugin</artifactId>
            <configuration>
                <!-- 排除文件 -->
                <excludes>
                    <exclude>**/*Test.class</exclude>
                    <exclude>**/*Configuration.class</exclude>
                    <exclude>**/*Properties.class</exclude>
                </excludes>
            </configuration>
            <executions>
                <execution>
                    <id>jacoco-prepare-agent</id>
                    <goals>
                        <goal>prepare-agent</goal>
                    </goals>
                </execution>
                <execution>
                    <id>jacoco-report</id>
                    <phase>test</phase>
                    <goals>
                        <goal>report</goal>
                    </goals>
                    <configuration>
                        <!--定义输出的文件夹-->
                        <outputDirectory>target/test-report</outputDirectory>
                        <footer>火眼9988</footer>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

上面定义了两个执行，prepare-prepare-agent 是准备 Jacoco 的运行时代理，而 jacoco-report 则是生成报告。

然后执行 mvn test 或通过 IDE 的 Maven 面板执行测试，完成后就会在指定目录下生成 jacoco 的报告。默认会生成 csv 和 html 格式的，csv 可以用于自动化流水线整合，而 html 的可以用浏览器打开查看。

定义通过规则

我们可以使用 Jacoco 方便地配置通过规则，只有满足特定规则才能通过测试，否则 test 执行会失败。

添加一个 execution 即可，在 rule 中定义我们的通过规则。

<execution>
  <id>jacoco-check</id>
  <goals>
      <goal>check</goal>
  </goals>
  <configuration>
      <rules>
          <rule>
              <element>BUNDLE</element>
              <excludes>
                  <exclude>**/*Test.class</exclude>
                  <exclude>**/*Configuration.class</exclude>
                  <exclude>**/*Properties.class</exclude>
              </excludes>
              <limits>
                  <limit>
                      <counter>LINE</counter>
                      <value>COVEREDRATIO</value>
                      <minimum>0.8</minimum>
                  </limit>
              </limits>
          </rule>
      </rules>
  </configuration>
</execution>

上面定义了一条规则，包含一个限制：行覆盖率最低为 80%，这里可查看完整案例。

其中 rule 标签定义了一条规则，element 定义了规则对应的范围，可选值有：

BUNDLE：表示整个模块，是默认值
PACKAGE：表示代码包
CLASS：表示类
SOURCEFILE：源文件
METHOD：表示方法

每个规则可以定义多条限制（limit），每个限制有一个特定的指标：

INSTRUCTION：字节码指令，是最细粒度的指标，默认值
LINE：代码行，一行代码可能有多个字节码指令
BRANCH：分支，if 或 switch 包含了多个分支
COMPLEXITY：圈复杂度，是代码复杂度的衡量标准，简单来说越大越复杂，需要的测试用例越多，详细算法可参考百科
METHOD：方法
CLASS：类

为每个指标的值定义一个最大值或最小值。

TOTALCOUNT：总数
COVEREDCOUNT：覆盖的数量
MISSEDCOUNT：未覆盖的数量
COVEREDRATIO：覆盖率，范围从 0.0 到 1.0，默认值
MISSEDRATIO：未覆盖率，范围从 0.0 到 1.0

excludes 标签定义要排除的文件。

例如，下面的规则定义了 INSTRUCTION 的覆盖率至少 80%，且没有类未被覆盖。

<rules>
  <rule>
    <element>BUNDLE</element>
    <limits>
      <limit>
        <counter>INSTRUCTION</counter>
        <value>COVEREDRATIO</value>
        <minimum>0.80</minimum>
      </limit>
      <limit>
        <counter>CLASS</counter>
        <value>MISSEDCOUNT</value>
        <maximum>0</maximum>
      </limit>
    </limits>
  </rule>
</rules>

规则的详细配置可参考官方文档。

Idea IDE 配置

Idea IDE 除了支持自带的单元测试工具外，也支持使用 Jacoco。在配置中搜索 jacoco，Java 覆盖率中选择运行程序为 Jacoco 即可（不同的版本可能略有差别）。

在这里插入图片描述
配置后在 IDE 中执行单元测试时，选择第三项“使用覆盖率运行…”，运行完成后即可打开覆盖率面板，可查看当前单元测试的覆盖率，代码编辑器中也会以颜色标记。

排除测试

如果在代码中使用 Lombok，会有很多生成的代码，这些往往不需要测试覆盖，但如果不覆盖的话会影响测试覆盖率。Jacoco 可以自动排除 Lombok 的 @Generated 注解标记的类或方法。要让 Lombok 为生成的代码添加注解，可在项目的根目录中添加配置文件 lombok.config。

然后添加一行配置。

lombok.addLombokGeneratedAnnotation = true

这样生成的代码就会带上 @Generated 注解，被 Jacoco 排除计算了。当然，如果自己的代码不用测试，又不想影响覆盖率，也可以添加这个注解。这里可以查看实际案例。

多模块聚合报告

如果我们的项目有多个模块，Jacoco 会在每个模块下生成一个单独的报告，能不能生成一个聚合的报告呢？Jacoco 也贴心地为我们提供了生成聚合报告的方法。

首先添加一个模块，专门用于生成聚合报告，可以只有一个 pom.xml 文件。

在该模块的 pom 中添加如下配置，report-aggregate 用于生成聚合的报告。

<build>
    <plugins>
        <plugin>
            <groupId>org.jacoco</groupId>
            <artifactId>jacoco-maven-plugin</artifactId>
            <executions>
                <execution>
                    <id>jacoco-report-aggregate</id>
                    <phase>test</phase>
                    <goals>
                        <goal>report-aggregate</goal>
                    </goals>
                    <configuration>
                        <outputDirectory>target/test-report</outputDirectory>
                        <footer>火眼9988</footer>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>