如何在C#中验证出站请求是否已发送指定请求头

你的核心问题是：MySepcificHeaderApi方法返回的NewResponse仅包含状态码，无法直接验证出站请求是否携带了目标头。以下是几种可行的解决思路：

方案1：通过Mock HttpClientFactory捕获请求 #

最可靠的方式是拦截HttpClient发送的请求，记录请求详情后再断言。可以通过自定义HttpMessageHandler实现请求捕获：

步骤1：实现捕获请求的Handler #

public class CapturingHttpMessageHandler : HttpMessageHandler
{
    // 存储被捕获的请求
    public HttpRequestMessage CapturedRequest { get; private set; }

    protected override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
    {
        // 记录发送的请求
        CapturedRequest = request;
        // 返回模拟响应，避免调用真实外部服务
        return Task.FromResult(new HttpResponseMessage(HttpStatusCode.OK));
    }
}

步骤2：编写测试代码 #

利用Moq（或其他Mock框架）让IHttpClientFactory返回带有捕获Handler的HttpClient，然后执行方法并断言捕获的请求：

// 初始化捕获Handler和Mock工厂
var capturingHandler = new CapturingHttpMessageHandler();
var httpClient = new HttpClient(capturingHandler);
var mockFactory = new Mock<IHttpClientFactory>();
mockFactory.Setup(f => f.CreateClient("Some name")).Returns(httpClient);

// 准备测试实例和请求
var myClass = new MyClass(mockFactory.Object);
var request = new HttpRequestMessage(HttpMethod.Get, "some uri");

// 执行目标方法
myClass.MySepcificHeaderApi(request);

// 断言请求头是否存在
capturingHandler.CapturedRequest.Headers.Should()
    .Contain(header => header.Key.Equals("X-Specific-Header", StringComparison.OrdinalIgnoreCase));

方案2：直接断言传入的HttpRequestMessage（需调整可测试性） #

如果OnSomeCondition()方法可以被Mock（比如是虚方法或接口成员），可以直接验证传入的request是否被添加了头：

步骤1：确保OnSomeCondition可Mock #

修改MyClass，让OnSomeCondition成为虚方法：

public class MyClass
{
    private readonly IHttpClientFactory _httpClientFactory;

    public MyClass(IHttpClientFactory httpClientFactory)
    {
        _httpClientFactory = httpClientFactory;
    }

    // 改为虚方法，方便测试时Mock返回值
    protected virtual bool OnSomeCondition()
    {
        // 原有逻辑
    }

    public NewResponse MySepcificHeaderApi(HttpRequestMessage request)
    {
        if (OnSomeCondition())
        {
            request.Headers.TryAddWithoutValidation("X-Specific-Header", "some values");
        }    
        var httpClient = _httpClientFactory.CreateHttpClient("Some name");
        var response = httpClient.SendAsync(request).GetAwaiter().GetResult();
        return new NewResponse(response.StatusCode); 
    }
}

步骤2：编写测试代码 #

MockOnSomeCondition()返回true，执行方法后直接断言传入的request的头：

// Mock MyClass，让OnSomeCondition返回true
var myClassMock = new Mock<MyClass>(MockBehavior.Loose, new Mock<IHttpClientFactory>().Object);
myClassMock.CallBase = true;
myClassMock.Setup(m => m.OnSomeCondition()).Returns(true);

// 准备请求
var request = new HttpRequestMessage(HttpMethod.Get, "some uri");

// 执行方法
myClassMock.Object.MySepcificHeaderApi(request);

// 断言请求头已添加
request.Headers.Should().Contain("X-Specific-Header");

方案3：修改方法返回值（不推荐，除非必要） #

如果允许调整业务方法的返回结构，可以让NewResponse包含请求头信息，或者新增一个输出参数传递请求详情。但这种方式会污染业务代码，仅在其他方案不可行时考虑。

内容的提问来源于stack exchange，提问作者Shankar S