JaCoCo 是什么

JaCoCo（Java Code Coverage）是一款广泛使用的 Java 代码覆盖率工具，用于分析测试用例对项目代码的覆盖程度，帮助开发者识别未被测试的代码区域，从而提升软件质量。它通常与 JUnit、TestNG 等测试框架及 Maven、Gradle 等构建工具集成，是 DevOps 流程中的重要组成部分。

JaCoCo 的核心功能

覆盖率统计
- 行覆盖率：测试是否覆盖了代码的每一行。
- 分支覆盖率：是否覆盖了所有条件分支（如 if-else）。
- 方法覆盖率：是否调用了每个方法。
- 类覆盖率：是否测试了所有类。
多种输出报告
- HTML：可视化展示覆盖率详情（按包、类、方法逐级下钻）。
- XML/CSV：便于集成到 CI/CD 工具（如 Jenkins、SonarQube）。
实时监控
- 在单元测试或集成测试运行时动态收集覆盖率数据。
与构建工具无缝集成
- 支持 Maven、Gradle、Ant，通过简单配置即可启用。

JaCoCo 的工作原理

字节码插桩
- JaCoCo 在编译时或运行时向 Java 字节码插入探针（Probes），记录代码执行情况。
数据收集
- 测试运行时，探针记录哪些代码被执行。
报告生成
- 测试完成后，生成覆盖率报告（如 index.html）。

快速开始（Maven 项目示例）

1. 配置 Maven 插件

在 pom.xml 中添加 JaCoCo 插件：

<plugin><groupId>org.jacoco</groupId><artifactId>jacoco-maven-plugin</artifactId><version>0.8.8</version><executions><execution><goals><goal>prepare-agent</goal> <!-- 在测试阶段插入探针 --></goals></execution><execution><id>generate-report</id><phase>test</phase> <!-- 测试完成后生成报告 --><goals><goal>report</goal></goals></execution></executions>
</plugin>

2. 运行测试并生成报告

mvn clean test  # 运行测试后，报告会生成在 target/site/jacoco/index.html

3. 查看报告

打开 target/site/jacoco/index.html，可以看到如下内容：

摘要页：总覆盖率（如 85% 行覆盖）。
详情页：点击具体类，查看未覆盖的代码行（红色标记）。

JaCoCo 与 CI/CD 集成

Jenkins 集成

安装 JaCoCo Plugin，在 Pipeline 中配置覆盖率阈值：

pipeline {stages {stage('Test') {steps {sh 'mvn test'}}}post {always {jacoco(execPattern: 'target/jacoco.exec',classPattern: 'target/classes',sourcePattern: 'src/main/java')}}
}

SonarQube 集成

在 sonar-project.properties 中指定 JaCoCo 报告路径：

sonar.java.coveragePlugin=jacoco
sonar.jacoco.reportPaths=target/jacoco.exec

JaCoCo 的常见配置选项

配置项	作用
`<includes>`	只统计指定包/类的覆盖率（如 `com.example.*`）。
`<excludes>`	排除特定类（如生成的代码、测试类）。
`<rules>`	设置覆盖率阈值，失败时终止构建（如行覆盖率必须 ≥80%）。
`<outputDirectory>`	自定义报告输出目录。

JaCoCo vs. 其他覆盖率工具

工具	语言	特点
JaCoCo	Java	零配置、轻量级、支持字节码插桩和离线模式。
Cobertura	Java	较老旧，需显式插桩，报告格式较简单。
Emma	Java	已停止维护，仅支持离线插桩。
Istanbul	JavaScript	用于 Node.js/前端项目（如 Jest 覆盖率）。

最佳实践

设定合理的覆盖率目标
- 关键模块（如支付逻辑）要求 90%+，非核心代码可放宽。

排除无需测试的代码

如自动生成的类、DTO、Main 方法：

<configuration><excludes><exclude>**/dto/*</exclude><exclude>**/Application.java</exclude></excludes>
</configuration>

结合单元测试和集成测试
- JaCoCo 可合并多份报告，全面反映测试覆盖情况。

常见问题

Q：JaCoCo 能测多模块项目吗？
A：可以！在父 POM 中配置插件，子模块会继承设置，最终合并覆盖率数据。

Q：如何检查测试覆盖率是否达标？
A：通过 Maven 的 check 目标，配置规则：

<execution><id>check-coverage</id><goals><goal>check</goal></goals><configuration><rules><rule><element>CLASS</element><limits><limit><counter>LINE</counter><value>COVEREDRATIO</value><minimum>0.8</minimum></limit></limits></rule></rules></configuration>
</execution>