NSubstitute中模拟受保护方法的正确姿势

问题背景

在使用NSubstitute进行单元测试时，开发者经常会遇到需要模拟基类中受保护方法(protected method)的情况。本文通过一个典型场景，深入分析如何正确使用NSubstitute来测试包含受保护方法的类。

典型场景分析

考虑以下代码结构：

public abstract class BaseClass {
    protected virtual async Task<ApiResult<string>> DownloadFile(string path1, string path2) {
        // 默认实现
    }
}

public class SomeClass : BaseClass {
    public async Task<string?> Download(string path1, string path2) {
        var result1 = await DownloadFile(path1, path2); // 第一次调用
        var result2 = await DownloadFile(path1, path2); // 第二次调用
        return result2.Value;
    }
}

在测试中，开发者尝试使用反射来模拟受保护的DownloadFile方法，但发现第一次调用返回null，而第二次调用才返回预期的模拟对象。

问题根源

这个问题源于几个关键因素：

1. 访问权限问题：NSubstitute无法直接模拟protected方法，因为它需要通过代理机制工作，而protected方法对代理不可见。

2. 反射误用：尝试通过反射绕过访问限制会导致不可预测的行为，因为NSubstitute的内部机制无法正确拦截这类调用。

3. 参数匹配问题：在测试代码中错误地使用了Arg.Any<string>()作为实际调用参数，而不是在配置mock时使用。

解决方案

方案一：修改访问修饰符（简单但不推荐）

将protected改为internal protected，并添加InternalsVisibleTo特性：

[assembly: InternalsVisibleTo("TestProject")]
internal protected virtual async Task<ApiResult<string>> DownloadFile(...)

这种方法简单直接，但需要修改生产代码来适应测试需求，可能违反设计原则。

方案二：使用测试专用子类（推荐）

创建一个仅在测试中使用的子类，暴露protected方法：

public class TestableSomeClass : SomeClass {
    public new Task<ApiResult<string>> DownloadFile(string p1, string p2) 
        => base.DownloadFile(p1, p2);
}

然后在测试中使用这个子类进行模拟：

var testable = Substitute.For<TestableSomeClass>();
testable.DownloadFile(default!, default!)
    .ReturnsForAnyArgs(Task.FromResult(new ApiResult<string> {...}));

方案三：重构设计（最佳实践）

从根本上重构设计，使用组合代替继承：

public interface IFileDownloader {
    Task<ApiResult<string>> DownloadFile(string p1, string p2);
}

public class SomeClass {
    private readonly IFileDownloader _downloader;
    
    public SomeClass(IFileDownloader downloader) {
        _downloader = downloader;
    }
    
    public async Task<string?> Download(...) {
        // 使用_downloader而非继承
    }
}

这种设计不仅解决了测试问题，还提高了代码的可维护性和灵活性。

关键注意事项

1. 避免使用反射：反射会绕过类型系统，导致NSubstitute无法正确拦截调用。

2. 正确使用参数匹配：

   • 在配置mock时使用Arg.Any<T>()
   • 在实际调用时使用具体值或default!

3. 理解NSubstitute的限制：NSubstitute只能模拟virtual成员、接口成员和委托。

总结

在NSubstitute中测试包含受保护方法的类时，最佳实践是通过重构设计使用组合模式。如果必须保留继承结构，可以使用测试专用子类来暴露protected方法。无论采用哪种方案，都应避免使用反射等hack手段，保持测试代码的清晰和可维护性。

记住，测试困难往往暗示着设计问题。当发现测试需要复杂技巧时，应该考虑这是否意味着需要对生产代码进行重构。