您现在的位置是：亿华云 > IT科技类资讯

如何在 ASP.Net Core 中实现健康检查

亿华云2025-10-02 21:51:47【IT科技类资讯】7人已围观

简介本文转载自微信公众号「码农读书」，作者码农读书。转载本文请联系码农读书公众号。健康检查常用于判断一个应用程序能否对 request 请求进行响应，ASP.Net Core 2.2 中引入了健康检

本文转载自微信公众号「码农读书」，实现作者码农读书。健康检查转载本文请联系码农读书公众号。实现

健康检查常用于判断一个应用程序能否对 request 请求进行响应，健康检查ASP.Net Core 2.2 中引入了健康检查中间件用于报告应用程序的实现健康状态。

ASP.Net Core 中的健康检查健康检查落地做法是暴露一个可配置的 Http 端口，你可以使用健康检查去做一个最简单的实现活性检测，比如说：检查网络和系统的健康检查资源可用性，数据库资源是实现否可用，应用程序依赖的健康检查消息中间件或者 Azure cloud service 的可用性等等，这篇文章我们就来讨论如何使用这个健康检查中间件。实现

注册健康检查服务

要注册健康检查服务，健康检查需要在 Startup.ConfigureServices 下调用 AddHealthChecks 方法，实现然后使用 UseHealthChecks 将其注入到 Request Pipeline 管道中，健康检查如下代码所示：

public class Startup { // This method gets called by the runtime. Use this method to add services to the container. public void ConfigureServices(IServiceCollection services) { services.AddControllersWithViews(); services.AddHealthChecks(); } // This method gets called by the runtime. Use this method to configure the HTTP request pipeline. public void Configure(IApplicationBuilder app,实现 IWebHostEnvironment env) { app.UseHealthChecks("/health"); app.UseStaticFiles(); app.UseRouting(); app.UseEndpoints(endpoints => { endpoints.MapControllerRoute( name: "default", pattern: "{ controller=Home}/{ action=Index}/{ id?}"); }); } }

上图的 /health 就是一个可供检查此 web 是否存活的暴露端口。亿华云

其他服务的健康检查

除了web的活性检查，还可以检查诸如：SQL Server, MySQL, MongoDB, Redis, RabbitMQ, Elasticsearch, Hangfire, Kafka, Oracle, Azure Storage 等一系列服务应用的活性，每一个服务需要引用相关的 nuget 包即可，如下图所示：

然后在 ConfigureServices 中添加相关服务即可，比如下面代码的 AddSqlServer。

public void ConfigureServices(IServiceCollection services) { services.AddControllersWithViews(); services.AddHealthChecks().AddSqlServer("server=.;database=PYZ_L;Trusted_Connection=SSPI"); }

自定义健康检查

除了上面的一些开源方案，还可以自定义实现健康检查类，比如自定义方式来检测数据库或外部服务的可用性，那怎么实现呢?只需要实现系统内置的 IHealthCheck 接口并实现 CheckHealthAsync() 即可，如下代码所示：

public class MyCustomHealthCheck : IHealthCheck { public async Task<HealthCheckResult> CheckHealthAsync(HealthCheckContext context, CancellationToken cancellationToken = default(CancellationToken)) { bool canConnect = IsDBOnline(); if (canConnect) return HealthCheckResult.Healthy(); return HealthCheckResult.Unhealthy(); } }

这里的 IsDBOnline 方法用来判断当前数据库是否是运行状态，实现代码如下：

private bool IsDBOnline() { string connectionString = "server=.;database=PYZ_L;Trusted_Connection=SSPI"; try { using (SqlConnection connection = new SqlConnection(connectionString)) { if (connection.State != System.Data.ConnectionState.Open) connection.Open(); } return true; } catch (System.Exception) { return false; } }

然后在 ConfigureServices 方法中进行注入。

public void ConfigureServices(IServiceCollection services) { services.AddControllersWithViews(); services.AddHealthChecks().AddCheck<MyCustomHealthCheck>("sqlcheck"); } public void Configure(IApplicationBuilder app, IWebHostEnvironment env) { app.UseRouting().UseEndpoints(config => { config.MapHealthChecks("/health"); }); app.UseStaticFiles(); app.UseRouting(); app.UseEndpoints(endpoints => { endpoints.MapControllerRoute( name: "default", pattern: "{ controller=Home}/{ action=Index}/{ id?}"); }); }

接下来可以浏览下 /health 页面，可以看出该端口自动执行了你的 MyCustomHealthCheck 方法，如下图所示：

可视化健康检查

上面的检查策略虽然好，服务器托管但并没有一个好的可视化方案，要想实现可视化的话，还需要单独下载 Nuget 包：AspNetCore.HealthChecks.UI , HealthChecks.UI.Client 和 AspNetCore.HealthChecks.UI.InMemory.Storage，命令如下：

Install-Package AspNetCore.HealthChecks.UI Install-Package AspNetCore.HealthChecks.UI.Client Install-Package AspNetCore.HealthChecks.UI.InMemory.Storage

一旦包安装好之后，就可以在 ConfigureServices 和 Configure 方法下做如下配置。

public class Startup { // This method gets called by the runtime. Use this method to add services to the container. public void ConfigureServices(IServiceCollection services) { services.AddControllersWithViews(); services.AddHealthChecks(); services.AddHealthChecksUI().AddInMemoryStorage(); } // This method gets called by the runtime. Use this method to configure the HTTP request pipeline. public void Configure(IApplicationBuilder app, IWebHostEnvironment env) { app.UseRouting().UseEndpoints(config => { config.MapHealthChecks("/health", new HealthCheckOptions { Predicate = _ => true, ResponseWriter = UIResponseWriter.WriteHealthCheckUIResponse }); }); app.UseHealthChecksUI(); app.UseStaticFiles(); app.UseRouting(); app.UseEndpoints(endpoints => { endpoints.MapControllerRoute( name: "default", pattern: "{ controller=Home}/{ action=Index}/{ id?}"); }); } }

最后还要在 appsettings.json 中配一下 HealthChecks-UI 中的检查项，如下代码所示：

{ "Logging": { "LogLevel": { "Default": "Information", "Microsoft": "Warning", "Microsoft.Hosting.Lifetime": "Information" } }, "AllowedHosts": "*", "HealthChecks-UI": { "HealthChecks": [ { "Name": "Local", "Uri": "http://localhost:65348/health" } ], "EvaluationTimeOnSeconds": 10, "MinimumSecondsBetweenFailureNotifications": 60 } }

最后在浏览器中输入 /healthchecks-ui 看一下可视化UI 长成啥样。