.NET中如何注入带证书的参数化构造函数HttpClient实例

问题背景 #

我定义了如下通用HttpClient契约：

public interface IHttpClient
{
    public Task<T> GetData<T>(string url);
    public Task<T> PutData<T>(T data);
    public Task<T> PostData<T>(T data);
}

该契约由HttpRestClient类实现，包含三个构造函数（省略实现细节）：

public class HttpRestClient : IHttpClient
{
    private readonly HttpClient _httpClient;

    public HttpRestClient()
    {
        this._httpClient = new HttpClient();
    }
    public HttpRestClient(string url)
    {
        this._httpClient = new HttpClient();
        _httpClient.BaseAddress = new Uri(url);
    }

    public HttpRestClient(string certName, HttpClientHandler handler)
    {
        var cert = GetMyCert(certName);
        handler.ClientCertificates.Add(cert);
        this._httpClient = new HttpClient(handler);
    }

    public Task<T> GetData<T>(string url) ...

    public Task<T> PostData<T>(T data) ...

    public Task<T> PutData<T>(T data) ...
}

已在Program.cs中注册服务：builder.Services.AddScoped<IHttpClient, HttpRestClient>();，当前应用中多数类使用默认构造函数创建的HttpRestClient实例。

当前问题 #

我需要在MyClient类中使用通过public HttpRestClient(string certName, HttpClientHandler handler)构造函数创建的实例，最初的实现是在MyClient构造函数中直接实例化：

public class MyClient : IMyClient
{
    private readonly IAddressService addressService;
    private readonly ILocationService locationService;
    private readonly ILogger logger;
    private readonly IHttpClient httpclient;
    public MyClient(IAddressService addressService,
        ILocationService locationService,
        ILogger logger)
    {
        this.addressService = addressService;
        this.locationService = locationService;
        this.logger = logger;
        httpclient = new HttpRestClient("MyCertName", new HttpClientHandler());
    }

    public Task<string> SendAsync(string url)
    {
        //Some Validation Logic
        var data = this.httpclient.GetData(url);
        //do some modififcation
        this.httpclient.PostData<string>(url);
    }
}

但这种方式导致MyClient难以进行单元测试。我知道应该通过依赖注入传入IHttpClient接口实例，但不清楚如何让运行时为MyClient注入该带证书的实例，同时其他类仍使用默认的HttpClient实例？是否需要修改Program.cs中的服务注册？如何实现并支持单元测试？

1. 修改服务注册，区分实例 #

在Program.cs中，保留默认无证书的IHttpClient注册，同时新增带证书的实例注册，用命名服务（.NET 8+支持）或直接为MyClient单独配置注入逻辑：

方式一：.NET 8+ 用KeyedService（推荐）

// 保留默认无证书实例，供多数类使用
builder.Services.AddScoped<IHttpClient, HttpRestClient>();

// 注册带证书的命名实例，标记为"CertHttpClient"
builder.Services.AddKeyedScoped<IHttpClient>("CertHttpClient", (sp, key) => 
{
    var handler = new HttpClientHandler();
    return new HttpRestClient("MyCertName", handler);
});

方式二：兼容低版本.NET，直接为MyClient配置注入

// 保留默认无证书实例
builder.Services.AddScoped<IHttpClient, HttpRestClient>();

// 直接为IMyClient注册时，注入带证书的IHttpClient
builder.Services.AddScoped<IMyClient>(sp => 
{
    var addressService = sp.GetRequiredService<IAddressService>();
    var locationService = sp.GetRequiredService<ILocationService>();
    var logger = sp.GetRequiredService<ILogger<MyClient>>();
    // 创建带证书的HttpRestClient实例
    var certHttpClient = new HttpRestClient("MyCertName", new HttpClientHandler());
    return new MyClient(addressService, locationService, logger, certHttpClient);
});

2. 修改MyClient构造函数，注入指定实例 #

如果用方式一的KeyedService，修改MyClient构造函数，通过[FromKeyedServices]属性指定注入带证书的实例：

public class MyClient : IMyClient
{
    private readonly IAddressService addressService;
    private readonly ILocationService locationService;
    private readonly ILogger logger;
    private readonly IHttpClient httpclient;

    // 注入带证书的IHttpClient实例
    public MyClient(IAddressService addressService,
        ILocationService locationService,
        ILogger logger,
        [FromKeyedServices("CertHttpClient")] IHttpClient httpclient)
    {
        this.addressService = addressService;
        this.locationService = locationService;
        this.logger = logger;
        this.httpclient = httpclient;
    }

    public async Task<string> SendAsync(string url)
    {
        //Some Validation Logic
        var data = await this.httpclient.GetData<string>(url);
        //do some modififcation
        await this.httpclient.PostData<string>(data);
        return data;
    }
}

3. 单元测试实现 #

现在MyClient的IHttpClient是构造注入的，单元测试时可以直接MockIHttpClient接口，完全不需要依赖真实的证书或网络请求：

// xUnit + Moq的测试示例
public class MyClientTests
{
    [Fact]
    public async Task SendAsync_ShouldCallGetAndPost()
    {
        // 准备Mock对象
        var mockHttpClient = new Mock<IHttpClient>();
        mockHttpClient.Setup(x => x.GetData<string>(It.IsAny<string>()))
                      .ReturnsAsync("test-response-data");
        mockHttpClient.Setup(x => x.PostData<string>(It.IsAny<string>()))
                      .ReturnsAsync("posted-success");

        var mockAddressService = new Mock<IAddressService>();
        var mockLocationService = new Mock<ILocationService>();
        var mockLogger = new Mock<ILogger<MyClient>>();

        // 实例化MyClient
        var myClient = new MyClient(mockAddressService.Object, 
                                   mockLocationService.Object, 
                                   mockLogger.Object, 
                                   mockHttpClient.Object);

        // 执行测试方法
        var result = await myClient.SendAsync("test-url");

        // 验证调用逻辑
        mockHttpClient.Verify(x => x.GetData<string>("test-url"), Times.Once);
        mockHttpClient.Verify(x => x.PostData<string>("test-response-data"), Times.Once);
        Assert.Equal("test-response-data", result);
    }
}

额外优化建议 #

• 不要手动创建HttpClientHandler，可以把它注册为DI服务，方便统一配置超时、代理等逻辑。
• 把证书获取逻辑GetMyCert封装成ICertificateProvider服务，注入到HttpRestClient中，进一步解耦，测试时可以Mock证书获取逻辑。

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