ASP.NET Core MVC控制器单元测试问题：Session使用引发测试障碍

我之前在测试依赖Session的ASP.NET Core控制器方法时也踩过这个坑，核心问题就是单元测试环境下默认没有真实的HttpContext和Session实例，直接跑测试肯定会报错。下面给你两种可行的解决思路，你可以根据自己的代码情况选：

方案一：模拟HttpContext和Session（快速适配现有代码） #

如果不想大改现有控制器代码，我们可以用Moq（或者其他模拟框架）伪造HttpContext和Session对象，让控制器能正常调用Session的相关方法。

具体操作步骤：

• 先创建一个模拟的ISession实例，Session的Get/Set操作都是基于这个接口的
• 把模拟的Session挂载到控制器的HttpContext上
• 针对你用到的GetObjectFromJson和SetObjectAsJson扩展方法，要确保模拟的Session能匹配扩展方法内部的序列化/反序列化逻辑

给你一个可直接参考的代码示例：

using Moq;
using Microsoft.AspNetCore.Http;
using Newtonsoft.Json; // 如果你用的是Newtonsoft.Json序列化

[TestClass]
public class LobbyControllerTests
{
    [TestMethod]
    public void OpretLobby_ShouldAddLobbyToListAndStoreInSession()
    {
        // 1. 准备测试数据
        var testUser = new User { Id = 1, Name = "TestUser" };
        var mockSession = new Mock<ISession>();
        
        // 模拟Session.GetObjectFromJson<User>的行为：获取"user"键时返回测试用户
        mockSession.Setup(s => s.TryGetValue("user", out It.Ref<byte[]>.IsAny))
                   .Returns(true)
                   .Callback<string, byte[]>((key, value) => 
                   {
                       value = JsonConvert.SerializeObject(testUser).ToByteArray();
                   });

        // 模拟Session.SetObjectAsJson的行为，同时捕获存储的Lobby数据
        byte[] storedLobbyBytes = null;
        mockSession.Setup(s => s.Set("lobby", It.IsAny<byte[]>()))
                   .Callback<string, byte[]>((key, value) => 
                   {
                       storedLobbyBytes = value;
                   });

        // 2. 模拟HttpContext并绑定到控制器
        var mockHttpContext = new Mock<HttpContext>();
        mockHttpContext.Setup(c => c.Session).Returns(mockSession.Object);

        // 3. 初始化控制器和依赖的_lobbyList
        var lobbyList = new List<Lobby>();
        var controller = new LobbyController(lobbyList)
        {
            ControllerContext = new ControllerContext
            {
                HttpContext = mockHttpContext.Object
            }
        };

        // 4. 执行测试方法
        controller.OpretLobby();

        // 5. 验证结果
        Assert.AreEqual(1, lobbyList.Count);
        var storedLobby = JsonConvert.DeserializeObject<Lobby>(storedLobbyBytes);
        Assert.AreEqual(testUser.Id, storedLobby.OwnerId); // 假设Lobby有OwnerId属性
        mockSession.Verify(s => s.Set("lobby", It.IsAny<byte[]>()), Times.Once);
    }
}

注意：如果你的扩展方法用的是System.Text.Json而不是Newtonsoft.Json，记得把序列化逻辑改成对应的实现。

方案二：抽象Session操作（更优雅的长期方案） #

如果想让代码更符合SOLID原则，也更易于维护和测试，建议把Session相关的操作抽象成独立服务，通过依赖注入注入到控制器中。这样单元测试时只需要Mock这个服务，完全不用碰HttpContext。

具体操作步骤：

1. 创建Session操作的接口：

public interface ISessionService
{
    T GetUserFromSession<T>(string key);
    void SetLobbyToSession(string key, Lobby lobby);
}

2. 实现接口，封装Session的具体操作：

public class SessionService : ISessionService
{
    private readonly IHttpContextAccessor _httpContextAccessor;

    public SessionService(IHttpContextAccessor httpContextAccessor)
    {
        _httpContextAccessor = httpContextAccessor;
    }

    public T GetUserFromSession<T>(string key)
    {
        return _httpContextAccessor.HttpContext.Session.GetObjectFromJson<T>(key);
    }

    public void SetLobbyToSession(string key, Lobby lobby)
    {
        _httpContextAccessor.HttpContext.Session.SetObjectAsJson(key, lobby);
    }
}

3. 修改控制器，注入服务替换直接操作Session的代码：

public class LobbyController : Controller
{
    private readonly List<Lobby> _lobbyList;
    private readonly ISessionService _sessionService;

    public LobbyController(List<Lobby> lobbyList, ISessionService sessionService)
    {
        _lobbyList = lobbyList;
        _sessionService = sessionService;
    }

    [HttpPost]
    public IActionResult OpretLobby()
    {
        var currentUser = _sessionService.GetUserFromSession<User>("user");
        var newLobby = new Lobby { Owner = currentUser };
        _sessionService.SetLobbyToSession("lobby", newLobby);
        _lobbyList.Add(newLobby);
        return RedirectToAction("SomeAction");
    }
}

4. 单元测试时直接MockISessionService：

[TestClass]
public class LobbyControllerTests
{
    [TestMethod]
    public void OpretLobby_ShouldAddLobbyToListAndCallSessionService()
    {
        // 准备测试数据
        var testUser = new User { Id = 1, Name = "TestUser" };
        var mockSessionService = new Mock<ISessionService>();
        mockSessionService.Setup(s => s.GetUserFromSession<User>("user"))
                          .Returns(testUser);

        var lobbyList = new List<Lobby>();
        var controller = new LobbyController(lobbyList, mockSessionService.Object);

        // 执行测试方法
        controller.OpretLobby();

        // 验证结果
        Assert.AreEqual(1, lobbyList.Count);
        Assert.AreEqual(testUser.Id, lobbyList[0].Owner.Id);
        mockSessionService.Verify(s => s.SetLobbyToSession("lobby", It.IsAny<Lobby>()), Times.Once);
    }
}

这种方案的好处是把控制器和Session的具体实现解耦了，不仅测试更简单，后续如果要更换Session存储方式（比如用Redis），只需要修改SessionService的实现即可，完全不用动控制器代码。

两种方案各有优劣：方案一适合快速解决现有代码的测试问题，不用大改；方案二更适合长期维护，代码更健壮。你可以根据自己的项目阶段来选择。

内容的提问来源于stack exchange，提问作者Nicholas Ladefoged