|
| 1 | +--- |
| 2 | +title: "在 .NET 中运行后台任务" |
| 3 | +date: 2021-09-24T09:36:50+08:00 |
| 4 | +description: "在 .NET 中运行后台任务" |
| 5 | +tags: [".NET", "后台任务", "定时任务", "队列任务", "Generic Host"] |
| 6 | +categories: [".NET", "ASP.NET"] |
| 7 | +--- |
| 8 | + |
| 9 | +在一个 `ASP.NET` 程序中我们常常需要进行比较耗时间的任务, 通常我们不会在一个请求中等待这些任务完成后再返回响应, 比如发邮件, 短信等. 这时候就需要我们将任务放到后台运行, 然后直接返回响应, 告诉用户任务已经再进行了. 本文将教会大家如何在 `.NET` 中运行后台任务, 示例代码请点击[链接](https://github.com/wangbinyq/net-background-task-example) |
| 10 | +<!-- more --> |
| 11 | + |
| 12 | +## 创建 `Worker` 程序 |
| 13 | + |
| 14 | +`.NET` 自带了一个后台任务模板, 我们执行 `dotnet new worker -o BackgroundTask` 就可以创建一个通用的 `console` 后台任务程序. 该模板中包含一个 `Worker` 类型, 继承了 `BackgroundService`, 然后在 `HostBuilder` 中通过 `AddHostedService` 注册. 最后调用 `host.RunAsync()` 执行该后台任务. 该示例程序每隔一秒钟打印当前时间. |
| 15 | + |
| 16 | +```c# |
| 17 | +namespace BackgroundTask; |
| 18 | + |
| 19 | +public class Worker : BackgroundService |
| 20 | +{ |
| 21 | + private readonly ILogger<Worker> _logger; |
| 22 | + |
| 23 | + public Worker(ILogger<Worker> logger) |
| 24 | + { |
| 25 | + _logger = logger; |
| 26 | + } |
| 27 | + |
| 28 | + protected override async Task ExecuteAsync(CancellationToken stoppingToken) |
| 29 | + { |
| 30 | + while (!stoppingToken.IsCancellationRequested) |
| 31 | + { |
| 32 | + _logger.LogInformation("Worker running at: {time}", DateTimeOffset.Now); |
| 33 | + await Task.Delay(1000, stoppingToken); |
| 34 | + } |
| 35 | + } |
| 36 | +} |
| 37 | +``` |
| 38 | + |
| 39 | +```c# |
| 40 | +using BackgroundTask; |
| 41 | + |
| 42 | +IHost host = Host.CreateDefaultBuilder(args) |
| 43 | + .ConfigureServices(services => |
| 44 | + { |
| 45 | + services.AddHostedService<Worker>(); |
| 46 | + }) |
| 47 | + .Build(); |
| 48 | + |
| 49 | +await host.RunAsync(); |
| 50 | +``` |
| 51 | + |
| 52 | +`AddHostedService` 接受一个 `IHostedService` 的泛型参数, 其有两个方法 `StartAsync` 和 `StopAsync`. 一个 `IHostedService` 跟一个单例 `Service` 相似, 只是启动时会调用 `StartAsync` 方法, 结束时调用 `StopAsync` 方法. |
| 53 | +`BackgroundService` 实际上是一个 `IHostedService` 长时间运行的实现. |
| 54 | + |
| 55 | +现在我们添加一个 `SimpleWorker` 类: |
| 56 | + |
| 57 | +```c# |
| 58 | +namespace BackgroundTask; |
| 59 | + |
| 60 | +public class SimpleWorker : IHostedService |
| 61 | +{ |
| 62 | + private ILogger<SimpleWorker> _logger; |
| 63 | + |
| 64 | + public SimpleWorker(ILogger<SimpleWorker> logger) |
| 65 | + { |
| 66 | + _logger = logger; |
| 67 | + } |
| 68 | + |
| 69 | + public Task StartAsync(CancellationToken cancellationToken) |
| 70 | + { |
| 71 | + _logger.LogInformation("Simple Worker Start"); |
| 72 | + return Task.CompletedTask; |
| 73 | + } |
| 74 | + |
| 75 | + public Task StopAsync(CancellationToken cancellationToken) |
| 76 | + { |
| 77 | + _logger.LogInformation("Simple Worker Stop"); |
| 78 | + return Task.CompletedTask; |
| 79 | + } |
| 80 | +} |
| 81 | +``` |
| 82 | +我们还需要在 `Program.cs` 中添加注册. |
| 83 | + |
| 84 | +```c# |
| 85 | + services.AddHostedService<SimpleWorker>(); |
| 86 | +``` |
| 87 | + |
| 88 | +现在在启动和结束时会分别打印信息. |
| 89 | + |
| 90 | + |
| 91 | + |
| 92 | + |
| 93 | +## 使用 `Timer` 进行定时任务 |
| 94 | + |
| 95 | +默认的 `Worker` 实现定时每秒钟打印执行的效果, 我们也可以使用 `Timer` 可以获得同样的效果. |
| 96 | + |
| 97 | +```c# |
| 98 | +namespace BackgroundTask; |
| 99 | + |
| 100 | +public class TimerWorker : IHostedService |
| 101 | +{ |
| 102 | + private int _count = 0; |
| 103 | + private ILogger<TimerWorker> _logger; |
| 104 | + private Timer? _timer; |
| 105 | + |
| 106 | + public TimerWorker(ILogger<TimerWorker> logger) |
| 107 | + { |
| 108 | + _logger = logger; |
| 109 | + } |
| 110 | + |
| 111 | + public Task StartAsync(CancellationToken cancellationToken) |
| 112 | + { |
| 113 | + _logger.LogInformation("Timer Worker Start"); |
| 114 | + _timer = new Timer(DoWork, null, TimeSpan.Zero, TimeSpan.FromSeconds(5)); |
| 115 | + |
| 116 | + return Task.CompletedTask; |
| 117 | + } |
| 118 | + |
| 119 | + public Task StopAsync(CancellationToken cancellationToken) |
| 120 | + { |
| 121 | + _logger.LogInformation("Timer Worker Stop"); |
| 122 | + |
| 123 | + return Task.CompletedTask; |
| 124 | + } |
| 125 | + |
| 126 | + private void DoWork(object? state) |
| 127 | + { |
| 128 | + var count = Interlocked.Increment(ref _count); |
| 129 | + |
| 130 | + _logger.LogInformation($"count = {count}, time: {DateTimeOffset.Now}"); |
| 131 | + } |
| 132 | +} |
| 133 | +``` |
| 134 | + |
| 135 | +同时别忘了注册该 `Service`. |
| 136 | + |
| 137 | + |
| 138 | + |
| 139 | +## 使用 `Channel` 创建任务队列 |
| 140 | + |
| 141 | +更常见的使用后台任务的方式是使用队列, `.NET` 为我们提供了 `System.Threading.Channel` 类. 这里我们需要两个 `Worker`: 一个作为生产者, 一个作为消费者: |
| 142 | + |
| 143 | +```c# |
| 144 | +namespace BackgroundTask; |
| 145 | + |
| 146 | +using System.Threading.Channels; |
| 147 | + |
| 148 | +public class ProducerWorker : BackgroundService |
| 149 | +{ |
| 150 | + private int _count = 0; |
| 151 | + private Channel<int> _queue; |
| 152 | + |
| 153 | + public ProducerWorker(Channel<int> queue) |
| 154 | + { |
| 155 | + _queue = queue; |
| 156 | + } |
| 157 | + |
| 158 | + protected override async Task ExecuteAsync(CancellationToken stoppingToken) |
| 159 | + { |
| 160 | + while (!stoppingToken.IsCancellationRequested) |
| 161 | + { |
| 162 | + var count = Interlocked.Increment(ref _count); |
| 163 | + await _queue.Writer.WriteAsync(count, stoppingToken); |
| 164 | + await Task.Delay(1000, stoppingToken); |
| 165 | + } |
| 166 | + } |
| 167 | +} |
| 168 | +``` |
| 169 | + |
| 170 | +```c# |
| 171 | +namespace BackgroundTask; |
| 172 | + |
| 173 | +using System.Threading; |
| 174 | +using System.Threading.Channels; |
| 175 | +using System.Threading.Tasks; |
| 176 | + |
| 177 | +public class ConsumerWorker : BackgroundService |
| 178 | +{ |
| 179 | + private Channel<int> _queue; |
| 180 | + private ILogger<ConsumerWorker> _logger; |
| 181 | + |
| 182 | + public ConsumerWorker(Channel<int> queue, ILogger<ConsumerWorker> logger) |
| 183 | + { |
| 184 | + _queue = queue; |
| 185 | + _logger = logger; |
| 186 | + } |
| 187 | + |
| 188 | + protected override async Task ExecuteAsync(CancellationToken stoppingToken) |
| 189 | + { |
| 190 | + while (!stoppingToken.IsCancellationRequested) |
| 191 | + { |
| 192 | + var count = await _queue.Reader.ReadAsync(stoppingToken); |
| 193 | + |
| 194 | + _logger.LogInformation($"do work for: {count}"); |
| 195 | + } |
| 196 | + } |
| 197 | +} |
| 198 | +``` |
| 199 | + |
| 200 | +同时我们需要通过依赖注入注入一个 `Channel<int>` 的单例: |
| 201 | + |
| 202 | +```c# |
| 203 | +var queue = Channel.CreateBounded<int>(10); |
| 204 | +services.AddSingleton(queue); |
| 205 | +services.AddHostedService<ProducerWorker>(); |
| 206 | +services.AddHostedService<ConsumerWorker>(); |
| 207 | +``` |
| 208 | + |
| 209 | + |
0 commit comments