自托管场景下xUnit测试中RemoteIpAddress始终为空的问题

我来帮你解决这个问题——当用xUnit和TestServer做集成测试时，RemoteIpAddress总是null的原因很简单：TestServer是在内存里模拟HTTP请求的，没有真实的TCP连接，所以默认不会设置这个属性。下面给你几种解决办法，从快速修复到更优雅的架构调整都有：

方法一：在测试环境中添加中间件设置默认IP #

你可以在TestStartup的Configure方法里加个中间件，专门给测试请求设置RemoteIpAddress，只在测试环境生效：

先修改TestStartup的Configure：

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
    if (env.IsDevelopment() || env.IsEnvironment("Testing"))
    {
        app.UseDeveloperExceptionPage();
        // 测试环境下给每个请求设置一个默认IP
        app.Use(async (context, next) =>
        {
            context.Connection.RemoteIpAddress = IPAddress.Parse("127.0.0.1");
            await next();
        });
    }
    app.UseMvc();
}

然后修改GetClient方法，指定测试环境：

public static HttpClient GetClient()
{
    var server = new TestServer(new WebHostBuilder()
        .UseEnvironment("Testing") // 指定测试环境
        .UseStartup<TestStartup>());
    var client = server.CreateClient();
    client.DefaultRequestHeaders
        .Accept
        .Add(new System.Net.Http.Headers.MediaTypeWithQualityHeaderValue("application/json"));
    return client;
}

这样你的GetIpAddress函数就能拿到127.0.0.1了，不用改业务代码。

方法二：在单个测试中手动设置IP #

如果只想给特定测试设置IP，可以用TestServer的CreateRequest方法，直接操作HttpContext：

修改你的测试方法：

[Theory]
[MemberData(nameof(TestDataHandler.LogData), MemberType = typeof(TestDataHandler))]
public async Task TestGet(string args, bool expected) 
{
    var server = new TestServer(new WebHostBuilder().UseStartup<TestStartup>());
    
    var response = await server.CreateRequest("http://localhost/api/Log")
        // 这里直接设置RemoteIpAddress
        .And(context => context.Connection.RemoteIpAddress = IPAddress.Parse("192.168.1.1"))
        .WithHeader("Accept", "application/json")
        .WithContent(new StringContent(args, Encoding.UTF8, "application/json"))
        .GetAsync();
    
    var data = await response.Content.ReadAsStringAsync();
    var result = Newtonsoft.Json.JsonConvert.DeserializeAnonymousType(data, new { success = false });
    Assert.Equal(result.success, expected);
}

这种方式适合需要给不同测试用例设置不同IP的场景。

方法三：重构代码，用依赖注入解耦IP获取（推荐） #

上面两种都是临时修复，更优雅的方式是把获取IP的逻辑抽象成服务，这样测试时可以轻松模拟，不用依赖HttpContext：

1. 先定义一个IP获取的接口：

public interface IIpAddressProvider
{
    string GetIpAddress();
}

2. 实现生产环境的版本：

public class HttpContextIpAddressProvider : IIpAddressProvider
{
    private readonly IHttpContextAccessor _httpContextAccessor;

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

    public string GetIpAddress()
    {
        try
        {
            var remoteIp = _httpContextAccessor.HttpContext?.Connection.RemoteIpAddress;
            return remoteIp?.ToString() ?? "unknown";
        }
        catch (Exception ex)
        {
            DataLink.ProcessError(ex, "Error getting IP address");
            return "error";
        }
    }
}

3. 在Startup里注册这个服务：

// ConfigureServices方法中添加
services.AddScoped<IIpAddressProvider, HttpContextIpAddressProvider>();

4. 在控制器中注入这个服务，代替原来的GetIpAddress函数：

public class LogController : ControllerBase
{
    private readonly IIpAddressProvider _ipAddressProvider;

    public LogController(IIpAddressProvider ipAddressProvider)
    {
        _ipAddressProvider = ipAddressProvider;
    }

    [HttpGet("api/Log")]
    public IActionResult GetLog(string args)
    {
        var ip = _ipAddressProvider.GetIpAddress();
        // 你的业务逻辑
        return Ok(new { success = true });
    }
}

5. 测试时，在TestStartup里替换成模拟服务：

public void ConfigureServices(IServiceCollection services)
{
    ApmCore.Startup.Connection = Configuration.GetConnectionString("DefaultConnection");
    services.AddSingleton<IHttpContextAccessor, HttpContextAccessor>();
    services.AddMemoryCache();
    services.AddMvc();
    // 替换为模拟的IP服务，返回你想要的测试IP
    services.AddScoped<IIpAddressProvider>(_ => new MockIpAddressProvider("192.168.1.1"));
}

// 模拟的IP服务类
public class MockIpAddressProvider : IIpAddressProvider
{
    private readonly string _ipAddress;

    public MockIpAddressProvider(string ipAddress)
    {
        _ipAddress = ipAddress;
    }

    public string GetIpAddress()
    {
        return _ipAddress;
    }
}

这种方式不仅解决了测试问题，还让代码更易维护、更符合SOLID原则，以后要修改IP获取逻辑也不用到处改代码。

内容的提问来源于stack exchange，提问作者John Hughes