0

0

Mockito中利用自定义ArgumentMatcher实现集合内参数匹配

DDD

DDD

发布时间:2025-10-23 13:49:13

|

631人浏览过

|

来源于php中文网

原创

Mockito中利用自定义ArgumentMatcher实现集合内参数匹配

mockito并未提供直接的`in()`参数匹配器来判断方法参数是否包含在指定集合中。本文将详细介绍如何利用`intthat`(或`argthat`)结合lambda表达式或自定义匹配器,灵活实现对方法参数是否属于某个集合的条件匹配,从而在测试存根(stubbing)或验证(verification)阶段,提升测试代码的精确性和可读性。

在单元测试中使用Mockito进行方法存根(stubbing)或验证(verification)时,我们经常需要对方法参数进行精细控制。当我们需要判断一个基本类型或对象参数是否属于一个预定义的集合时,例如判断一个int参数是否在{1, 2, 3}之中,Mockito的标准ArgumentMatchers中并没有直接提供类似in(1, 2, 3)这样的匹配器。然而,Mockito提供了强大的intThat(针对基本类型int)和argThat(针对对象类型)方法,允许我们通过自定义谓词(Predicate)或ArgumentMatcher接口来实现这种灵活的匹配逻辑。

核心概念:intThat与自定义匹配逻辑

intThat(或argThat)是Mockito提供的一个通用匹配器,它接受一个Matcher实例或一个Lambda表达式(在Java 8及更高版本中),允许我们定义任意复杂的参数匹配规则。对于基本类型int的参数,我们可以使用intThat。

假设我们有一个被测试对象mockObject,其中包含一个方法签名如下:

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

我们希望当getValuesFor方法的arg参数是1、2或3中的任意一个时,都返回特定的结果。我们可以通过intThat结合Lambda表达式来实现:

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.*;

class MyServiceTest {

    @Test
    void testGetValuesForContainedInCollection() {
        MyService mockObject = mock(MyService.class);

        // 使用 intThat 结合 Lambda 表达式定义匹配规则
        when(mockObject.getValuesFor(ArgumentMatchers.intThat(x -> Set.of(1, 2, 3).contains(x))))
                .thenReturn(List.of(30, 40, 50));

        // 测试调用
        List result1 = mockObject.getValuesFor(1);
        List result2 = mockObject.getValuesFor(2);
        List result3 = mockObject.getValuesFor(3);
        List result4 = mockObject.getValuesFor(4); // 不匹配

        // 验证结果
        System.out.println("Result for 1: " + result1);
        System.out.println("Result for 2: " + result2);
        System.out.println("Result for 3: " + result3);
        System.out.println("Result for 4: " + result4);

        // 断言
        assert(result1.equals(List.of(30, 40, 50)));
        assert(result2.equals(List.of(30, 40, 50)));
        assert(result3.equals(List.of(30, 40, 50)));
        assert(result4 == null || result4.isEmpty()); // 如果没有其他 stubbing,默认返回null或空列表
    }
}

在这个示例中,ArgumentMatchers.intThat(x -> Set.of(1, 2, 3).contains(x))创建了一个自定义匹配器。它接受一个int参数x,并检查x是否包含在Set.of(1, 2, 3)这个集合中。使用Set而不是List进行contains检查通常效率更高,尤其是在集合较大时。

优化可读性:提取自定义匹配器

虽然Lambda表达式简洁,但如果匹配逻辑在多个地方重复使用,或者逻辑本身比较复杂,将其提取成一个独立的辅助方法或一个自定义的ArgumentMatcher类可以显著提高代码的可读性和可维护性。

1. 提取为辅助方法

我们可以创建一个静态辅助方法,该方法返回一个ArgumentMatcher(或者在内部使用intThat)。

ReRoom AI
ReRoom AI

专为室内设计打造的AI渲染工具,可以将模型图、平面图、草图、照片转换为高质量设计效果图。

下载
import org.mockito.ArgumentMatcher;
import java.util.Arrays;
import java.util.Set;
import java.util.stream.Collectors;

// ... 在 MyServiceTest 类内部或作为工具类方法 ...
public class CustomMatchers {
    public static ArgumentMatcher isOneOf(int... values) {
        Set valueSet = Arrays.stream(values).boxed().collect(Collectors.toSet());
        return argument -> valueSet.contains(argument);
    }
}

然后,在测试代码中,我们可以这样使用它:

// ... 在 MyServiceTest 类内部 ...
@Test
void testGetValuesForContainedInCollection_withHelperMethod() {
    MyService mockObject = mock(MyService.class);

    // 使用提取的辅助方法
    when(mockObject.getValuesFor(ArgumentMatchers.intThat(CustomMatchers.isOneOf(1, 2, 3))))
            .thenReturn(List.of(30, 40, 50));

    // 测试调用与验证...
    List result1 = mockObject.getValuesFor(1);
    System.out.println("Result for 1 (using helper): " + result1);
    assert(result1.equals(List.of(30, 40, 50)));
}

这种方式使得when语句更加清晰,更具表达力,因为它读起来就像“当参数是1、2或3中的一个时”。

2. 实现ArgumentMatcher接口(适用于更复杂场景)

对于更复杂的匹配逻辑,或者需要提供详细错误消息的场景,可以直接实现org.mockito.ArgumentMatcher接口:

import org.mockito.ArgumentMatcher;
import java.util.Arrays;
import java.util.Set;
import java.util.stream.Collectors;

class IntegerInCollectionMatcher implements ArgumentMatcher {
    private final Set expectedValues;

    public IntegerInCollectionMatcher(int... values) {
        this.expectedValues = Arrays.stream(values).boxed().collect(Collectors.toSet());
    }

    @Override
    public boolean matches(Integer argument) {
        return argument != null && expectedValues.contains(argument);
    }

    // 可选:重写 toString() 以提供更好的错误消息
    @Override
    public String toString() {
        return "is one of " + expectedValues;
    }
}

使用方式:

// ... 在 MyServiceTest 类内部 ...
@Test
void testGetValuesForContainedInCollection_withCustomMatcherClass() {
    MyService mockObject = mock(MyService.class);

    // 使用自定义 ArgumentMatcher 类
    when(mockObject.getValuesFor(ArgumentMatchers.argThat(new IntegerInCollectionMatcher(1, 2, 3))))
            .thenReturn(List.of(30, 40, 50));

    // 注意:这里使用了 argThat 而不是 intThat,因为 IntegerInCollectionMatcher 匹配的是 Integer 对象。
    // Mockito 在匹配 int 和 Integer 之间会进行自动装箱/拆箱。
    // 如果方法参数是 int,使用 intThat 配合返回 Predicate 的 lambda 或方法更直接。
    // 如果方法参数是 Integer,则 argThat 配合 ArgumentMatcher 更自然。

    List result1 = mockObject.getValuesFor(1);
    System.out.println("Result for 1 (using custom class): " + result1);
    assert(result1.equals(List.of(30, 40, 50)));
}

适用场景与注意事项

  • 存根(Stubbing)与验证(Verification): intThat和argThat不仅可以用于when进行存根,也可以用于verify进行方法调用验证。
    verify(mockObject).getValuesFor(ArgumentMatchers.intThat(CustomMatchers.isOneOf(1, 2, 3)));
  • 类型匹配:
    • 对于基本类型参数(如int),推荐使用intThat。
    • 对于对象类型参数(如Integer, String, List等),使用argThat。
  • 性能考量: 如果匹配的集合非常大,contains操作的性能可能会成为瓶颈。对于Set来说,contains是O(1)平均时间复杂度,通常性能良好。
  • 可读性与维护性: 优先考虑使用Lambda表达式实现简洁的匹配逻辑。当逻辑变得复杂或需要复用时,再考虑提取为辅助方法或独立的ArgumentMatcher类。自定义ArgumentMatcher类可以提供更详细的toString()方法,这在测试失败时有助于调试。
  • 与any()、eq()等结合: 自定义匹配器可以与其他Mockito匹配器结合使用,例如argThat(someMatcher).and(eq("anotherArg"))。

总结

尽管Mockito没有直接提供in()这样的参数匹配器,但通过intThat(或argThat)结合Lambda表达式或自定义ArgumentMatcher,我们能够灵活且强大地实现参数是否属于某个集合的匹配需求。这种方式不仅解决了特定场景下的匹配问题,也展示了Mockito在自定义参数匹配方面的强大扩展能力,使得测试代码既精确又易于理解和维护。在实践中,根据匹配逻辑的复杂度和复用性,选择最合适的实现方式,可以有效提升单元测试的质量和效率。

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

844

2023.06.15

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

743

2023.07.05

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

740

2023.07.31

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

397

2023.08.01

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

400

2023.08.02

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

447

2023.08.02

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

431

2023.08.02

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

16926

2023.08.03

c++空格相关教程合集
c++空格相关教程合集

本专题整合了c++空格相关教程,阅读专题下面的文章了解更多详细内容。

0

2026.01.23

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Kotlin 教程
Kotlin 教程

共23课时 | 2.8万人学习

C# 教程
C# 教程

共94课时 | 7.4万人学习

Java 教程
Java 教程

共578课时 | 50.3万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号