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();

Video Summarization
Video Summarization

一款可以自动将长视频制作成短片的桌面软件

下载

app.UseHealthChecks("/health");

app.Run();

健康检查的返回状态说明

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

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

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

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

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

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

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

178

2024.05.11

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

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

214

2025.12.18

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

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

1079

2023.10.19

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

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

169

2025.10.17

php8.4实现接口限流的教程
php8.4实现接口限流的教程

PHP8.4本身不内置限流功能,需借助Redis(令牌桶)或Swoole(漏桶)实现;文件锁因I/O瓶颈、无跨机共享、秒级精度等缺陷不适用高并发场景。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

1394

2025.12.29

java接口相关教程
java接口相关教程

本专题整合了java接口相关内容,阅读专题下面的文章了解更多详细内容。

17

2026.01.19

sqlserver和mysql区别
sqlserver和mysql区别

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

532

2023.08.11

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

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

356

2023.06.29

Python 自然语言处理(NLP)基础与实战
Python 自然语言处理(NLP)基础与实战

本专题系统讲解 Python 在自然语言处理(NLP)领域的基础方法与实战应用,涵盖文本预处理(分词、去停用词)、词性标注、命名实体识别、关键词提取、情感分析,以及常用 NLP 库(NLTK、spaCy)的核心用法。通过真实文本案例,帮助学习者掌握 使用 Python 进行文本分析与语言数据处理的完整流程,适用于内容分析、舆情监测与智能文本应用场景。

10

2026.01.27

热门下载

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

精品课程

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

共578课时 | 52.1万人学习

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

共12课时 | 1.0万人学习

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

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