java 检查代码覆盖率

原创

mob64ca12f062df 2024-09-01 04:25:20 ©著作权

文章标签 代码覆盖率 Java Test 文章分类 Java 后端开发

©著作权归作者所有：来自51CTO博客作者mob64ca12f062df的原创作品，请联系作者获取转载授权，否则将追究法律责任

Java 检查代码覆盖率

在软件开发中，代码覆盖率是一个重要的质量指标，它能够帮助开发者评估测试用例的有效性。本文将介绍如何在 Java 项目中检查代码覆盖率，并给出一些代码示例。

1. 什么是代码覆盖率？

代码覆盖率测量的是测试用例执行时，代码中被执行的部分所占的比例。覆盖率越高，说明代码的测试越充分。通常，代码覆盖率包括语句覆盖率、分支覆盖率和方法覆盖率等。

2. Java 中的代码覆盖率工具

在 Java 生态中，有多种工具可以用来检查代码覆盖率，其中 JaCoCo（Java Code Coverage）是一个流行的选择。它通过生成 HTML 报告让你直观地查看代码的覆盖情况。

示例代码

下面是一个简单的 Java 类以及对应的测试类，我们将使用 JaCoCo 来检查其覆盖率。

// Calculator.java
public class Calculator {
    public int add(int a, int b) {
        return a + b;
    }

    public int subtract(int a, int b) {
        return a - b;
    }
}

// CalculatorTest.java
import static org.junit.jupiter.api.Assertions.assertEquals;
import org.junit.jupiter.api.Test;

public class CalculatorTest {
    private Calculator calculator = new Calculator();

    @Test
    public void testAdd() {
        assertEquals(5, calculator.add(2, 3));
    }

    // 遗漏了.subtract方法的测试
}

生成代码覆盖率报告

要生成代码覆盖率报告，你需要在 Maven 项目中加入 JaCoCo 插件。以下是 Maven 的配置示例：

<build>
    <plugins>
        <plugin>
            <groupId>org.jacoco</groupId>
            <artifactId>jacoco-maven-plugin</artifactId>
            <version>0.8.7</version>
            <executions>
                <execution>
                    <id>default-report</id>
                    <goals>
                        <goal>report</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

执行 mvn test 后，JaCoCo 将生成覆盖率报告，你可以在 target/site/jacoco 目录中找到生成的 HTML 文件。

3. 代码覆盖率的可视化

为了更直观地展示代码覆盖率，我们可以通过图形化的方式来表示。以下是一个代表代码覆盖率的饼状图，我们使用 Mermaid 语法来表示。

pie
    title Code Coverage Distribution
    "Covered": 70
    "Not Covered": 30

如上所示，在这个示例中，代码覆盖率达到了 70%，尚有 30% 的代码未被测试覆盖。

4. 旅行图

在软件开发的生命周期中，代码测试、重构和维护可以视为一段旅行。以下是用 Mermaid 描述的旅行图：

journey
    title Software Development Journey
    section Development
      Write Code: 5: Developer
      Write Tests: 4: Developer
    section Testing
      Execute Tests: 3: QA
      Review Code Coverage: 4: QA
    section Maintenance
      Refactor Code: 5: Developer 
      Update Tests: 4: Developer

在这个旅行图中，我们可以看到代码的开发、测试和维护的各个步骤，以及在每个步骤中涉及的角色。