测试覆盖率统计工具

最新推荐文章于 2025-10-16 15:36:01 发布

原创最新推荐文章于 2025-10-16 15:36:01 发布 · 3.1k 阅读

4 ·

CC 4.0 BY-SA版权

文章标签：

#单元测试 #code coverage

IDE 专栏收录该内容

2 篇文章

订阅专栏

本文详细介绍了JaCoCo，一个流行的Java代码覆盖率工具，其原理是通过动态修改字节码插入探针。配置方面，讲解了单模块和多模块Maven项目的设置，以及如何生成和查看覆盖率报告。在开发过程中，IDEA原生插件coverage提供了实时的代码覆盖率查看。文章还展示了覆盖率报告的视图，包括指令、分支、行和方法级别的覆盖率，并提供了查看未覆盖代码的方法。

一、工具选型

简介：jacoco（Java code coverage ）是目前主流的开源代码覆盖率统计工具（更新最热，github引用最多）。其实现原理（on-the-fly模式）为通过java.lang.instrument包提供的接口，编写jvm代理，在jvm加载字节码时动态修改内容，增加探针指令。

二、代码覆盖率统计原理

处理流程：

动态加入代码探针效果：

原代码：

经jacoco jvm代理处理后的代码：

（实际为字节码，为便于展示，替换为等效的源码）

三、配置

单模块应用maven配置

在项目pom增加maven插件

<plugin>
	<groupId>org.jacoco</groupId>
	<artifactId>jacoco-maven-plugin</artifactId>
	<executions>
		<execution>
			<id>prepare-unit-tests</id>
			<goals>
				<!--default bound to phase:initialize-->
				<goal>prepare-agent</goal>
			</goals>
		</execution>
		<execution>
			<id>report-when-test</id>
			<phase>test</phase>
			<goals>
				<goal>report</goal>
			</goals>
		</execution>
	</executions>
</plugin>

此配置的作用是在maven生命周期的initialize阶段执行prepare-agent，修改字节码加入探针；在生命周期的test阶段执行report，生成报告。

多模块应用maven配置

在父pom配置jacoco插件

<plugin>
	<groupId>org.jacoco</groupId>
	<artifactId>jacoco-maven-plugin</artifactId>
	<executions>
		<execution>
			<id>prepare-unit-tests</id>
			<!--default bound to phase:initialize-->
			<goals>
				<goal>prepare-agent</goal>
			</goals>
		</execution>
	</executions>
</plugin>

这一步的作用是在应用启动的时候附加上-javaagent参数，对字节码做修改，加入探针

新增test-reporting子模块

子模块只包含一个pom文件，包含两块配置：

依赖所有其他模块

    <dependencies>
        <dependency>
            <groupId>com.zhengwenbin</groupId>
            <artifactId>module1</artifactId>
            <version>${my.project.version}</version>
        </dependency>
        <dependency>
            <groupId>com.zhengwenbin</groupId>
            <artifactId>module2</artifactId>
            <version>${my.project.version}</version>
        </dependency>
    </dependencies>

此配置的作用是，将各个模块的测试报告汇总到一处。（jacoco官方提供汇总多模块应用测试报告的方法）

配置jacoco插件

    <build>
        <plugins>
            <plugin>
                <groupId>org.jacoco</groupId>
                <artifactId>jacoco-maven-plugin</artifactId>
                <executions>
                    <execution>
                        <id>report-aggregate</id>
                        <phase>test</phase>
                        <goals>
                            <goal>report-aggregate</goal>
                        </goals>
                    </execution>
                    <execution>
                        <id>merge-results</id>
                        <phase>test</phase>
                        <goals>
                            <goal>merge</goal>
                        </goals>
                        <configuration>
                            <fileSets>
                                <fileSet>
                                    <directory>${code.coverage.project.folder}</directory>
                                    <includes>
                                        <include>**/target/jacoco.exec</include>
                                    </includes>
                                </fileSet>
                            </fileSets>
                            <destFile>${code.coverage.overall.data.folder}/aggregate.exec</destFile>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

此配置的作用是，将各个模块的测试报告聚合，并将生成报告动作绑定到test阶段

多模块应用配置示例：

四、使用

在项目pom.xml目录下执行命令：

mvn clean test

五、结果查看

覆盖率报告html

查看覆盖率

jacoco插件report/report-aggregate命令会在各个模块的target目录生成site文件夹，进入site/jacoco文件夹，使用浏览器打开index.html。（对于多模块应用，site目录只会显示该模块依赖的模块代码覆盖率，因此需要进入test-reporting模块查看所有报告）