NSubstitute中IMemoryCache.TryGetValue的正确Mock方法

概述

在使用NSubstitute进行单元测试时，Mock IMemoryCache接口的TryGetValue方法是一个常见的需求。本文将通过一个实际案例，详细介绍如何正确使用NSubstitute来Mock这个方法的out参数。

问题背景

在从Moq迁移到NSubstitute的过程中，开发者经常遇到的一个典型问题是如何正确处理带有out参数的方法Mock。特别是对于IMemoryCache接口的TryGetValue方法，其签名如下：

bool TryGetValue(object key, out object? value)

错误示范

很多从Moq转向NSubstitute的开发者会尝试以下写法：

object? outValue = new List<object> { new object() };
_memoryCache.TryGetValue(It.IsAny<object>(), out outValue)
    .Returns(x => {
        x[1] = outValue;
        return true;
    });

这段代码存在两个主要问题：

1. 使用了Moq的It.IsAny而不是NSubstitute的Arg.Any
2. out参数的处理方式不正确

正确解决方案

方案一：使用ReturnsForAnyArgs

object? outValue = new List<object> { new object() };
memoryCache.TryGetValue(default!, out _)
    .ReturnsForAnyArgs(x => {
        x[1] = outValue;
        return true;
    });

这种方法使用了ReturnsForAnyArgs，它会忽略所有参数匹配，适用于不关心具体参数值的情况。

方案二：使用Arg.Any

object? outValue = new List<object> { new object() };
memoryCache.TryGetValue(Arg.Any<object>(), out Arg.Any<object?>())
    .Returns(x => {
        x[1] = outValue;
        return true;
    });

这种方法明确指定了参数匹配规则，使用NSubstitute的Arg.Any来匹配任意输入参数。

技术要点解析

1. 参数匹配：NSubstitute使用Arg.Any<T>()而不是Moq的It.IsAny<T>()

2. out参数处理：在Returns回调中，通过索引器访问参数（x[1]对应第二个参数）来设置out参数的值

3. 默认值处理：使用default!可以避免null引用警告，同时保持代码简洁

4. 返回值设置：回调函数中需要明确返回一个布尔值表示是否找到缓存项

最佳实践建议

1. 对于简单的Mock场景，推荐使用方案一，代码更简洁
2. 当需要更精确的参数匹配时，使用方案二
3. 在迁移项目时，注意彻底移除Moq的引用，避免混用
4. 考虑为常用的Mock模式创建辅助方法，提高代码复用性

总结

正确处理NSubstitute中带有out参数的方法Mock需要注意参数匹配语法和回调函数的编写方式。通过理解NSubstitute的工作原理，可以避免常见的迁移陷阱，编写出更健壮、更易维护的单元测试代码。