本教程探讨了在mockito中如何对方法参数进行集合内值匹配。由于mockito没有直接的`in()`匹配器，我们介绍了如何利用`argumentmatchers.intthat()`结合lambda表达式或自定义辅助方法来灵活地实现这一需求，从而提升测试代码的精确性和可维护性。
在单元测试中使用Mockito进行方法桩（stubbing）或验证（verification）时，我们经常需要对传入方法的参数进行精确匹配。然而，当需要匹配一个参数是否包含在某个特定值集合中时，Mockito的内置ArgumentMatchers（如eq()、any()等）并没有提供一个直接的in()或isIn()这样的匹配器。例如，对于一个接收int类型参数的方法getValuesFor(int arg)，我们可能希望当arg的值是1、2或3中的任意一个时，都返回预期的结果。本文将详细介绍如何利用ArgumentMatchers.intThat()这一强大工具，结合Lambda表达式或自定义方法，优雅地实现这一高级参数匹配需求。
核心解决方案：使用 ArgumentMatchers.intThat()
ArgumentMatchers.intThat()是Mockito提供的一个高度灵活的匹配器，它接受一个Predicate<Integer>作为参数。这意味着我们可以传入任何能够判断一个int值是否符合特定条件的逻辑。利用这一特性，我们可以轻松实现集合内参数匹配。
基本用法：结合Lambda表达式
最直接的方式是使用Java 8的Lambda表达式来定义匹配逻辑。例如，我们要匹配参数arg是否在集合{1, 2, 3}中，可以这样实现：
import org.junit.jupiter.api.Test;
import org.mockito.Mockito;
import org.mockito.ArgumentMatchers;
import java.util.List;
import java.util.Set;
import static org.mockito.Mockito.when;
import static org.mockito.ArgumentMatchers.intThat;
// 假设我们有这样一个接口或类
interface MyService {
List<Integer> getValuesFor(int arg);
}
public class MockitoCollectionMatcherExample {
@Test
void testIntArgumentInCollection() {
MyService mockObject = Mockito.mock(MyService.class);
// 使用 intThat 结合 Lambda 表达式定义匹配逻辑
// 当 getValuesFor 方法的 int 参数是 1, 2, 或 3 中的任意一个时，返回 List.of(3, 4, 5)
when(mockObject.getValuesFor(intThat(x -> Set.of(1, 2, 3).contains(x))))
.thenReturn(List.of(3, 4, 5));
// 测试调用
List<Integer> result1 = mockObject.getValuesFor(1); // 匹配成功
List<Integer> result2 = mockObject.getValuesFor(2); // 匹配成功
List<Integer> result3 = mockObject.getValuesFor(3); // 匹配成功
List<Integer> result4 = mockObject.getValuesFor(4); // 不匹配
System.out.println("Result for arg 1: " + result1); // 输出 [3, 4, 5]
System.out.println("Result for arg 2: " + result2); // 输出 [3, 4, 5]
System.out.println("Result for arg 3: " + result3); // 输出 [3, 4, 5]
System.out.println("Result for arg 4: " + result4); // 输出 null (因为没有为 4 定义桩行为)
// 验证
Mockito.verify(mockObject).getValuesFor(1);
Mockito.verify(mockObject).getValuesFor(2);
Mockito.verify(mockObject).getValuesFor(3);
// Mockito.verify(mockObject).getValuesFor(4); // 这会失败，因为没有匹配到 4 的桩
}
}在上述代码中，intThat(x -> Set.of(1, 2, 3).contains(x))的含义是：当传入getValuesFor方法的int参数x被Set.of(1, 2, 3)包含时，该匹配器返回true。Set.of()创建了一个不可变的Set，其contains()方法提供了高效的查找能力。
优化与重用：自定义匹配器方法
如果需要在多个测试用例或多个地方使用相同的集合内匹配逻辑，将Lambda表达式直接嵌入到when()语句中可能会导致代码重复和可读性下降。此时，我们可以将匹配逻辑提取到一个独立的辅助方法中，使其更具可读性和可重用性。
import org.junit.jupiter.api.Test;
import org.mockito.Mockito;
import org.mockito.ArgumentMatchers;
import java.util.Arrays;
import java.util.List;
import java.util.Set;
import java.util.stream.Collectors;
import static org.mockito.Mockito.when;
import static org.mockito.ArgumentMatchers.intThat;
// 假设我们有这样一个接口或类
interface MyService {
List<Integer> getValuesFor(int arg);
}
public class MockitoCustomMatcherMethodExample {
// 辅助方法：生成一个 Predicate 来检查 int 值是否在给定数组中
private static java.util.function.Predicate<Integer> isOneOf(int... values) {
// 将 int 数组转换为 Set，以便高效地进行 contains 检查
Set<Integer> allowedValues = Arrays.stream(values).boxed().collect(Collectors.toSet());
return allowedValues::contains; // 返回一个 Predicate
}
@Test
void testIntArgumentUsingCustomMatcherMethod() {
MyService mockObject = Mockito.mock(MyService.class);
// 使用自定义辅助方法，使代码更简洁易读
when(mockObject.getValuesFor(intThat(isOneOf(1, 2, 3))))
.thenReturn(List.of(3, 4, 5));
// 测试调用
List<Integer> result1 = mockObject.getValuesFor(1);
List<Integer> result2 = mockObject.getValuesFor(2);
List<Integer> result4 = mockObject.getValuesFor(4);
System.out.println("Result for arg 1: " + result1);
System.out.println("Result for arg 2: " + result2);
System.out.println("Result for arg 4: " + result4);
// 验证
Mockito.verify(mockObject).getValuesFor(intThat(isOneOf(1, 2, 3)));
}
}通过isOneOf(int... values)这样的辅助方法，我们的when()语句变得更加清晰，如同使用一个自定义的in()匹配器。这种方法不仅提高了代码的可读性，也方便了匹配逻辑的维护和复用。
注意事项
-
类型匹配器选择：
- 对于int类型参数，使用intThat()。
- 对于long类型参数，使用longThat()。
- 对于其他基本类型（如boolean、double等），Mockito提供了对应的booleanThat()、doubleThat()等。
- 对于对象类型参数，使用通用的argThat()，它接受一个Predicate<T>（其中T是参数类型）。
- 性能考量：当匹配的集合非常大时，Set的contains()方法通常比List更高效，因为它基于哈希表实现，平均时间复杂度为O(1)。因此，将参数值集合转换为Set是一个好的实践。
- 可读性与复杂性：虽然intThat()非常强大，但过度复杂的Lambda表达式可能会降低测试的可读性。如果匹配逻辑变得非常复杂，考虑将其封装到更小的、命名良好的辅助方法中，或者甚至创建一个自定义的ArgumentMatcher类（通过实现org.mockito.ArgumentMatcher接口），以提供更清晰的语义。
- verify()中的使用：在Mockito.verify()中也可以使用相同的intThat()匹配器来验证方法是否被调用了，并且其参数符合特定的集合条件。
总结
尽管Mockito没有直接的in()或isIn()参数匹配器，但ArgumentMatchers.intThat()（及其对应的其他基本类型和对象类型匹配器）提供了一个灵活且强大的替代方案。通过结合Lambda表达式或封装成自定义辅助方法，我们可以轻松实现复杂的集合内参数匹配逻辑，从而编写出更精确、更可读、更易于维护的单元测试代码。理解并熟练运用xxxThat()系列匹配器，是提升Mockito测试技能的关键一步。
