如何在不影响JaCoCo覆盖率的情况下测试含私有方法与对象创建的类

这个问题我之前也碰到过——PowerMock的@PrepareForTest注解会修改目标类的字节码，而JaCoCo默认无法正确识别这种修改后的类，导致覆盖率统计丢失。这里有两个可行的解决思路，优先推荐重构代码的方案，从根源上提升代码的可测试性：

方案一：重构代码，抽象文件读取依赖（最优解） #

PowerMock通常是代码耦合度高、可测试性差的妥协方案。我们可以把文件读取的逻辑抽象成独立接口，通过依赖注入来解耦，这样测试时直接mock接口即可，完全不需要PowerMock。

步骤1：定义文件读取接口 #

public interface FileReader {
    String readFile(String filePath) throws IOException;
}

步骤2：实现生产环境的类路径文件读取器 #

public class ClassPathFileReader implements FileReader {
    @Override
    public String readFile(String filePath) throws IOException {
        ClassPathResource resource = new ClassPathResource(filePath);
        return IOUtils.toString(resource.getFile());
    }
}

步骤3：修改原类，依赖接口而非具体实现 #

给ClassToTest添加构造注入，同时保留无参构造兼容现有代码：

class ClassToTest {
    private final FileReader fileReader;

    // 用于测试的构造方法，注入mock的FileReader
    public ClassToTest(FileReader fileReader) {
        this.fileReader = fileReader;
    }

    // 兼容现有业务代码的无参构造
    public ClassToTest() {
        this(new ClassPathFileReader());
    }

    public String methodToTest(String input) throws IOException {
        return fileReader.readFile(input);
    }
}

步骤4：编写简洁的测试用例 #

用Mockito直接mockFileReader接口，完全不需要PowerMock：

import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.mockito.junit.MockitoJUnitRunner;
import static org.junit.Assert.assertEquals;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

@RunWith(MockitoJUnitRunner.class)
public class ClassToTestTest {
    @Mock
    private FileReader mockFileReader;

    @Test
    public void test_methodToTest() throws IOException {
        // 初始化测试对象，注入mock依赖
        ClassToTest classToTest = new ClassToTest(mockFileReader);
        
        // 定义mock行为
        when(mockFileReader.readFile("file1.txt")).thenReturn("DUMMY_STRING");
        
        // 执行测试方法
        String result = classToTest.methodToTest("file1.txt");
        
        // 验证结果和调用行为
        assertEquals("DUMMY_STRING", result);
        verify(mockFileReader).readFile("file1.txt");
    }
}

这种方案不仅解决了JaCoCo覆盖率的问题，还让代码更符合依赖倒置原则，后续扩展其他读取方式（比如读取远程文件）也更方便。

方案二：调整JaCoCo与PowerMock的配置（兼容现有代码） #

如果因为业务限制无法重构代码，可以通过调整配置让JaCoCo兼容PowerMock的字节码修改。注意：不同版本的PowerMock和JaCoCo可能存在兼容性问题，推荐使用PowerMock 2.x+和JaCoCo 0.8.6+版本。

1. Maven配置示例（适用于Maven项目） #

在pom.xml中配置JaCoCo和Surefire插件，确保JaCoCo agent正确加载，同时排除PowerMock对JaCoCo代理类的干扰：

<build>
    <plugins>
        <!-- JaCoCo 插件配置 -->
        <plugin>
            <groupId>org.jacoco</groupId>
            <artifactId>jacoco-maven-plugin</artifactId>
            <version>0.8.10</version>
            <executions>
                <execution>
                    <goals>
                        <goal>prepare-agent</goal>
                    </goals>
                    <configuration>
                        <destFile>${project.build.directory}/jacoco.exec</destFile>
                    </configuration>
                </execution>
                <execution>
                    <id>report</id>
                    <phase>test</phase>
                    <goals>
                        <goal>report</goal>
                    </goals>
                    <configuration>
                        <dataFile>${project.build.directory}/jacoco.exec</dataFile>
                        <outputDirectory>${project.reporting.outputDirectory}/jacoco</outputDirectory>
                    </configuration>
                </execution>
            </executions>
        </plugin>
        <!-- Surefire 插件配置，集成PowerMock和JaCoCo -->
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-surefire-plugin</artifactId>
            <version>3.2.5</version>
            <configuration>
                <argLine>
                    -javaagent:"${settings.localRepository}/org/jacoco/jacoco/${jacoco.version}/jacoco-${jacoco.version}.jar"=destfile=${project.build.directory}/jacoco.exec
                    ${argLine}
                </argLine>
                <properties>
                    <property>
                        <name>listener</name>
                        <value>org.powermock.modules.junit4.PowerMockJUnitTestListener</value>
                    </property>
                </properties>
            </configuration>
        </plugin>
    </plugins>
</build>

2. 调整测试类注解 #

在测试类上添加@PowerMockIgnore排除JaCoCo的代理类，避免冲突：

import org.junit.Test;
import org.junit.runner.RunWith;
import org.powermock.api.mockito.PowerMockito;
import org.powermock.core.classloader.annotations.PrepareForTest;
import org.powermock.core.classloader.annotations.PowerMockIgnore;
import org.powermock.modules.junit4.PowerMockRunner;
import org.springframework.core.io.ClassPathResource;
import static org.junit.Assert.assertEquals;
import static org.mockito.Mockito.any;
import static org.powermock.api.mockito.PowerMockito.mockStatic;
import static org.powermock.api.mockito.PowerMockito.whenNew;

@RunWith(PowerMockRunner.class)
@PrepareForTest(ClassToTest.class)
@PowerMockIgnore("org.jacoco.agent.rt.*") // 排除JaCoCo代理类
public class ClassToTestTest {

    @Test
    public void test_methodToTest() throws Exception {
        // Mock ClassPathResource实例
        ClassPathResource mockedResource = PowerMockito.mock(ClassPathResource.class);
        whenNew(ClassPathResource.class).withArguments("file1.txt").thenReturn(mockedResource);
        
        // Mock getFile()方法，避免实际磁盘访问
        PowerMockito.when(mockedResource.getFile()).thenReturn(PowerMockito.mock(java.io.File.class));
        
        // Mock IOUtils.toString静态方法
        mockStatic(org.apache.commons.io.IOUtils.class);
        PowerMockito.when(org.apache.commons.io.IOUtils.toString(any(java.io.File.class))).thenReturn("DUMMY_STRING");
        
        // 执行测试
        ClassToTest classToTest = new ClassToTest();
        String result = classToTest.methodToTest("file1.txt");
        
        assertEquals("DUMMY_STRING", result);
    }
}

这种方案可以在不修改业务代码的前提下解决问题，但配置繁琐，且后续版本升级可能需要调整配置，所以还是优先推荐方案一。

内容的提问来源于stack exchange，提问作者Ganesh Satpute