【软件工具-Jacoco】jacoco exclusionpattern是什么作用

在 JaCoCo（Java Code Coverage Library）中，exclusionPattern 是一个用于控制代码覆盖率报告的配置选项。它的主要作用是指定哪些类或包应被排除在代码覆盖率分析之外。这在一些特定情况下非常有用，例如：

1. 排除测试代码：当你不想将测试代码（通常在 src/test 目录下）包含在覆盖率报告中时，可以使用 exclusionPattern。

2. 排除第三方库：使用 exclusionPattern 可以排除某些不需要分析的第三方库或框架，以简化报告并关注自己的代码。

3. 排除生成代码：许多框架会生成一些代理或访问代码，这些代码通常会导致不必要的覆盖率噪声。因此，使用 exclusionPattern 来排除这些生成的代码会让报告更清晰。

配置示例

在 Maven 项目中，可以在 jacoco-maven-plugin 的配置中使用 exclusionPattern，例如：

<plugin>
    <groupId>org.jacoco</groupId>
    <artifactId>jacoco-maven-plugin</artifactId>
    <version>0.8.7</version> <!-- 请使用最新版本 -->
    <configuration>
        <excludes>
            <exclude>com/example/ignored/**</exclude> <!-- 排除某些包 -->
            <exclude>**/*Test*</exclude> <!-- 排除所有测试类 -->
            <exclude>**/generated/**</exclude> <!-- 排除生成的代码 -->
        </excludes>
    </configuration>
    <executions>
        <execution>
            <goals>
                <goal>prepare-agent</goal>
            </goals>
        </execution>
    </executions>
</plugin>

上述配置示例将会排除 com/example/ignored/ 包中的所有类，以及所有以 Test 结尾的类和任何在 generated 目录下的类。

使用的语法

在 exclusionPattern 中，你可以使用以下语法：

• com/example/**: 匹配 com/example 包及其所有子包中的所有类。
• **/SomeClass: 匹配任何路径下的 SomeClass 类。
• **/*Test*: 匹配任何路径下的类名中包含 Test 的类。

总结

exclusionPattern 使得用户能够精确控制代码覆盖率分析的范围，从而忽略那些无关的代码部分，帮助开发者更好地关注于有意义的代码覆盖率数据。通过合理使用这个选项，开发者可以生成更具洞察力和实用性的覆盖率报告。