在 .NET Core 中使用 Worker Service（辅助角色服务）

 

什么是 Worker Service（辅助角色服务）？

.NET Core 3.0 新增了 Worker Service 的新项目模板，可以编写长时间运行的后台服务，并且能轻松的部署成 windows 服务或 linux 守护程序。

如果安装的 vs2019 是中文版本，Worker Service 的项目名称就变成了辅助角色服务。

IHostedService 接口方法：

StartAsync(CancellationToken) - 包含启动后台任务的逻辑。

StopAsync(CancellationToken) - 主机正常关闭时触发。

关于 BackgroundService

BackgroundService 是用于实现长时间运行的 IHostedService 的基类。

参考教程

• 开始创建worker service 项目
• Program.cs
• Worker.cs
• 依赖注入（DI）
• 重写BackgroundService类的StartAsync、ExecuteAsync、StopAsync方法
• 不要让线程阻塞worker类中重写的StartAsync、ExecuteAsync、StopAsync方法
• 在Worker Service中运行多个Worker类
• 部署为Windows服务运行
• 部署作为Linux守护程序运行

案例 - 计时的后台任务

using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;
using System;
using System.Threading;
using System.Threading.Tasks;

namespace Demo_WorkerService_0320
{
    public class TimedHostedService : IHostedService, IDisposable
    {
        private int executionCount = 0;
        private readonly ILogger<TimedHostedService> _logger;
        private Timer _timer;

        public TimedHostedService(ILogger<TimedHostedService> logger)
        {
            _logger = logger;
        }

        public Task StartAsync(CancellationToken stoppingToken)
        {
            _logger.LogInformation("Timed Hosted Service running.");
            _timer = new Timer(DoWork, DateTime.Now.Ticks, TimeSpan.Zero, TimeSpan.FromSeconds(2));
            return Task.CompletedTask;
        }

        private void DoWork(object state)
        {
            var count = Interlocked.Increment(ref executionCount);
            _logger.LogInformation($" *** Index = {count}, task start... *** ");
            Thread.Sleep(5 * 1000);
            _logger.LogInformation($" *** Index = {count}, task complete ***");
        }

        public Task StopAsync(CancellationToken stoppingToken)
        {
            _logger.LogInformation("Timed Hosted Service is stopping.");
            _timer?.Change(Timeout.Infinite, 0);
            return Task.CompletedTask;
        }

        public void Dispose()
        {
            _timer?.Dispose();
        }
    }
}

Preview

参考资料

在 ASP.NET Core 中使用托管服务实现后台任务
https://docs.microsoft.com/zh-cn/aspnet/core/fundamentals/host/hosted-services?view=aspnetcore-3.1&tabs=visual-studio

利用.NET Core中的Worker Service，来创建windows服务或linux守护程序
https://www.cnblogs.com/OpenCoder/p/12191164.html