ASP.NET Core 2.1中如何从控制器访问BackgroundService？

嘿，这个问题我之前在项目里刚好碰到过，其实有几种实用的方案可以解决，我给你详细说说：

因为你用services.AddSingleton<IHostedService, MyBackgroundService>()注册的时候，ASP.NET Core的DI容器会同时把MyBackgroundService本身也注册为单例实例。所以你可以直接在控制器的构造函数里注入MyBackgroundService：

public class MyController : ControllerBase
{
    private readonly MyBackgroundService _backgroundService;

    // 直接注入具体服务类型
    public MyController(MyBackgroundService backgroundService)
    {
        _backgroundService = backgroundService;
    }

    [HttpGet]
    public IActionResult TriggerBackgroundAction()
    {
        // 调用BackgroundService里暴露的公共方法
        _backgroundService.DoSomethingInBackground();
        return Ok("已触发后台服务操作");
    }
}

这里要注意：你需要在MyBackgroundService里把需要被控制器调用的方法设为公共方法，而且一定要保证这些方法是线程安全的——毕竟后台服务在单独的线程运行，控制器的请求是前台线程，并发访问时得做好同步处理。

如果不想直接依赖具体的服务类型，也可以注入IEnumerable<IHostedService>，然后从中筛选出你的MyBackgroundService实例：

public class MyController : ControllerBase
{
    private readonly MyBackgroundService _backgroundService;

    public MyController(IEnumerable<IHostedService> hostedServices)
    {
        _backgroundService = hostedServices.OfType<MyBackgroundService>().FirstOrDefault() 
            ?? throw new InvalidOperationException("MyBackgroundService 未在DI容器中注册");
    }

    [HttpGet]
    public IActionResult TriggerBackgroundAction()
    {
        _backgroundService?.DoSomethingInBackground();
        return Ok("已触发后台服务操作");
    }
}

这种方法更偏向依赖接口，但需要额外的筛选步骤，适合那种不想耦合具体实现的场景。

从架构设计角度，更推荐给你的后台服务定义一个专属接口，这样控制器依赖的是接口而非具体实现，符合依赖倒置原则，也方便后续的单元测试和维护：

首先定义接口：

public interface IMyBackgroundService
{
    void DoSomethingInBackground();
    // 可以添加其他需要暴露的方法
}

让MyBackgroundService实现这个接口：

public class MyBackgroundService : BackgroundService, IMyBackgroundService
{
    // 实现接口方法
    public void DoSomethingInBackground()
    {
        // 这里写你需要被控制器调用的逻辑
    }

    // 后台服务的核心执行逻辑，由宿主自动调用
    protected override async Task ExecuteAsync(CancellationToken stoppingToken)
    {
        while (!stoppingToken.IsCancellationRequested)
        {
            // 原有后台任务逻辑
            await Task.Delay(1000, stoppingToken);
        }
    }
}

注册服务的时候，同时注册接口和实现：

// 注册为后台服务
services.AddSingleton<IHostedService, MyBackgroundService>();
// 注册为业务接口服务
services.AddSingleton<IMyBackgroundService, MyBackgroundService>();

最后在控制器里注入接口：

public class MyController : ControllerBase
{
    private readonly IMyBackgroundService _backgroundService;

    // 依赖接口而非具体实现
    public MyController(IMyBackgroundService backgroundService)
    {
        _backgroundService = backgroundService;
    }

    [HttpGet]
    public IActionResult TriggerBackgroundAction()
    {
        _backgroundService.DoSomethingInBackground();
        return Ok("已触发后台服务操作");
    }
}

• 线程安全第一：后台服务和控制器请求可能同时访问公共方法，一定要用锁（比如lock）或者线程安全的数据结构来处理共享状态，避免出现竞态条件。
• 不要手动调用ExecuteAsync：这个方法是由ASP.NET Core宿主自动启动和管理的，你只需要调用自己暴露的公共方法即可。

内容的提问来源于stack exchange，提问作者Alex Troto