SuperAPI AI 工具集

background-services

编程与开发

查看项目

更新于 10-16 02:13

技能介绍

用途

本技能面向 ASP.NET Core 应用中的后台处理场景,用于把工作从请求管线中卸载、处理队列以及执行定时任务。资料指出,后台服务对于卸载请求管线工作、处理队列和处理计划任务至关重要;实现不当可能导致数据丢失、孤立作业和资源泄漏。这些模式旨在保证生产应用中后台处理可靠、可观测并能优雅降级。

主要能力与模式

BackgroundService 与 IHostedService 的选择

资料以对比表列出两者差异:

  • 用途:BackgroundService 用于长时间运行的循环或持续工作;IHostedService 用于启动/关闭钩子。
  • 方法:BackgroundService 重写 ExecuteAsync;IHostedService 实现 StartAsync 与 StopAsync。
  • 生命周期:BackgroundService 运行至取消或宿主关闭;IHostedService 的 StartAsync 在启动时运行,StopAsync 在关闭时运行。
  • 适用场景:轮询队列、处理流、周期作业适合 BackgroundService;数据库迁移、缓存预热、资源清理适合 IHostedService。

模式 1:基础 BackgroundService 结构

使用 BackgroundService 基类获得一致的生命周期管理与取消支持。示例 OrderProcessorWorker 在 ExecuteAsync 中循环,通过 IServiceScopeFactory 创建作用域并解析 IOrderProcessor,调用 ProcessPendingAsync;当处理数量为 0 时用 Task.Delay(5 秒, stoppingToken) 退避;捕获取消异常时跳出循环,捕获其他异常时记录日志并延迟 30 秒。注册方式为 builder.Services.AddHostedService<OrderProcessorWorker>();。

资料强调 BackgroundService 的关键规则:始终创建作用域(应注入 IServiceScopeFactory,而非直接注入 scoped 服务,因为 BackgroundService 注册为单例);始终处理异常(ExecuteAsync 中未处理的异常默认会停止宿主,需用 try/catch 包裹循环体);始终尊重停止令牌(检查 stoppingToken.IsCancellationRequested 并把令牌传给所有异步调用);在无任务或出错时退避(避免空转浪费 CPU,使用带停止令牌的 Task.Delay)。

模式 2:IHostedService 启动/关闭钩子

资料给出两类示例:一是启动钩子,如 CacheWarmupService 在 StartAsync 中创建作用域解析 IProductCache 并调用 WarmAsync,StopAsync 直接返回 Task.CompletedTask,用于缓存预热、迁移;二是启动加关闭的资源生命周期管理,如 MessageBusService 在 StartAsync 创建连接,在 StopAsync 中关闭连接并置空,用于消息总线连接等资源。

模式 3:托管服务生命周期

启动顺序:按注册顺序对每个注册服务调用 IHostedService.StartAsync;StartAsync 完成后调用 BackgroundService.ExecuteAsync(并发运行,宿主不等待其完成);所有 StartAsync 完成后宿主才可开始服务请求。重要提示:ExecuteAsync 在把控制权交还调用方之前不能阻塞,ExecuteAsync 中的第一个 await 才是控制权返回宿主的位置。示例 MyWorker 重写 StartAsync 先 InitializeAsync 再调用 base.StartAsync。

关闭顺序:触发 IHostApplicationLifetime.ApplicationStopping;宿主按注册逆序对每个托管服务调用 StopAsync;对 BackgroundService,先取消停止令牌,然后 StopAsync 等待 ExecuteAsync 完成;最后触发 ApplicationStopped。

模式 4:发件箱模式实现可靠消息

通过在异步处理前把消息事务性地存入数据库,确保消息不丢失。资料定义 OutboxMessage(含 Id、Type、Payload、CreatedAt、ProcessedAt、Error、RetryCount)与 IOutboxRepository(AddAsync、GetPendingAsync、MarkProcessedAsync、MarkFailedAsync)。OrderService.CreateOrderAsync 示例在数据库事务中同时添加订单与发件箱消息,然后提交。OutboxProcessor 作为 BackgroundService 循环:创建异步作用域,读取待处理消息(批量 10),逐条发布,成功则标记已处理,失败则记录错误并标记失败;每轮延迟 10 秒,顶层异常时延迟 30 秒。

模式 5:优雅关闭处理

示例 GracefulWorker 使用 IHostApplicationLifetime 的 ApplicationStopping.Register 记录关闭并排空工作通道,通过 Channel<WorkItem> 的 ReadAllAsync(stoppingToken) 消费工作项,并演示 ProcessWorkItemAsync 中使用 Activity 与日志。资料还给出 IHostedLifecycleService 的细粒度实现 LifecycleAwareService,包含 StartingAsync、StartAsync、StartedAsync、StoppingAsync、StopAsync、StoppedAsync 六个阶段并各自记录日志。宿主关闭超时可配置:builder.Services.Configure<HostOptions>(options => { options.ShutdownTimeout = TimeSpan.FromSeconds(60); });。

模式 6:Channel 集成

BackgroundTaskQueue 使用有界 Channel(容量 100,FullMode = BoundedChannelFullMode.Wait)暴露 Writer 与 Reader。QueueProcessorWorker 通过 WaitToReadAsync 与 TryRead 消费工作项,为每项创建作用域并执行,异常时记录日志。注册为 AddSingleton<BackgroundTaskQueue>() 与 AddHostedService<QueueProcessorWorker>()。

模式 7:基于 Cron 表达式的计划作业

使用 NCrontab 实现可靠的 cron 调度,无需外部依赖。ScheduledJobService 通过 CrontabSchedule.Parse("0 2 * * *") 与 GetNextOccurrence 计算下次运行时间,到达时执行作业(示例中创建异步作用域解析 IDailyReportService 并生成日报),随后重新计算下次运行并延迟等待。

模式 8:PeriodicTimer 周期执行

资料建议使用 PeriodicTimer 而非 Task.Delay 以获得更准确的周期执行,示例 HealthCheckReporter 使用每分钟的 PeriodicTimer 循环。

适用场景与限制

适用场景包括:从请求管线卸载工作、轮询与处理队列、定时任务、数据库迁移与缓存预热、资源清理、需要事务性保证的消息发布等 ASP.NET Core 后台处理场景。

限制与注意事项(资料明确给出):BackgroundService 为单例,直接注入 scoped 服务会导致问题,必须使用作用域工厂;ExecuteAsync 中未处理异常默认会停止宿主;ExecuteAsync 在第一个 await 前不应阻塞,否则会延迟宿主启动;应通过停止令牌与退避避免 CPU 空转;优雅关闭需要在 HostOptions.ShutdownTimeout 内完成,否则可能无法排空。

其他信息(如具体框架版本要求、包版本、收费或价格)资料暂未提供。