悠悠楠杉
网站页面
ASP.NETCore中的健康检查端点详解
11/13
什么是健康检查端点？
在现代微服务架构和云原生应用中，系统的稳定性与可观测性至关重要。ASP.NET Core 提供了一套内置的健康检查机制，允许开发者通过一个简单的 HTTP 端点来监控应用程序及其依赖服务（如数据库、缓存、消息队列等）的运行状态。这个用于暴露系统健康信息的接口，就是所谓的“健康检查端点”。
健康检查的核心作用是让运维系统（如 Kubernetes、Prometheus、Azure Monitor 等）定期探测应用是否正常运行。它不仅能判断应用进程是否存在，还能深入检测关键外部依赖是否可用，从而实现更精准的故障隔离与自动恢复策略。
例如，当数据库连接失败但 Web 服务器仍在运行时，一个普通的 Ping 探测可能返回成功，而真正的健康检查则会标记为“不健康”，触发重启或流量切换。
如何启用并配置健康检查？
要在 ASP.NET Core 项目中启用健康检查功能，首先需要在 Program.cs 中添加相关服务和中间件。从 .NET 6 开始，推荐使用最小 API 风格进行配置。
第一步，在 Program.cs 的服务注册部分调用 AddHealthChecks() 方法：
csharp
var builder = WebApplication.CreateBuilder(args);
// 添加健康检查服务
builder.Services.AddHealthChecks()
.AddCheck
.AddSqlServer(builder.Configuration.GetConnectionString("DefaultConnection"))
.AddRedis(builder.Configuration["Redis:Configuration"]);
上述代码不仅注册了基础健康检查服务，还添加了对 SQL Server 和 Redis 的依赖检查。这些检查会在健康端点被访问时自动执行，并汇总结果。
接下来，需要映射健康检查的路由端点。通常我们将其暴露在 /health 路径下：
csharp
var app = builder.Build();
app.MapHealthChecks("/health");
app.Run();
此时，当你访问 /health，系统会返回一个 HTTP 状态码：200 表示“健康”，503 表示“未健康”。响应体默认为空，但可通过配置返回详细信息。
自定义健康检查逻辑
除了内置的数据库、缓存等检查外，你还可以创建自定义的健康检查逻辑。实现 IHealthCheck 接口即可：
csharp
public class CustomHealthCheck : IHealthCheck
{
public Task
{
// 模拟业务逻辑检查
var isHealthy = DateTime.Now.Second % 2 == 0;
if (isHealthy)
{
return Task.FromResult(HealthCheckResult.Healthy("当前时间秒数为偶数，系统正常"));
}
return Task.FromResult(HealthCheckResult.Unhealthy("当前时间秒数为奇数，系统异常"));
}
}
然后在 AddHealthChecks() 中注册该检查类：
csharp
builder.Services.AddHealthChecks()
.AddCheck<CustomHealthCheck>("时间健康检查");
这种灵活性使得你可以检测任何业务相关的状态，比如磁盘空间、第三方 API 可达性、内部队列积压情况等。
返回详细健康信息
默认情况下，健康检查只返回状态码。若需查看各检查项的详细结果，可以启用响应编写器：
csharp
app.MapHealthChecks("/health", new HealthCheckOptions
{
ResponseWriter = async (context, report) =>
{
context.Response.ContentType = "application/json";
var result = new
{
Status = report.Status.ToString(),
Checks = report.Entries.Select(e => new
{
Component = e.Key,
Status = e.Value.Status.ToString(),
Description = e.Value.Description
}),
TotalDuration = report.TotalDuration
};
await context.Response.WriteAsJsonAsync(result);
}
});
这样访问 /health 将返回 JSON 格式的详细报告，便于调试和集成监控系统。
区分就绪与存活探针
在 Kubernetes 等编排系统中，通常区分“Liveness”（存活）和“Readiness”（就绪）探针。你可以通过不同的路径提供不同类型的健康检查：
csharp
app.MapHealthChecks("/health/liveness", new HealthCheckOptions
{
Predicate = _ => true // 所有检查都参与
});
app.MapHealthChecks("/health/readiness", new HealthCheckOptions
{
Predicate = (check) => check.Tags.Contains("ready") // 仅包含 ready 标签的检查
});
通过为 AddCheck 添加标签，可精细化控制哪些检查影响就绪状态。
健康检查虽小，却是构建高可用系统的重要一环。合理设计检查逻辑，能极大提升系统的可观测性与稳定性。
