.NET 6后台服务如何通过依赖注入添加健康检查并解耦

核心思路 #

通过扩展方法封装注册逻辑，将后台服务、健康检查及状态共享组件的注册绑定在一起，核心应用层只需调用单一扩展方法即可完成所有相关配置，无需知晓内部细节。

具体实现步骤 #

1. 创建健康状态共享类 #

用于后台服务和健康检查之间传递运行状态，避免直接依赖后台服务实例：

public class ETLHealthStatus
{
    public bool IsRunning { get; set; }
    public DateTime LastRunTime { get; set; }
}

2. 改造后台服务，注入状态类更新状态 #

在后台服务中维护健康状态，供健康检查类读取：

public class ETL : BackgroundService
{
    private readonly ETLHealthStatus _healthStatus;

    public ETL(ETLHealthStatus healthStatus)
    {
        _healthStatus = healthStatus;
    }

    protected override async Task ExecuteAsync(CancellationToken stoppingToken)
    {
        _healthStatus.IsRunning = true;
        while (!stoppingToken.IsCancellationRequested)
        {
            // 执行你的ETL业务逻辑
            _healthStatus.LastRunTime = DateTime.UtcNow;
            await Task.Delay(TimeSpan.FromMinutes(5), stoppingToken);
        }
        _healthStatus.IsRunning = false;
    }
}

3. 实现专属健康检查类 #

依赖状态类，编写健康检查逻辑：

public class ETLHealthCheck : IHealthCheck
{
    private readonly ETLHealthStatus _healthStatus;

    public ETLHealthCheck(ETLHealthStatus healthStatus)
    {
        _healthStatus = healthStatus;
    }

    public Task<HealthCheckResult> CheckHealthAsync(HealthCheckContext context, CancellationToken cancellationToken = default)
    {
        if (!_healthStatus.IsRunning)
        {
            return Task.FromResult(HealthCheckResult.Unhealthy("ETL服务未运行"));
        }

        var timeSinceLastRun = DateTime.UtcNow - _healthStatus.LastRunTime;
        if (timeSinceLastRun > TimeSpan.FromMinutes(10))
        {
            return Task.FromResult(HealthCheckResult.Degraded("ETL服务超过10分钟未执行"));
        }

        return Task.FromResult(HealthCheckResult.Healthy("ETL服务运行正常"));
    }
}

4. 封装扩展方法，统一注册逻辑 #

将后台服务、状态类、健康检查的注册逻辑封装在扩展方法中，对外暴露简洁的API：

public static class ETLServiceExtensions
{
    public static IServiceCollection AddETLService(this IServiceCollection services)
    {
        // 注册单例状态类，确保后台服务和健康检查共享同一实例
        services.AddSingleton<ETLHealthStatus>();
        // 注册后台服务
        services.AddHostedService<ETL>();
        // 注册对应的健康检查
        services.AddHealthChecks().AddCheck<ETLHealthCheck>("ETL");
        
        return services;
    }
}

5. 核心应用层简化配置 #

在Program.cs中只需调用扩展方法，无需关注健康检查的细节：

var builder = WebApplication.CreateBuilder(args);

// 一行代码完成ETL服务及健康检查的所有注册
builder.Services.AddETLService();

// 全局健康检查配置（如Prometheus转发）
builder.Services.AddHealthChecks()
    .ForwardToPrometheus();

var app = builder.Build();

// 配置健康检查端点
app.MapHealthChecks("/health");

app.Run();

扩展说明 #

• 如果有多个后台服务，可按照相同模式为每个服务创建独立的扩展方法（如AddFooService），各自封装自身的健康检查逻辑，核心应用层只需按需添加对应的扩展方法即可。
• 状态类的设计可根据实际需求扩展，比如添加错误信息、执行时长等字段，让健康检查结果更丰富。

内容的提问来源于stack exchange，提问作者Sam Ware