如何在AspNetCore.HealthChecks.Uris中复用带认证的HttpClient？

复用已配置的命名HttpClient #

完全可以复用你已经配置好的带客户端凭证的HttpClient，AspNetCore.HealthChecks.Uris提供了直接指定HttpClient名称的方式，让健康检查请求自动使用该客户端的认证配置。

只需要在添加Url健康检查时，通过配置项指定已注册的HttpClient名称即可：

services.AddHealthChecks()
    .AddUrlHealthCheck(options =>
    {
        // 添加目标API的健康检查端点
        options.AddTargetUri(new Uri("https://你的目标API地址/health"));
        // 指定复用已注册的命名HttpClient
        options.HttpClientName = "someName";
    }, name: "authenticated-api-health-check");

因为你之前通过AddClientCredentialsHttpClient("someName")注册的HttpClient已经自动处理了Client Credentials模式的Token获取和刷新，所以健康检查请求会自动携带合法的认证头，无需额外处理。

其他实现方式 #

如果不想复用现有HttpClient，也可以通过以下方式实现带认证的健康检查：

1. 手动配置认证请求头 #

直接在健康检查的HttpClient配置中添加Authorization头，需要自行处理Token的获取、缓存和刷新：

services.AddHealthChecks()
    .AddUrlHealthCheck(options =>
    {
        options.AddTargetUri(new Uri("https://你的目标API地址/health"));
        options.ConfigureHttpClient = async client =>
        {
            // 实现Client Credentials模式的Token获取逻辑
            var tokenClient = new HttpClient();
            var tokenRequest = new HttpRequestMessage(HttpMethod.Post, "someUrl")
            {
                Content = new FormUrlEncodedContent(new Dictionary<string, string>
                {
                    ["grant_type"] = "client_credentials",
                    ["client_id"] = "someId",
                    ["client_secret"] = "someSecret",
                    ["scope"] = "someScope"
                })
            };

            var tokenResponse = await tokenClient.SendAsync(tokenRequest);
            tokenResponse.EnsureSuccessStatusCode();
            var tokenData = await tokenResponse.Content.ReadFromJsonAsync<TokenResponse>(); // 需自定义TokenResponse类

            client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", tokenData.AccessToken);
        };
    }, name: "manual-auth-api-health-check");

注意：这种方式需要自行处理Token缓存和过期刷新，否则每次健康检查都会请求Token，效率较低。

2. 自定义健康检查 #

实现IHealthCheck接口，编写完全自定义的健康检查逻辑，直接注入IHttpClientFactory获取已配置的HttpClient：

// 自定义健康检查类
public class AuthenticatedApiHealthCheck : IHealthCheck
{
    private readonly IHttpClientFactory _httpClientFactory;

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

    public async Task<HealthCheckResult> CheckHealthAsync(HealthCheckContext context, CancellationToken cancellationToken = default)
    {
        var client = _httpClientFactory.CreateClient("someName");
        try
        {
            var response = await client.GetAsync("/health", cancellationToken);
            response.EnsureSuccessStatusCode();
            return HealthCheckResult.Healthy("目标API健康状态正常");
        }
        catch (HttpRequestException ex)
        {
            return HealthCheckResult.Unhealthy($"目标API请求失败：{ex.Message}", ex);
        }
        catch (Exception ex)
        {
            return HealthCheckResult.Degraded($"健康检查过程中出现异常：{ex.Message}", ex);
        }
    }
}

// 注册自定义健康检查
services.AddHealthChecks()
    .AddCheck<AuthenticatedApiHealthCheck>("custom-authenticated-api-health");

这种方式灵活性最高，你可以根据需求添加超时控制、重试逻辑、自定义健康状态判断等。

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