0

0

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

幻夢星雲

幻夢星雲

发布时间:2025-10-02 15:24:02

|

947人浏览过

|

来源于php中文网

原创

答案是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 CheckHealthAsync(
        HealthCheckContext context, 
        CancellationToken cancellationToken = default)
    {
        // 模拟检查逻辑
        var isHealthy = await SomeService.IsAvailable(cancellationToken);
    if (isHealthy)
    {
        return HealthCheckResult.Healthy("服务运行正常");
    }

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

}

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

Program.csStartup.cs 中添加健康检查服务并配置中间件:

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

示例:

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddHealthChecks() .AddCheck("custom_check") .AddSqlServer(builder.Configuration.GetConnectionString("DefaultConnection"));

var app = builder.Build();

AI帮个忙
AI帮个忙

多功能AI小工具,帮你快速生成周报、日报、邮、简历等

下载

app.UseHealthChecks("/health");

app.Run();

健康检查的返回状态说明

健康检查结果分为三种状态:

  • Healthy:所有检查通过,HTTP 返回 200
  • Unhealthy:关键服务异常,HTTP 返回 503
  • Degraded:部分非关键服务有问题,但仍可工作,HTTP 返回 200(可配置)

这些状态帮助监控系统判断应用是否需要告警或重启。

基本上就这些。通过组合多个检查项,可以构建出适合生产环境的健康监测机制。

相关专题

更多
什么是中间件
什么是中间件

中间件是一种软件组件,充当不兼容组件之间的桥梁,提供额外服务,例如集成异构系统、提供常用服务、提高应用程序性能,以及简化应用程序开发。想了解更多中间件的相关内容,可以阅读本专题下面的文章。

175

2024.05.11

Golang 中间件开发与微服务架构
Golang 中间件开发与微服务架构

本专题系统讲解 Golang 在微服务架构中的中间件开发,包括日志处理、限流与熔断、认证与授权、服务监控、API 网关设计等常见中间件功能的实现。通过实战项目,帮助开发者理解如何使用 Go 编写高效、可扩展的中间件组件,并在微服务环境中进行灵活部署与管理。

146

2025.12.18

硬盘接口类型介绍
硬盘接口类型介绍

硬盘接口类型有IDE、SATA、SCSI、Fibre Channel、USB、eSATA、mSATA、PCIe等等。详细介绍:1、IDE接口是一种并行接口,主要用于连接硬盘和光驱等设备,它主要有两种类型:ATA和ATAPI,IDE接口已经逐渐被SATA接口;2、SATA接口是一种串行接口,相较于IDE接口,它具有更高的传输速度、更低的功耗和更小的体积;3、SCSI接口等等。

980

2023.10.19

PHP接口编写教程
PHP接口编写教程

本专题整合了PHP接口编写教程,阅读专题下面的文章了解更多详细内容。

39

2025.10.17

sqlserver和mysql区别
sqlserver和mysql区别

SQL Server和MySQL是两种广泛使用的关系型数据库管理系统。它们具有相似的功能和用途,但在某些方面存在一些显著的区别。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

522

2023.08.11

数据库三范式
数据库三范式

数据库三范式是一种设计规范,用于规范化关系型数据库中的数据结构,它通过消除冗余数据、提高数据库性能和数据一致性,提供了一种有效的数据库设计方法。本专题提供数据库三范式相关的文章、下载和课程。

326

2023.06.29

如何删除数据库
如何删除数据库

删除数据库是指在MySQL中完全移除一个数据库及其所包含的所有数据和结构,作用包括:1、释放存储空间;2、确保数据的安全性;3、提高数据库的整体性能,加速查询和操作的执行速度。尽管删除数据库具有一些好处,但在执行任何删除操作之前,务必谨慎操作,并备份重要的数据。删除数据库将永久性地删除所有相关数据和结构,无法回滚。

2066

2023.08.14

vb怎么连接数据库
vb怎么连接数据库

在VB中,连接数据库通常使用ADO(ActiveX 数据对象)或 DAO(Data Access Objects)这两个技术来实现:1、引入ADO库;2、创建ADO连接对象;3、配置连接字符串;4、打开连接;5、执行SQL语句;6、处理查询结果;7、关闭连接即可。

346

2023.08.31

虚拟号码教程汇总
虚拟号码教程汇总

本专题整合了虚拟号码接收验证码相关教程,阅读下面的文章了解更多详细操作。

25

2025.12.25

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Java 教程
Java 教程

共578课时 | 37.6万人学习

国外Web开发全栈课程全集
国外Web开发全栈课程全集

共12课时 | 0.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号