C# 中的健康检查 API 是如何定义的？-C#.Net教程-PHP中文网

C# 中的健康检查 API 是如何定义的？

幻夢星雲

发布： 2025-10-02 15:24:02

原创

927人浏览过

答案是C#健康检查API通过Microsoft.Extensions.Diagnostics.HealthChecks实现，需定义IHealthCheck接口并注册服务。创建自定义健康检查类MyCustomHealthCheck实现CheckHealthAsync方法，根据服务状态返回Healthy或Unhealthy结果。在Program.cs中调用services.AddHealthChecks()添加检查项，支持自定义和内置检查（如SqlServer），并通过app.UseHealthChecks("/health")启用健康端点。健康状态分三种：Healthy（200）、Unhealthy（503）、Degraded（200可配置），用于监控应用状态并决定告警或重启策略。组合多个检查可构建生产级健康监测体系。

c# 中的健康检查 api 是如何定义的？

在 C# 中，健康检查 API 是通过 Microsoft.Extensions.Diagnostics.HealthChecks 命名空间提供的。它允许开发者定义应用的健康状态，并通过一个标准接口对外暴露。核心是实现 IHealthCheck 接口，并在依赖注入容器中注册健康检查服务。

定义健康检查的基本方式

要自定义一个健康检查，需要创建一个类实现 IHealthCheck 接口，重写 CheckHealthAsync 方法：

public class MyCustomHealthCheck : IHealthCheck
{
    public async Task<HealthCheckResult> CheckHealthAsync(
        HealthCheckContext context, 
        CancellationToken cancellationToken = default)
    {
        // 模拟检查逻辑
        var isHealthy = await SomeService.IsAvailable(cancellationToken);
<pre class='brush:php;toolbar:false;'>    if (isHealthy)
    {
        return HealthCheckResult.Healthy("服务运行正常");
    }

    return HealthCheckResult.Unhealthy("服务不可用");
}

登录后复制

}

在程序中注册和启用健康检查

在 Program.cs 或 Startup.cs 中添加健康检查服务并配置中间件：

调用 services.AddHealthChecks() 注册健康检查服务
使用 .AddCheck<T>() 添加自定义检查，或使用内置检查（如数据库、内存、网络等）
在请求管道中使用 app.UseHealthChecks("/health") 启用端点

示例：

var builder = WebApplication.CreateBuilder(args);
<p>builder.Services.AddHealthChecks()
.AddCheck<MyCustomHealthCheck>("custom_check")
.AddSqlServer(builder.Configuration.GetConnectionString("DefaultConnection"));</p><p>var app = builder.Build();</p>
                    <div class="aritcle_card">
                        <a class="aritcle_card_img" href="/ai/%E7%99%BE%E5%BA%A6%E6%96%87%E5%BF%83%E7%99%BE%E4%B8%AD">
                            <img src="https://img.php.cn/upload/ai_manual/000/969/633/68b6d5b124798234.png" alt="百度文心百中">
                        </a>
                        <div class="aritcle_card_info">
                            <a href="/ai/%E7%99%BE%E5%BA%A6%E6%96%87%E5%BF%83%E7%99%BE%E4%B8%AD">百度文心百中</a>
                            <p>百度大模型语义搜索体验中心</p>
                            <div class="">
                                <img src="/static/images/card_xiazai.png" alt="百度文心百中">
                                <span>22</span>
                            </div>
                        </div>
                        <a href="/ai/%E7%99%BE%E5%BA%A6%E6%96%87%E5%BF%83%E7%99%BE%E4%B8%AD" class="aritcle_card_btn">
                            <span>查看详情</span>
                            <img src="/static/images/cardxiayige-3.png" alt="百度文心百中">
                        </a>
                    </div>
                <p>app.UseHealthChecks("/health");</p><p>app.Run();</p>

登录后复制