本文介绍了如何在 junit 参数化测试中,利用 Mockito 框架模拟对象的返回值,特别是当返回值依赖于参数化测试的输入参数时。通过正确的 Mockito 配置和参数传递,可以实现灵活且可控的单元测试。本文将通过一个具体的示例,展示如何使用 @MethodSource 注解提供测试数据,并配置 Mockito 以根据不同的输入参数返回不同的模拟值。
问题分析
在进行单元测试时,我们经常需要模拟外部依赖的行为,以便专注于测试目标代码的逻辑。Mockito 是一个流行的 Java 模拟框架,可以方便地创建和配置 mock 对象。JUnit 参数化测试允许我们使用不同的输入数据运行同一个测试方法,从而提高测试覆盖率。当两者结合使用时,我们需要确保 mock 对象的返回值能够根据参数化测试的输入参数进行动态调整。
解决方案
关键在于正确配置 JUnit 的测试运行器和 Mockito 的注解。最初的代码使用了 @RunWith(MockitoJUnitRunner.class),这在某些情况下可能导致 Mockito 无法正确初始化。推荐使用 @ExtendWith(MockitoExtension.class) 来替代,它可以更好地与 JUnit 集成。
下面是一个完整的示例,展示了如何使用 @MethodSource 注解提供测试数据,并配置 Mockito 以根据不同的输入参数返回不同的模拟值。
import org.junit.jupiter.api.extension.ExtendWith; import org.junit.jupiter.params.ParameterizedTest; import org.junit.jupiter.params.provider.Arguments; import org.junit.jupiter.params.provider.MethodSource; import org.mockito.InjectMocks; import org.mockito.Mock; import org.mockito.junit.jupiter.MockitoExtension; import java.util.stream.Stream; import static org.junit.jupiter.api.Assertions.assertEquals; import static org.mockito.Mockito.when; @ExtendWith(MockitoExtension.class) public class FooTest { @Mock MockedObject mockedObject; @InjectMocks Foo underTest; @ParameterizedTest @MethodSource("dataProvider") public void test_ParametrizedTest(MockedInput mockedInput, Output expectedReturn) { // Given when(mockedObject.method(mockedInput)) .thenReturn(expectedReturn); // when Output result = underTest.method(); // then assertEquals(expectedReturn.getCode(), result.getCode()); } private static Stream<Arguments> dataProvider() { return Stream.of( Arguments.of(new MockedInput("S1"), new Output("S1")), Arguments.of(new MockedInput("S2"), new Output("S2")) ); } // 辅助类,用于模拟输入和输出 static class MockedInput { private String code; public MockedInput(String code) { this.code = code; } public String getCode() { return code; } } static class Output { private String code; public Output(String code) { this.code = code; } public String getCode() { return code; } } // 被测试类 static class Foo { private MockedObject mockedObject; public Foo(MockedObject mockedObject) { this.mockedObject = mockedObject; } public Output method() { MockedInput input = new MockedInput("S1"); // 假设这里创建了input return mockedObject.method(input); } } // 被模拟的类 static class MockedObject { public Output method(MockedInput input) { return new Output(input.getCode()); // 实际实现会被mock掉 } } }
代码解释:
- @ExtendWith(MockitoExtension.class): 使用 JUnit Jupiter 的扩展机制,启用 Mockito 扩展,负责初始化 Mockito 注解。
- @Mock: 用于创建 MockedObject 的 mock 对象。
- @InjectMocks: 用于创建 Foo 实例,并将 mock 对象 mockedObject 注入到 Foo 中。
- @ParameterizedTest 和 @MethodSource(“dataProvider”): 使用参数化测试,数据来源于 dataProvider 方法。
- dataProvider 方法: 提供测试数据,返回一个 Stream
,每个 Arguments 包含 MockedInput 和 Output,分别作为 mockedObject.method() 的输入和期望的返回值。 - when(mockedObject.method(mockedInput)).thenReturn(expectedReturn): 配置 mock 对象,当 mockedObject.method() 接收到 mockedInput 时,返回 expectedReturn。
注意事项:
- 确保 JUnit 和 Mockito 的版本兼容。
- dataProvider 方法必须是静态的。
- MockedInput 和 Output 类是为了示例的完整性而创建的,实际项目中应该替换成你自己的类。
- 如果 MockedInput 类没有正确实现 equals() 和 hashCode() 方法,Mockito 可能无法正确匹配输入参数,导致 mock 对象返回错误的值。 在复杂场景下,可以考虑使用 ArgumentMatchers 来更灵活地匹配参数。
总结
通过使用 @ExtendWith(MockitoExtension.class) 和 @MethodSource 注解,我们可以轻松地在 JUnit 参数化测试中模拟对象的返回值,并根据不同的输入参数进行动态调整。这使得我们可以编写更灵活、更可控的单元测试,提高代码质量。