NSubstitute中模拟IHttpContextAccessor和ISession的实践指南

引言

在ASP.NET Core单元测试中，模拟HttpContext及其相关组件是一个常见需求。本文将深入探讨如何使用NSubstitute框架正确模拟IHttpContextAccessor和ISession接口，特别是处理Session扩展方法时的注意事项。

ISession接口的本质

ISession接口是ASP.NET Core中处理会话状态的核心接口，它定义了基本的会话操作方法。值得注意的是，在实际开发中我们常用的SetString和GetString等方法实际上是Microsoft.AspNetCore.Http命名空间下的扩展方法，而非ISession接口本身的成员。

常见误区分析

许多开发者在尝试模拟ISession时会遇到以下典型问题：

1. 直接对扩展方法进行验证：试图使用Received()验证SetString等扩展方法的调用
2. 字节数组比较问题：当验证Set方法时，直接比较字节数组会导致断言失败
3. 编码差异：忽略字符串到字节数组转换时可能存在的编码差异

正确的模拟方法

基础模拟设置

首先建立基本的模拟结构：

var sessionMock = Substitute.For<ISession>();
var context = new DefaultHttpContext();
context.Session = sessionMock;
var httpContextAccessorMock = Substitute.For<IHttpContextAccessor>();
httpContextAccessorMock.HttpContext.Returns(context);

处理扩展方法调用

当被测代码使用Session扩展方法时，实际上会转换为对ISession基础方法的调用。例如：

// 扩展方法调用
context.Session.SetString("key", "value");

// 等效于
context.Session.Set("key", Encoding.UTF8.GetBytes("value"));

正确的验证方式

验证Session操作时，应该：

1. 验证基础方法而非扩展方法
2. 使用Arg.Is进行字节数组的深度比较

var expectedBytes = Encoding.UTF8.GetBytes("expectedValue");
sessionMock.Received(1)
    .Set("key", Arg.Is<byte[]>(b => b.SequenceEqual(expectedBytes)));

完整示例

被测服务

public class MyService
{
    private readonly IHttpContextAccessor _httpContextAccessor;
    
    public MyService(IHttpContextAccessor httpContextAccessor)
    {
        _httpContextAccessor = httpContextAccessor;
    }
    
    public void SetActive(MyEnum value)
    {
        _httpContextAccessor.HttpContext!.Session.SetString("key", value.ToString());
    }
}

测试代码

[Fact]
public void SetActive_ShouldStoreValueInSession()
{
    // Arrange
    var sessionMock = Substitute.For<ISession>();
    var context = new DefaultHttpContext();
    context.Session = sessionMock;
    var httpContextAccessorMock = Substitute.For<IHttpContextAccessor>();
    httpContextAccessorMock.HttpContext.Returns(context);
    
    var service = new MyService(httpContextAccessorMock);
    
    // Act
    service.SetActive(MyEnum.Test);
    
    // Assert
    var expectedBytes = Encoding.UTF8.GetBytes(MyEnum.Test.ToString());
    sessionMock.Received(1)
        .Set("key", Arg.Is<byte[]>(b => b.SequenceEqual(expectedBytes)));
}

高级技巧

1. 编码一致性：确保测试和生产代码使用相同的编码方式(通常为UTF-8)
2. BOM处理：注意UTF-8编码可能包含的字节顺序标记(BOM)
3. 自定义匹配器：对于频繁使用的字节数组比较，可以创建自定义参数匹配器

public static class ByteArrayMatcher
{
    public static byte[] BytesEqual(string expected)
    {
        return Arg.Is<byte[]>(b => b.SequenceEqual(Encoding.UTF8.GetBytes(expected)));
    }
}

// 使用方式
sessionMock.Received(1).Set("key", ByteArrayMatcher.BytesEqual("expected"));

总结

在NSubstitute中正确模拟ISession需要注意扩展方法的本质和字节数组比较的特殊性。通过理解底层实现原理并采用正确的验证方式，可以有效地测试与Session相关的功能。记住，好的单元测试不仅需要正确的断言，还需要对被测组件的实现细节有深入理解。