集成测试中替换注入的IHttpContextAccessor后HttpContext始终为空

在使用WebApplicationFactory进行集成测试时，默认不会自动生成HttpContext（因为没有实际HTTP请求触发），即使你替换了IHttpContextAccessor的单例，也会出现HttpContext为空的情况。以下是几种可行的解决方案：

方案1：手动构建HttpContext并注入到Accessor #

直接在WebApplicationFactory的配置中创建带HttpContext的IHttpContextAccessor实例，确保依赖类能获取到上下文：

public class CustomWebApplicationFactory : WebApplicationFactory<Program>
{
    protected override void ConfigureWebHost(IWebHostBuilder builder)
    {
        builder.ConfigureServices(services =>
        {
            // 移除原有注册的IHttpContextAccessor
            var descriptor = services.SingleOrDefault(d => d.ServiceType == typeof(IHttpContextAccessor));
            if (descriptor != null)
            {
                services.Remove(descriptor);
            }

            // 构建自定义HttpContext
            var httpContext = new DefaultHttpContext();
            // 根据业务需求设置上下文属性，比如用户身份、请求头
            httpContext.User = new ClaimsPrincipal(new ClaimsIdentity(new[]
            {
                new Claim(ClaimTypes.NameIdentifier, "test-user-123")
            }, "TestAuth"));
            httpContext.Request.Headers.Add("X-App-Version", "1.0.0");

            // 创建Accessor并赋值HttpContext
            var accessor = new HttpContextAccessor { HttpContext = httpContext };
            services.AddSingleton<IHttpContextAccessor>(accessor);
        });
    }
}

在测试类中使用这个工厂，从Scope中获取MediatR服务执行请求即可。

方案2：测试方法内临时绑定HttpContext #

如果需要针对不同测试用例设置不同的HttpContext，可以在测试方法内手动设置并恢复上下文：

[Fact]
public async Task Test_Mediatr_Handler_With_Custom_HttpContext()
{
    using var factory = new WebApplicationFactory<Program>();
    using var scope = factory.Services.CreateScope();
    
    var mediator = scope.ServiceProvider.GetRequiredService<IMediator>();
    var httpContextAccessor = scope.ServiceProvider.GetRequiredService<IHttpContextAccessor>();

    // 保存原有上下文，测试后恢复
    var originalContext = httpContextAccessor.HttpContext;
    try
    {
        // 构建当前测试用的HttpContext
        var testContext = new DefaultHttpContext();
        testContext.User = new ClaimsPrincipal(new ClaimsIdentity(new[]
        {
            new Claim(ClaimTypes.Role, "Admin")
        }));
        
        httpContextAccessor.HttpContext = testContext;
        
        // 执行MediatR请求
        var result = await mediator.Send(new YourTestRequest());
        
        // 断言业务结果
        Assert.NotNull(result);
    }
    finally
    {
        httpContextAccessor.HttpContext = originalContext;
    }
}

方案3：检查依赖类的生命周期 #

如果依赖IHttpContextAccessor的类是单例，它会在应用启动时就被初始化，此时HttpContext还未设置，后续即使修改Accessor的上下文，单例类中保存的引用还是空的。

解决办法：

1. 将依赖类的生命周期改为Scoped或Transient，确保每次获取实例时都能拿到最新的HttpContext：

// 在Program/Startup中注册
services.AddScoped<IMyDependency, MyDependency>();

2. 或者在依赖类中不要在构造函数中直接使用HttpContext，而是在方法执行时实时从Accessor获取：

public class MyDependency : IMyDependency
{
    private readonly IHttpContextAccessor _accessor;

    public MyDependency(IHttpContextAccessor accessor)
    {
        _accessor = accessor;
    }

    public void Execute()
    {
        // 实时获取当前上下文，而非构造时保存
        var context = _accessor.HttpContext;
        // 业务逻辑
    }
}

内容的提问来源于stack exchange，提问作者Andrew Duffy