Mockito进阶：使用intThat实现集合内参数匹配

本文探讨在mockito中如何优雅地匹配一个整数参数是否包含在指定集合内。由于mockito没有直接的in()匹配器，我们将介绍如何利用intthat结合lambda表达式或自定义辅助方法，实现灵活且可读性强的参数匹配逻辑，从而解决对原始类型参数进行集合成员判断的场景。

在进行单元测试时，我们经常需要模拟（mock）对象的行为。Mockito是一个流行的Java模拟框架，它提供了丰富的参数匹配器（ArgumentMatchers）来定义模拟行为或验证方法调用。然而，当我们需要匹配一个原始类型（如int）参数是否包含在一个特定的值集合中时，标准的匹配器如eq()或anyInt()可能无法满足需求，而类似于in()的直接匹配器也并不存在于ArgumentMatchers或AdditionalMatchers中。本文将详细介绍如何通过intThat匹配器结合自定义逻辑来解决这一问题。

核心方案：使用 intThat 结合 Lambda 表达式

Mockito为原始类型提供了*That系列匹配器（例如intThat、longThat、booleanThat等），它们允许我们传入一个Matcher对象或一个Predicate（通过Lambda表达式），从而定义任意复杂的匹配逻辑。对于判断一个整数是否在给定集合内，这是最直接且强大的方法。

假设我们有一个被模拟的对象mockObject，其中包含一个方法getValuesFor(int arg)：

public interface MyService {
    List<Integer> getValuesFor(int arg);
}

// 模拟对象
MyService mockObject = mock(MyService.class);

现在，我们希望当getValuesFor方法被调用，且其arg参数是1、2或3中的任意一个时，返回特定的值。我们可以这样使用intThat：

import org.mockito.ArgumentMatchers;
import static org.mockito.Mockito.*;
import java.util.List;
import java.util.Set;

// ... (mockObject初始化)

when(mockObject.getValuesFor(ArgumentMatchers.intThat(x -> Set.of(1, 2, 3).contains(x))))
  .thenReturn(List.of(3, 4, 5));

// 测试调用
System.out.println(mockObject.getValuesFor(1)); // 输出 [3, 4, 5]
System.out.println(mockObject.getValuesFor(2)); // 输出 [3, 4, 5]
System.out.println(mockObject.getValuesFor(4)); // 默认行为，可能为null或空列表，取决于mock配置

在上述代码中：

• ArgumentMatchers.intThat()接收一个Predicate<Integer>函数式接口的实现。
• x -> Set.of(1, 2, 3).contains(x)是一个Lambda表达式，它定义了匹配逻辑：如果传入的整数x包含在集合{1, 2, 3}中，则返回true，表示匹配成功。
• 使用Set.of()创建集合是为了利用Set的高效contains方法进行查找，尤其当集合较大时，性能优势更为明显。

优化方案：封装自定义匹配逻辑

虽然Lambda表达式简洁，但如果相同的集合匹配逻辑需要在多个地方使用，或者匹配条件更为复杂，将其封装成一个独立的辅助方法会大大提高代码的可读性和复用性。

腾讯智影-AI数字人

基于AI数字人能力，实现7*24小时AI数字人直播带货，低成本实现直播业务快速增增，全天智能在线直播

73

查看详情

我们可以创建一个静态辅助方法，该方法接收一系列整数，并返回一个Predicate<Integer>：

import java.util.Arrays;
import java.util.HashSet;
import java.util.Set;
import java.util.function.Predicate;

public class CustomMatchers {

    /**
     * 创建一个Predicate，用于判断一个整数是否包含在指定的整数集合中。
     * @param allowedValues 允许的整数值
     * @return Predicate<Integer>
     */
    public static Predicate<Integer> isOneOf(Integer... allowedValues) {
        Set<Integer> allowedSet = new HashSet<>(Arrays.asList(allowedValues));
        return allowedSet::contains; // 或者 x -> allowedSet.contains(x)
    }
}

有了isOneOf辅助方法后，我们的Mockito桩定义将变得更加简洁和富有表达力：

import static org.mockito.Mockito.*;
import static org.mockito.ArgumentMatchers.intThat; // 静态导入 intThat
import static com.example.CustomMatchers.isOneOf; // 静态导入自定义匹配器，假设CustomMatchers在com.example包下
import java.util.List;

// ... (mockObject初始化)

when(mockObject.getValuesFor(intThat(isOneOf(1, 2, 3))))
  .thenReturn(List.of(3, 4, 5));

// 测试调用
System.out.println(mockObject.getValuesFor(1)); // 输出 [3, 4, 5]
System.out.println(mockObject.getValuesFor(2)); // 输出 [3, 4, 5]
System.out.println(mockObject.getValuesFor(4)); // 默认行为

这种封装方式不仅提升了代码的整洁度，也使得匹配逻辑更易于理解和维护。当需要匹配不同的集合时，只需调用isOneOf并传入相应的参数即可。

注意事项与总结

1. 静态导入: 为了代码的简洁性，建议静态导入org.mockito.Mockito.*、org.mockito.ArgumentMatchers.intThat（或argThat等），以及自定义匹配器方法。
2. 通用性: *That系列匹配器（如intThat、longThat、argThat等）是Mockito中实现自定义参数匹配的强大工具。argThat用于对象类型，接收Matcher<T>或Predicate<T>。
3. 性能考量: 当匹配集合较大时，使用HashSet进行contains操作通常比ArrayList等列表类型更高效，因为HashSet的查找时间复杂度平均为O(1)。
4. 适用场景: 这种方法不仅适用于when（桩定义），也同样适用于verify（验证方法调用）场景，例如：

   verify(mockObject).getValuesFor(intThat(isOneOf(1, 2, 3)));

   登录后复制
5. 类型匹配: 确保*That匹配器与被匹配的参数类型一致，例如intThat用于int类型参数。

总结

尽管Mockito没有提供直接的in()匹配器来判断原始类型参数是否包含在特定集合中，但通过灵活运用intThat（或其他*That匹配器）结合Lambda表达式，我们可以轻松实现这一需求。进一步地，将自定义匹配逻辑封装成辅助方法，能够显著提升测试代码的可读性、复用性和维护性。掌握这一技巧，将使您在Mockito中编写更强大、更富有表现力的单元测试。

以上就是Mockito进阶：使用intThat实现集合内参数匹配的详细内容，更多请关注php中文网其它相关文章！