添加值以模拟 IHttpContextAccessor 单元测试 .net 核心 - C#

在进行 .NET Core 单元测试时，我们有时会发现需要使用 IHttpContextAccessor 进行测试，但是在测试时却无法正常初始化它，这个时候我们需要模拟一个 HttpContext 对象。

下面，我们将介绍如何通过添加值来模拟一个 IHttpContextAccessor。我们将以一个示例来说明。

示例代码

using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.DependencyInjection;

public class ExampleController
{
    private readonly IHttpContextAccessor _httpContextAccessor;

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

    public IActionResult Get()
    {
        var username = _httpContextAccessor.HttpContext.User.Identity.Name;
        // ...
    }
}

在上面的代码中，我们通过 IHttpContextAccessor 获取了当前用户的用户名。

添加模拟值

要添加模拟值，我们可以使用 IServiceCollection 接口中的 AddHttpContextAccessor 方法。在 AddHttpContextAccessor 方法中，我们可以使用 IHttpContextAccessor 接口设置 HttpContext 对象。

下面是一个示例代码：

using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.DependencyInjection;
using Xunit;

public class ExampleControllerTests
{
    private readonly IServiceCollection _serviceCollection = new ServiceCollection();
    private readonly ExampleController _controller;

    public ExampleControllerTests()
    {
        _serviceCollection.AddHttpContextAccessor();
        _serviceCollection.AddSingleton<IHttpContextAccessor, HttpContextAccessor>();

        var serviceProvider = _serviceCollection.BuildServiceProvider();

        var httpContext = new DefaultHttpContext();
        httpContext.User.Identity.Name = "testuser";

        _controller = new ExampleController(serviceProvider.GetService<IHttpContextAccessor>());
        _controller.ControllerContext.HttpContext = httpContext;
    }

    [Fact]
    public void Get_ReturnsUsername()
    {
        var result = _controller.Get();

        Assert.Equal("testuser", result.Value);
    }
}

在上面的代码片段中，我们添加了一个 IServiceCollection 对象，然后向该对象添加 HttpContextAccessor。随后，我们将 HttpContextAccessor 注入到 Controller 的构造函数中。

在单元测试中，我们新建一个 DefaultHttpContext 对象，设置该对象的 User.Identity.Name 属性为 testuser，然后将它赋值给 ControllerContext。然后，我们调用 Get 方法，并断言它所返回的值是否等于 testuser。

结论

在本文中，我们介绍了如何添加值以模拟 IHttpContextAccessor 单元测试。我们使用 IServiceCollection 接口中的 AddHttpContextAccessor 方法，在单元测试中模拟了 HttpContext 对象。在这个例子中，我们通过将模拟的 HttpContext 对象设置为 User 对象的属性来模拟了当前登录用户。