Earn More by Sharing What You Love
Do you create content for developers working with .NET, C#, Java, Python, or Node.js? Turn your expertise into extra income!
C# 应用程序
- 免费Azure Static Web Apps – Tim Corey解释的设置和部署
- 构建锦标赛跟踪器（C# Winform应用）– Tim Corey的见解
- C#发送电子邮件：深度剖析Tim Corey
- 简介：C# Windows窗体应用程序中的错误处理
- C# WinForms重构 — 深入分析Tim Corey
- C#保存表单数据到文件：深度剖析Tim Corey
- 通过Tim Corey（锦标赛查看器）解释WinForms数据绑定
- 构建C# WinForms仪表盘表单
- C# WinForms 错误处理与调试 — 深度剖析 Tim Corey
- 将C# WinForms锦标赛数据保存到数据库中 — 深度剖析Tim Corey
- C# WinForms锦标赛逻辑教程 — 第18课完整解析（Tim Corey）
- 通过Tim Corey（第17课）解释WinForms数据绑定
- C#接口松散耦合 — 通过Tim Corey（第16课）解释
- C# WinForms存储数据 — 通过Tim Corey（第15课）理解数据流动在Windows窗体中的应用
- C#应用程序开发：完成创建团队表单（第14课）
- C#应用程序开发：深度剖析Tim Corey的“创建团队表单第2部分”（第13课）
- 在C#中构建创建团队表单——第12课（Tim Corey）
- 深入探讨C#文本连接
- C# SQL连接教程：Dapper + SQL Server数据库解析
- C#接口：理解奖品表单接线（Tim Corey，第09课）
- C# SQL数据库：通过Tim Corey的课程深入探讨
- 与Tim Corey探索C#表单设计——引导讲解
- 构建C#类库项目 - 从Tim Corey的课程获得的见解
- 应用逻辑规划——深入了解Tim Corey的方法
- 应用界面设计原则的实践：Tim Corey的比赛追踪器UI
- 设计应用数据（第03课）——Tim Corey的深入探讨
- C#应用程序总览规划：与Tim Corey一起学习大图景
- 正确规划应用程序：Tim Corey第01课的见解
- 从头到尾创建完整的C#应用程序
- 通过Tim Corey的全屏图像查看器解释照片工具
- 在.NET 10中最小化API数据验证：Tim Corey的深度剖析
- 在ASP.NET Core / .NET 8中设置期间访问设置
- 与Tim Corey一起构建Postman Clone
- 与Tim Corey一起构建您自己的Postman Clone UI
- 构建Postman Clone：API调用的类库设计
- 通过UI更新理解HTTP动词
- 连接POST命令：Tim Corey的深度剖析
- 构建Postman Clone：添加PUT、PATCH和DELETE
- 10 分钟或更短时间内了解核心 WCF
- 10 分钟内掌握 C# 应用程序中的命令行参数
- C# 中 IDisposable 和 Using 语句如何协同工作
- 异常显示格式化 - Spectre 控制台系列
- using Velopack 快速部署和更新 C# 桌面应用程序
- 在控制台中添加表情符号 - Spectre 控制台系列
- 在控制台中添加表格 - Spectre 控制台系列
- 颜色和样式以及可重用性 - Spectre 控制台系列
- 内容面板和呼出 - Spectre 控制台系列
- 自定义等待 Spinner - Spectre 控制台系列
- 格式化 JSON 输出 - Spectre 控制台系列
- 实时进度条 - Spectre 控制台系列
- 实时状态信息和旋转器 - Spectre 控制台系列
- 在屏幕上实时修改数据 - Spectre 控制台系列
- 带分组的多选列表 - Spectre 控制台系列
- 向用户索取数据 - Spectre 控制台系列
- 从列表中选择项目 - Spectre 控制台系列
- using FIGlet 创建文字艺术 - Spectre 控制台系列
- C# Spectre.Console 入门：轻松创建漂亮的控制台应用程序--与 Tim Corey 一同学习
- C# Web API - 使用 Derek Comartin 的方法构建 API 的全貌
- Web 部署自动化 - GitHub 操作、Azure Web 应用程序和 Appsettings
- 在 Azure Functions中访问应用程序设置
- using WinForms 和 Blazor 测试 API
- 将应用程序接口部署到 VPS
- 部署到容器和 Docker Hub - 用 C# 构建示例 API 课程
- 添加减速和错误代码--用 C# 构建示例 API 课程
- 添加健康检查 - 用 C# 构建示例 API 课程
- 管理 CORS 和测试 - 用 C# 构建示例 API 课程
- C# 中的 Windows 服务介绍
- 示例数据和过滤 - 用 C# 构建示例 API
- C# 控制台应用程序简介
- using ASP.NET Core 创建 C# Web 应用程序
- 创建 C# 应用程序
添加健康检查 - 用 C# 构建示例 API 课程
Tim Corey
23m 30s
using ASP.NET Core 在 C# 中开发和测试 RESTful API 是任何现代后端开发人员的实用技能。 在"添加健康检查 - 在 C# 中构建示例 API 课程"的教程视频中，Tim Corey 通过构建具有集成健康检查功能的示例 API 进行了讲解。 这篇文章完全基于 Tim 的笔录，一步一步地解释了整个过程，涵盖了一些关键点，如 public async Task、int id、var app 和其他 HTTP 请求方法的使用。
让我们深入了解一下 Tim Corey 如何使用 Visual Studio Code 在 C# API 项目中设置健康检查。
示例 API 和健康检查简介
Tim 解释说，在学习网络开发时，示例 API 是一个强大的工具。 它允许开发人员使用 GET、POST、PUT 和 DELETE 方法以及适当的请求数据和状态代码来模拟 API 调用。 Tim 构建的 API 支持
-
带有数据模型的样本数据
-
API 请求的 RESTful 行为
-
JSON 格式的回复
-
健康检查
-
作为 Docker 容器和网络应用程序部署
安装健康检查软件包
Tim 在 Visual Studio Code 中打开项目，右键单击 "依赖关系 "管理 NuGet 软件包。 他搜索并安装了 AspNetCore.HealthChecks.UI.Client 软件包。 这使得应用程序能够支持两种类型的健康检查。
创建健康检查类
Tim 在 API 项目文件夹中添加了一个名为 HealthChecks 的新文件夹。 在这里，他创建了多个实现 IHealthCheck 接口的类，每个类代表不同的状态：健康、退化、不健康和随机。
HealthyHealthCheck.cs（健康检查）
该类使用公共 async Task<HealthCheckResult> 实现返回 HealthCheckResult.Healthy：
return Task.FromResult(HealthCheckResult.Healthy("This is a test healthy service."));Return Task.FromResult(HealthCheckResult.Healthy("This is a test healthy service."))这将模拟健康状态，有助于测试您的前端如何处理稳定的服务。
DegradedHealthCheck.cs
return Task.FromResult(HealthCheckResult.Degraded("This is a test degraded service."));Return Task.FromResult(HealthCheckResult.Degraded("This is a test degraded service."))此检查将返回降级服务响应。 这是一种模拟部分故障或性能问题的简单方法。
UnhealthyHealthCheck.cs
return Task.FromResult(HealthCheckResult.Unhealthy("This is a test unhealthy service."));Return Task.FromResult(HealthCheckResult.Unhealthy("This is a test unhealthy service."))这模拟了服务失败的情况，模拟了您期望出现 500 HTTP 状态代码或返回 NotFound() 的情况。
RandomHealthCheck.cs（随机健康检查）
该健康检查使用随机整数模拟三种状态之一：
int randomResult = Random.Shared.Next(1, 4);
return randomResult switch
{
1 => Task.FromResult(HealthCheckResult.Healthy("This is a test random service.")),
2 => Task.FromResult(HealthCheckResult.Degraded("This is a test random service.")),
3 => Task.FromResult(HealthCheckResult.Unhealthy("This is a test random service.")),
_ => Task.FromResult(HealthCheckResult.Healthy("This is a test random service."))
};Dim randomResult As Integer = Random.Shared.Next(1, 4)
Return randomResult Select Case
Case 1
Task.FromResult(HealthCheckResult.Healthy("This is a test random service."))
Case 2
Task.FromResult(HealthCheckResult.Degraded("This is a test random service."))
Case 3
Task.FromResult(HealthCheckResult.Unhealthy("This is a test random service."))
Case Else
Task.FromResult(HealthCheckResult.Healthy("This is a test random service."))
End SelectTim 强调说，这对于在不同条件下测试行为非常有用。
在启动配置中注册健康检查
Tim 在启动或配置文件夹中添加了一个新的静态类 HealthChecksConfig.cs。 该类包括两个静态方法：
添加所有健康检查()
services.AddHealthChecks()
.AddCheck<RandomHealthCheck>("random", tags: new[] { "random" })
.AddCheck<HealthyHealthCheck>("healthy", tags: new[] { "healthy" })
.AddCheck<DegradedHealthCheck>("degraded", tags: new[] { "degraded" })
.AddCheck<UnhealthyHealthCheck>("unhealthy", tags: new[] { "unhealthy" });services.AddHealthChecks() _
.AddCheck(Of RandomHealthCheck)("random", tags:=New String() {"random"}) _
.AddCheck(Of HealthyHealthCheck)("healthy", tags:=New String() {"healthy"}) _
.AddCheck(Of DegradedHealthCheck)("degraded", tags:=New String() {"degraded"}) _
.AddCheck(Of UnhealthyHealthCheck)("unhealthy", tags:=New String() {"unhealthy"})这将注册 ASP.NET Core 服务容器中依赖注入的所有健康检查。
MapAllHealthChecks()
app.MapHealthChecks("/health");app.MapHealthChecks("/health")这将创建一个单一的端点/健康状况，对所有服务进行综合评估。 如果任何一项不健康，则整个检查将返回不健康。
创建特定的健康端点
为了测试各个组件，Tim 通过标签映射每个健康检查：
app.MapHealthChecks("/health/healthy", new HealthCheckOptions {
Predicate = x => x.Tags.Contains("healthy")
});app.MapHealthChecks("/health/healthy", New HealthCheckOptions With {
.Predicate = Function(x) x.Tags.Contains("healthy")
})他对 /health/degraded、/health/unhealthy 和 /health/random 重复了这一点。 每种工具都允许开发人员测试特定行为以及前端对这些行为的反应。
访问 /health/random 时，输出会根据随机结果在 "健康"、"退化 "和 "不健康 "之间变化。
为健康检查添加 UI 支持
Tim 通过为每个健康检查路由启用 UI 响应来增强端点。 这将提供一个 JSON 输出：
app.MapHealthChecks("/healthui", new HealthCheckOptions
{
ResponseWriter = UIResponseWriter.WriteHealthCheckUIResponse
});app.MapHealthChecks("/healthui", New HealthCheckOptions With {
.ResponseWriter = AddressOf UIResponseWriter.WriteHealthCheckUIResponse
})这样就可以通过持续时间、标签和状态等数据检查每个健康检查。 然后，Tim 为每个健康终端创建 UI 版本：
-
/healthui/healthy
-
/healthui/degraded
-
/healthui/不健康
-
/healthui/随机
每份译文都会以详细的 JSON 格式作出回应，非常适合 RESTful API 以及从移动设备或网页进行测试。
包装 API 项目
Tim 强调说，即使有了这些功能，Program.cs 仍然只有 21 行。 他认为这是由于
-
良好的项目文件夹结构
-
将模型保存在 Models 文件夹中
-
将端点和控制器放在各自的文件夹中
-
为每个健康检查类使用异步任务方法
他还强调了该示例 API 在生产环境中的作用，即在部署前模拟延迟或故障。
Tim总结道："除了对 API 进行GET调用外，我们还可以对其进行更多的测试。
下一步是什么
Tim 预览了下一课，他将在下一课中添加模拟减速（如 5 秒延迟）和错误（如 return NotFound() 或 return BadRequest()），以进一步测试 API 行为。
结论
在本视频教程中，Tim Corey 有条不紊地使用 ASP.NET Core 构建了一个具有集成健康检查功能的最小 API。 主要内容包括
-
健康检查类（健康、退化、不健康、随机）
-
通过 AddHealthChecks() 进行依赖注入
-
使用 MapHealthChecks() 映射端点
-
支持结构化 JSON 响应
这种方法使验证 REST API、模拟故障以及加强开发和生产环境中的网络应用变得更加容易。
Let's Stay in Touch!
Join our newsletter, you’ll get exclusive access on article updates. We value your privacy
