NSubstitute中NotASubstituteException异常的正确处理方法

在使用NSubstitute进行单元测试时，开发人员可能会遇到NotASubstituteException异常，这通常是由于对NSubstitute的API使用不当造成的。本文将通过一个实际案例，深入分析这个异常的产生原因和解决方法。

异常现象分析

在测试代码中，开发人员试图验证ISignalROrders接口的OrderDelivered方法是否被调用了一次，代码如下：

_signalROrders.OrderDelivered(Arg.Any<Guid>()).Received(1);

这段代码会抛出NotASubstituteException异常，提示"Received()方法只能在通过Substitute.For()创建的对象上调用"。

问题根源

这个异常的根本原因是开发人员错误地理解了NSubstitute的API调用顺序。NSubstitute要求Received()检查必须直接应用于替代实例本身，而不是方法调用的结果。

正确的验证方式应该是：

_signalROrders.Received(1).OrderDelivered(Arg.Any<Guid>());

技术原理

NSubstitute的工作原理是通过创建代理对象来拦截方法调用。当我们在替代对象上调用方法时，NSubstitute会记录这些调用以便后续验证。Received()方法需要直接作用于替代对象，这样才能访问NSubstitute内部记录的调用信息。

错误的调用方式实际上是在尝试对方法返回值（而不是替代对象本身）进行Received()验证，这显然是不合理的，因为方法返回值通常不是由NSubstitute创建的替代对象。

最佳实践

1. 正确的调用顺序：始终将Received()放在替代对象之后，方法调用之前
2. 参数匹配：使用Arg.Any<T>()等匹配器来灵活验证方法调用
3. 调用次数验证：可以通过Received(1)、Received(2)或DidNotReceive()来精确控制验证

总结

理解NSubstitute的API设计理念对于正确使用这个框架至关重要。Received()验证必须直接作用于替代对象，这是NSubstitute能够跟踪方法调用的关键。通过遵循正确的API调用顺序，可以避免NotASubstituteException异常，编写出更加健壮的单元测试代码。

记住这个简单的规则：先写替代对象，然后是Received()，最后才是要验证的方法调用。这种模式可以确保NSubstitute能够正确拦截和记录方法调用，从而进行有效的验证。