如何在C# WebAPI中实现Vendor API响应流实时转发给客户端？

我对接了一个会返回大量JSON数据的Vendor REST API，不允许客户直接访问该API，因此自研了C# WebAPI接收客户请求，携带必要凭证调用Vendor API。我们不对Vendor API返回的数据做任何处理，希望在开始接收Vendor API的响应流时，就立即将该流转发给客户端，无需等待流关闭，以此获得显著性能提升并大幅降低扩容成本。当前实现代码如下，请问如何达成这一需求？

[HttpGet]
public async Task<IActionResult> Get([FromQuery]SearchQuery queryParam)
{
    string apiKey = _configuration.GetValue<string>("VendorAPIKey");
    string restUrl = "https://vendorresturl.com/api/search?kajhfjhsdf";
    var hclient = new HttpClient();
    hclient.DefaultRequestHeaders.Add("api-key", apiKey);
    var responseMessage = await hclient.GetAsync(restUrl.ToString());
    var c = new ContentResult();
    c.ContentType = "application/json";
    c.Content = await responseMessage.Content.ReadAsStringAsync();
    return c;
}

这个场景我之前处理大体积API响应时遇到过，流式转发确实能极大降低服务器内存占用，同时让客户端更快开始接收数据。你的当前实现有两个核心问题：一是每次请求新建HttpClient会导致套接字资源耗尽，二是ReadAsStringAsync会把整个响应加载到内存后才返回，完全无法实现流式传输。下面是优化后的完整方案：

1. 优化HttpClient的使用（最佳实践） #

不要每次请求都新建HttpClient，ASP.NET Core推荐使用IHttpClientFactory来管理HttpClient实例，避免套接字泄漏。在你的Program.cs（.NET 6+）或者Startup.cs中注册Vendor API的HttpClient：

// .NET 6+ Program.cs示例
builder.Services.AddHttpClient("VendorApiClient", client =>
{
    client.BaseAddress = new Uri("https://vendorresturl.com/api/");
    // 预先配置API密钥，不用每次请求都添加
    client.DefaultRequestHeaders.Add("api-key", builder.Configuration["VendorAPIKey"]);
});

2. 修改Controller实现流式转发 #

利用HttpCompletionOption.ResponseHeadersRead让HttpClient在收到响应头后就开始读取流，再通过FileStreamResult直接把流转发给客户端，全程不会把完整响应加载到内存：

private readonly IHttpClientFactory _httpClientFactory;

// 通过构造函数注入IHttpClientFactory
public YourControllerName(IHttpClientFactory httpClientFactory)
{
    _httpClientFactory = httpClientFactory;
}

[HttpGet]
public async Task<IActionResult> Get([FromQuery]SearchQuery queryParam)
{
    var client = _httpClientFactory.CreateClient("VendorApiClient");
    
    // 动态拼接查询参数（替换成你实际的参数拼接逻辑）
    var queryString = new QueryString();
    // 示例：把SearchQuery的属性拼接成查询参数
    if (!string.IsNullOrEmpty(queryParam.Keyword))
        queryString = queryString.Add("keyword", queryParam.Keyword);
    // 更多参数拼接...
    
    var restUrl = $"search{queryString}";

    // 关键：使用ResponseHeadersRead，收到响应头就返回，不等完整响应体下载
    var responseMessage = await client.GetAsync(restUrl, HttpCompletionOption.ResponseHeadersRead);
    
    // 确保Vendor API返回成功，失败时抛出异常（你也可以自定义返回对应错误码给客户端）
    responseMessage.EnsureSuccessStatusCode();

    // 获取Vendor API的响应流
    var responseStream = await responseMessage.Content.ReadAsStreamAsync();

    // 直接返回流给客户端，自动实现边接收边转发
    return new FileStreamResult(
        responseStream, 
        responseMessage.Content.Headers.ContentType?.MediaType ?? "application/json"
    );
}

关键细节说明 #

• HttpCompletionOption.ResponseHeadersRead：这是实现流式的核心，它告诉HttpClient不需要等待整个响应体下载完成，只要拿到响应头就可以开始处理流，这样我们能立即把流转发给客户端。
• FileStreamResult：ASP.NET Core会自动处理流的传输，把Vendor API的响应流直接写入到客户端的响应流中，全程不会在服务器内存中缓存完整响应。
• 传递Content-Type：直接复用Vendor API返回的Content-Type，确保客户端能正确解析响应。
• 错误处理：使用EnsureSuccessStatusCode可以在Vendor API返回错误时抛出异常，你也可以根据需求捕获异常，把相同的错误状态码返回给客户端，保持错误信息的一致性。

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