NSubstitute中Arg.Is<object[]>参数匹配问题的解析与解决方案

问题背景

在使用NSubstitute进行单元测试时，开发人员经常会遇到需要模拟接收数组参数的方法调用。特别是在处理Entity Framework Core的FindAsync方法时，该方法通常接收一个object[]作为主键参数。然而，许多开发者发现直接使用Arg.Is<object[]>(expectedArray)进行参数匹配时会出现意外行为。

问题现象

当尝试使用以下方式设置模拟时：

_db.ReportJobs
    .FindAsync(Arg.Is<object[]>([jobId]), Arg.Any<CancellationToken>())
    .Returns(new ReportJobTbl {
        DateCompleted = DateTime.UtcNow
    });

测试会失败并抛出ArgumentNullException，提示"找不到给定ID的工作"。然而，如果将参数匹配改为Arg.Any<object[]>()，测试却能正常通过。

根本原因分析

这个问题源于.NET中数组比较的默认行为。在.NET中：

1. 数组是引用类型
2. 默认的相等比较是基于引用而非内容
3. 即使两个数组包含相同的元素，它们也不被认为是相等的

例如：

new object[1].Equals(new object[1]); // 返回false
new object[1] == new object[1]; // 返回false

NSubstitute的Arg.Is<>()方法依赖于.NET的默认相等比较行为，因此当比较两个不同的数组实例时，即使它们包含相同的内容，比较也会失败。

解决方案

方案1：使用SequenceEqual进行内容比较

最可靠的解决方案是使用LINQ的SequenceEqual方法来比较数组内容：

_db.ReportJobs
    .FindAsync(Arg.Is<object[]>(x => x.SequenceEqual(new object[] { jobId })), 
    Arg.Any<CancellationToken>())
    .Returns(new ReportJobTbl {
        DateCompleted = DateTime.UtcNow
    });

方案2：预先定义数组变量

如果内联定义数组导致问题，可以预先定义数组变量：

object[] jobIdSequence = [jobId];
_db.ReportJobs
    .FindAsync(Arg.Is<object[]>(x => x.SequenceEqual(jobIdSequence)), 
    Arg.Any<CancellationToken>())
    .Returns(new ReportJobTbl {
        Id = jobId,
        Job = ReportJobEnum.AddWardToReport,
        HangfireId = 1234
    });

最佳实践建议

1. 明确数组比较行为：当处理数组参数匹配时，始终记住.NET的数组比较是基于引用的。

2. 优先使用内容比较：对于数组参数，使用SequenceEqual或其他内容比较方法比直接比较更可靠。

3. 考虑可读性：如果匹配条件复杂，考虑将比较逻辑提取为单独的方法或变量，以提高测试代码的可读性。

4. 注意性能影响：对于大型数组，内容比较可能会有性能开销，但在单元测试场景中通常可以忽略不计。

总结

理解NSubstitute参数匹配的工作原理对于编写可靠的单元测试至关重要。在处理数组参数时，开发者需要特别注意.NET的默认比较行为，并采取适当的内容比较策略。通过使用SequenceEqual或其他内容比较方法，可以确保数组参数的匹配按预期工作，从而提高测试的准确性和可靠性。