如何按需运行后台服务——而不是在应用程序启动或计时器上

Posted 2023-02-19

【中文标题】如何按需运行后台服务——而不是在应用程序启动或计时器上

【英文标题】：How to run a background service on demand - not on application startup or on a timer

【发布时间】：2021-05-02 10:40:43

【问题描述】：

在 .Net 5 Web API 中，我想运行一个发送大量电子邮件和 SMS 的后台任务。 我知道我可以创建一个继承自 BackgroundService 的服务，然后在 Startup.ConfigureServices 方法中将其添加到 DI 容器中，如下所示：

services.AddHostedService<EmailAndSmsService>();

但这会立即运行服务 - 即在应用程序启动时。 当 API 收到来自前端的请求时，我想运行该服务。即在控制器的操作方法中。

我一直在查看 Microsoft 文档中的“使用托管服务的后台任务”，如果我没记错的话，这就是我需要做的（查看标题为“在后台任务中使用范围服务”的部分"):

https://docs.microsoft.com/en-us/aspnet/core/fundamentals/host/hosted-services?view=aspnetcore-5.0&tabs=visual-studio

这是正确的吗？我是否基本上需要创建两项服务，一项执行实际工作，另一项调用执行实际工作的服务？我走对了吗？

谢谢

【问题讨论】：

结帐hangfire.io

您的文档中有一个工作队列的概念，让服务启动并等待工作完成对我来说似乎是合理的。

【参考方案1】：

在 .Net 5 Web API 中，我想运行一个发送大量电子邮件和 SMS 的后台任务。

我建议不要为此使用内存中的后台任务。内存队列和内存后台任务的问题是，当（不是如果）ASP.NET 应用程序重新启动时，工作会丢失。

相反，我建议使用durable queue with a separate background service。这个想法类似于Andy's solution，但是当 web 应用程序重新启动时，持久队列不会丢失电子邮件/短信。一般的做法是一样的：HTTP 请求处理程序写入队列然后返回，后台服务从队列中读取并执行实际的电子邮件/短信。

通常可以将后台服务保持在进程中（只要您使用持久队列，而不是内存中队列），但我通常建议将其移至单独的进程（Azure Function/WebJob / AWS Lambda、Win32 服务等）。这允许单独横向扩展 Web 服务器和后端服务器。

【参考方案2】：

您需要查看“排队的后台服务”，您可以在其中提交“作业”，它会在后台队列中执行这些作业。

工作流程是这样的：

调用者使用一些参数向服务发送请求 服务生成一个“作业”对象，并立即通过 202（已接受）响应返回一个 ID 服务将此作业放入由BackgroundService 维护的队列中 调用者可以使用此作业 ID 查询作业状态并获取有关已完成的工作量和剩余工作量的信息 服务完成作业，将作业置于“已完成”状态，然后返回等待队列以生成更多作业

这是一个关于它如何工作的冗长解释：https://***.com/a/63429262/1204153

这是我不久前做的一个例子：https://github.com/sonicmouse/ComputationService

【讨论】：

感谢安迪提供的解决方案。太棒了。

【参考方案3】：

如果适合您的目的，您可以在 .net 核心中使用石英调度程序服务。更多关于https://andrewlock.net/creating-a-quartz-net-hosted-service-with-asp-net-core/

【参考方案4】：

.NET Core API 框架是为短期任务设置的。任何超过 60-90 秒的运行时间都应该在单独的服务中完成。

我的建议是遵循您建议的路径：创建一个从等待任务的队列中读取的后台服务，然后让您的 API 服务将您的长时间运行的任务添加到后台服务的队列中。

this (possibly duplicate) question 中的更多信息。

【参考方案5】：

ASP.NET 及其 .NET Core 对应物专门设计为仅在收到请求时启动。这使其非常适合您尝试执行的操作。

我们所需要的只是一个包含我们用于发送电子邮件的代码的服务，就像这样。

public interface IEmailService

    void SendMessages(EmailPoco email);


public class EmailService

    public void SendMessages(EmailPoco email)
    
        // Send e-mail messages
    

然后我们可以将其注入到我们的 Startup 中的 ServiceCollection 中

public void ConfigureServices(IServiceCollection services)

    services.AddSingleton<ITokenStoreService, TokenStoreService>();

最后我们添加一个带有单个端点的控制器，我们可以使用它来触发这个过程。

[Route("api/[controller]")]
[ApiController]
public class EmailController : MiddlewareControllerBase

    public EmailController(IEmailService emailService)
    
        this.emailService = emailService;
    

    [HttpPost]
    public IActionResult Post([FromBody] EmailPoco email)
    
        return this.emailService.SendMessage(email);
    

如果您预计该过程需要很长时间，您可以诉诸于运行它asynchronously 或在单独的Thread 中完成工作并在完成之前返回响应。

如果进程消耗大量资源，并且您不希望它干扰现有 API 的其他功能，您可以考虑简单地将这个组件拆分到一个单独的 API 项目中，并从您的使用 HttpClient 的现有 API。

尝试运行一个后台进程，类似于 Windows service，只是偶尔会起作用，这似乎与您描述的您想要的有所不同，但这是另一种选择。

总体而言，ASP 请求管道非常适合仅在请求进入时启动操作，否则处于休眠状态。