在 java 单元测试中配置 jacoco，核心做法是在构建工具（如 maven 或 gradle）中添加 jacoco 插件依赖并设置执行策略。以 maven 为例，需在 pom.xml 的 <build></build> 部分引入 maven-surefire-plugin 来激活 jacoco 代理，并在 plugins 中配置 jacoco-maven-plugin 以生成覆盖率报告。这样可以在运行测试时自动收集代码覆盖数据，并在构建完成后输出详细的 html 或 xml 报告。
Maven 项目中如何集成 JaCoCo 插件
在 Maven 项目中集成 JaCoCo，主要通过在 pom.xml 中配置 jacoco-maven-plugin 和 maven-surefire-plugin 来实现。JaCoCo 插件负责生成报告，而 Surefire 插件负责在运行测试时注入 JaCoCo 代理以捕获覆盖率数据。通常需要将 JaCoCo 版本属性定义在 <properties></properties> 中，以便统一管理。
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.example</groupId>
<artifactId>jacoco-demo</artifactId>
<version>1.0-SNAPSHOT</version>
<properties>
<maven.compiler.source>17</maven.compiler.source>
<maven.compiler.target>17</maven.compiler.target>
<jacoco.version>0.8.11</jacoco.version>
</properties>
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.13.2</version>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<version>3.2.2</version>
<configuration>
<argLine>-javaagent:${settings.localRepository}/org/jacoco/org.jacoco.agent/${jacoco.version}/org.jacoco.agent-${jacoco.version}-runtime.jar=destfile=${project.build.directory}/jacoco.exec</argLine>
</configuration>
</plugin>
<plugin>
<groupId>org.jacoco</groupId>
<artifactId>jacoco-maven-plugin</artifactId>
<version>${jacoco.version}</version>
<executions>
<execution>
<goals>
<goal>prepare-agent</goal>
</goals>
</execution>
<execution>
<id>report</id>
<phase>prepare-package</phase>
<goals>
<goal>report</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>上述配置中，maven-surefire-plugin 的 <argline></argline> 参数指定了 JaCoCo 代理的路径和输出文件位置。JaCoCo 插件的 prepare-agent 目标会在测试前自动设置 JVM 参数，而 report 目标则读取 .exec 文件生成报告。运行 mvn test 后，可在 target/site/jacoco/index.html 查看覆盖率详情。
立即学习“Java免费学习笔记（深入）”；
Gradle 项目中如何配置 JaCoCo
在 Gradle 项目中配置 JaCoCo 更加简洁，因为 JaCoCo 插件是 Gradle 的核心插件之一，无需额外添加复杂的代理配置。只需在 build.gradle 中应用 jacoco 插件，并可选地配置覆盖率阈值。Gradle 会自动在运行测试任务时注入 JaCoCo 代理，并在测试结束后生成报告。
plugins {
id 'java'
id 'jacoco'
}
group = 'com.example'
version = '1.0-SNAPSHOT'
repositories {
mavenCentral()
}
dependencies {
testImplementation 'junit:junit:4.13.2'
}
test {
finalizedBy 'jacocoTestReport'
}
jacocoTestReport {
dependsOn test
reports {
xml.required = true
html.required = true
}
}
// 可选：设置覆盖率阈值
jacocoTestCoverageVerification {
violationRules {
rule {
limit {
minimum = 0.8 // 80% 覆盖率要求
}
}
}
}在 Gradle 中，jacocoTestReport 任务依赖于 test 任务，确保测试完成后立即生成报告。报告默认生成在 build/reports/jacoco/test/html/index.html。通过 jacocoTestCoverageVerification 任务可以验证覆盖率是否达到预期阈值，若未达标则构建失败。这种方式比 Maven 更直观，减少了手动配置 JVM 参数的步骤。
JaCoCo 报告中如何排除特定类或方法
在实际项目中，某些类或方法可能不需要覆盖率统计，例如 DTO、配置类或测试辅助类。JaCoCo 提供了 <excludes></excludes> 配置项，允许用户指定需要排除的模式。在 Maven 中，可以通过 classExecutionData 或 rules 中的 excludes 来过滤；在 Gradle 中，则通过 sourceSets 或 excludes 配置实现。排除规则支持通配符，便于批量管理。
// Maven 示例：在 jacoco-maven-plugin 中排除特定包
<plugin>
<groupId>org.jacoco</groupId>
<artifactId>jacoco-maven-plugin</artifactId>
<version>${jacoco.version}</version>
<configuration>
<excludes>
<exclude>**/dto/*</exclude>
<exclude>**/config/*</exclude>
</excludes>
</configuration>
<!-- 其他配置 -->
</plugin>// Gradle 示例：在 jacocoTestReport 中排除特定包
jacocoTestReport {
afterEvaluate {
classDirectories.setFrom(
files(classDirectories.files.collect {
fileTree(dir: it, exclude: [
'**/dto/**',
'**/config/**'
])
})
)
}
}通过排除不重要的类，可以提高覆盖率报告的准确性，避免无关代码拉低整体覆盖率指标。排除规则应基于项目实际需求制定，通常用于排除自动生成代码、第三方库包装类或纯数据载体类。配置后，重新运行测试，这些类将不会出现在覆盖率统计中。
