用途
ASP.NET Core 技能用于指导 VanDaemon 后端的 Web API 开发,覆盖 REST API、SignalR hub 与 ASP.NET Core Web API 应用的构建。文档明确该项目使用 .NET 10,并采用瘦控制器架构:控制器负责委托,业务逻辑不放在控制器中。
主要能力与核心约定
- 瘦控制器:控制器立即把工作委托给服务,例如
return Ok(await _service.GetAsync(ct))。 - 依赖注入注册:以单例方式注册服务,例如
builder.Services.AddSingleton<ITankService, TankService>();、builder.Services.AddSingleton<IControlService, ControlService>();、builder.Services.AddSingleton<JsonFileStore>();。 - SignalR:通过
builder.Services.AddSignalR();注册,并在app.Build()之后用app.MapHub<TelemetryHub>("/hubs/telemetry");映射 hub。 - 异步规范:所有异步端点接受
CancellationToken,方法签名形如Task<T> Method(CancellationToken ct)。 - 返回类型:使用
ActionResult作为强类型响应返回,例如ActionResult<List<Tank>>。 - 后台服务:继承
BackgroundService,如TelemetryBackgroundService。 - 健康检查:映射
/health端点,例如app.MapGet("/health", ...)。
使用方式(文档示例要点)
最小控制器示例以 TanksController 为例:类上标注 [ApiController] 与 [Route("api/[controller]")],继承 ControllerBase,构造函数注入 ITankService;[HttpGet] 的 GetAll 调用 _tankService.GetAllTanksAsync(ct) 后返回 Ok(tanks);[HttpPost("{id}/state")] 的 SetState 调用 _tankService.UpdateTankAsync(id, state, ct) 后返回 NoContent()。
带作用域的后台服务示例中,TelemetryBackgroundService 持有 IServiceProvider,在 ExecuteAsync(CancellationToken ct) 循环中使用 _provider.CreateScope() 创建作用域,取出 ITankService 并调用 RefreshAllAsync(ct),随后 await Task.Delay(TimeSpan.FromSeconds(5), ct)。
健康端点示例返回 Results.Ok(new { status = "healthy", timestamp = DateTime.UtcNow })。
适用场景
适用于需要按照 VanDaemon 项目约定构建 ASP.NET Core Web API、SignalR 实时更新、后台轮询服务与健康检查端点的后端开发工作。
限制与注意事项
文档列出常见反模式:控制器内写业务逻辑、缺少 CancellationToken、异步上下文中的阻塞调用、服务生命周期使用错误。相关技能包括 csharp(语言与 async/await 模式)、signalr(实时 hub 实现)、serilog(结构化日志)、docker(容器化部署)、xunit(控制器测试)。关于许可证、价格、安装命令等事实,资料暂未提供。