NSubstitute中引用类型参数匹配的注意事项

理解NSubstitute的参数记录机制

在使用NSubstitute进行单元测试时，开发者可能会遇到一个关于引用类型参数匹配的特殊行为。当多次调用同一个方法并使用相同的引用类型实例作为参数时，NSubstitute不会对这些参数进行深拷贝，而是保留对原始对象的引用。

问题现象

考虑以下测试场景：我们有一个接口IObjectUnderTest，其中包含一个方法Foo，它接受一个对象参数。当我们使用同一个引用类型实例多次调用该方法，并在调用间修改实例属性时，NSubstitute记录的是参数的最终状态，而不是每次调用时的状态。

var substitute = Substitute.For<IObjectUnderTest>();
var value = new MyReferenceType { Value = "initialValue"};
substitute.Foo(value);
value.Value = "newValue";
substitute.Foo(value);

// 以下断言可能会失败
substitute.Received(1).Foo(Arg.Is<MyReferenceType>(x => x.Value == "initialValue"));
substitute.Received(1).Foo(Arg.Is<MyReferenceType>(x => x.Value == "newValue"));

技术原理

NSubstitute的这种行为是设计使然。为了保持轻量级和高性能，NSubstitute不会对引用类型参数进行深拷贝。这意味着：

1. 当记录方法调用时，NSubstitute只保存参数的引用
2. 如果后续修改了参数对象的属性，所有之前记录的调用都会反映这些修改
3. 只有当创建新的实例时，才会保留不同的状态

解决方案

如果需要验证方法在不同参数状态下的调用情况，可以采用以下替代方案：

1. 使用When/Do模式：在测试中捕获并保存参数的状态

var values = new List<string>();
substitute.WhenForAnyArgs(s => s.Foo(Arg.Any<MyReferenceType>()))
    .Do(c => values.Add(c.ArgAt<MyReferenceType>(0).Value));

2. 使用不同的实例：每次调用时创建新的对象实例

var value1 = new MyReferenceType { Value = "initialValue"};
substitute.Foo(value1);
var value2 = new MyReferenceType { Value = "newValue"};
substitute.Foo(value2);

3. 记录调用时间戳：结合时间戳来区分不同状态的调用

最佳实践建议

1. 对于引用类型参数，尽量避免在测试中修改已传递的对象
2. 如果必须验证对象的不同状态，考虑使用值类型或不可变对象
3. 在团队中明确这一行为，避免误解
4. 对于复杂场景，优先使用When/Do模式来精确控制测试逻辑

理解NSubstitute的这一行为特性，可以帮助开发者编写更可靠和可维护的单元测试，避免因参数状态变化而导致的测试失败。