NSubstitute中如何正确验证扩展方法的调用

在单元测试中使用NSubstitute进行模拟和验证时，开发人员经常会遇到一个常见陷阱——尝试验证扩展方法的调用。本文将深入探讨这个问题，并解释为什么直接验证扩展方法调用会失败，以及如何正确进行这类测试。

问题现象

当开发者尝试使用NSubstitute验证IDistributedCache接口的SetStringAsync扩展方法调用时，测试会意外失败。错误信息显示NSubstitute实际上检查的是SetAsync方法而非SetStringAsync方法。

根本原因

这个问题的根源在于NSubstitute的工作原理。NSubstitute只能拦截和验证虚拟(virtual)成员调用，而扩展方法在C#中本质上是静态方法。当代码调用扩展方法时，编译器会将其转换为对静态方法的调用。

以IDistributedCache的SetStringAsync为例，它实际上是DistributedCacheExtensions类中的一个静态方法：

public static Task SetStringAsync(this IDistributedCache cache, string key, string value, 
    DistributedCacheEntryOptions options, CancellationToken token = default)
{
    return cache.SetAsync(key, Encoding.UTF8.GetBytes(value), options, token);
}

当测试代码尝试验证SetStringAsync调用时，NSubstitute无法"看到"这个静态方法调用，只能捕获到底层的SetAsync虚拟方法调用。

解决方案

1. 验证底层虚拟方法调用

既然无法直接验证扩展方法，我们可以改为验证扩展方法最终调用的虚拟方法：

// 替代原来的SetStringAsync验证
await _cache.Received(1).SetAsync(
    cacheKey, 
    Arg.Any<byte[]>(), 
    Arg.Any<DistributedCacheEntryOptions>(), 
    ct);

2. 使用NSubstitute.Analyzers

安装NSubstitute.Analyzers可以帮助在编译时检测这类问题，它会警告开发者尝试验证静态或不可拦截的方法调用。

3. 重构代码设计

如果可能，考虑将缓存操作封装到一个专门的类中，而不是直接使用扩展方法。这样可以使代码更易于测试：

public interface ICacheService
{
    Task SetStringAsync(string key, string value, CancellationToken ct);
}

public class DistributedCacheService : ICacheService
{
    private readonly IDistributedCache _cache;
    
    public Task SetStringAsync(string key, string value, CancellationToken ct)
    {
        return _cache.SetStringAsync(key, value, ct);
    }
}

然后在测试中可以轻松验证ICacheService的调用。

最佳实践

1. 了解NSubstitute的限制：它只能拦截虚拟成员、接口成员和抽象成员
2. 对于扩展方法，要么验证其底层调用，要么将其封装
3. 使用分析器帮助检测潜在问题
4. 考虑将常用扩展方法封装到服务中以提高可测试性

记住，单元测试的目标是验证代码的行为，而不是具体的实现细节。有时验证底层调用可能比验证扩展方法更能反映代码的真实行为。