.NET如何创建一个后台定时任务(Worker Service)

推荐使用 Worker Service 模板结合 IHostedService 与 Timer 实现后台定时任务。1. 创建 Worker Service 项目,生成基础结构;2. 在 Worker 类中重写 ExecuteAsync 方法,通过 Timer 每5分钟执行一次 DoWork 逻辑,并注册取消令牌确保优雅停止;3. 可在构造函数中注入 ILogger、IHttpClientFactory 等服务,实现日志记录或 HTTP 调用;4. 通过 dotnet publish 命令发布为自包含应用,支持部署为 Windows 服务或 Linux systemd 服务。该方式无需界面,适合长时间运行的周期性任务,关键在于避免阻塞主线程并正确处理 CancellationToken。

在 .NET 中创建一个后台定时任务,最推荐的方式是使用 Worker Service 模板,并结合 IHostedServiceTimer 实现周期性执行。这种方式适用于不需要用户界面的长时间运行服务,比如定时处理日志、调用 API、清理数据等。

1. 创建 Worker Service 项目

使用命令行或 Visual Studio 创建一个 Worker Service 项目:

dotnet new worker -n MyBackgroundTask

这会生成一个基础的 Worker 项目结构,包含 Program.csWorker.cs

2. 修改 Worker 类实现定时任务

默认的 Worker 类继承自 BackgroundService,我们可以通过重写 ExecuteAsync 方法并使用 Timer 来实现定时逻辑。

示例代码:

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

public class Worker : BackgroundService
{
    private readonly ILogger _logger;

    public Worker(ILogger logger)
    {
        _logger = logger;
    }

    protected override async Task ExecuteAsync(CancellationToken stoppingToken)
    {
        await Task.Run(() =>
        {
            var timer = new Timer(DoWork, null, TimeSpan.Zero, TimeSpan.FromMinutes(5)); // 每5分钟执行一次

            stoppingToken.Register(() => timer?.Change(Timeout.Infinite, 0));
        }, stoppingToken);
    }

    private void DoWork(object state)
    {
        _logger.LogInformation("定时任务正在执行:{time}", DateTime.Now);
        // 在这里添加你的业务逻辑
    }
}

说明:

  • TimeSpan.Zero 表示立即开始第一次执行。
  • TimeSpan.FromMinutes(5) 设置间隔时间为5分钟。
  • stoppingToken.Register 确保服务停止时,定时器也被正确释放。

3. 配置依赖注入和日志(可选)

如果需要在任务中使用数据库、HTTP 客户端或其他服务,可以在构造函数中注入它们。例如:

private readonly IHttpClientFactory _httpClientFactory;

public Worker(ILogger logger, IHttpClientFactory httpClientFactory)
{
    _logger = logger;
    _httpClientFactory = httpClientFactory;
}

确保在 Program.cs 中注册了相关服务,如:

builder.Services.AddHttpClient();

4. 发布和部署

Worker Service 可以作为控制台应用运行,也可以发布为 Windows 服务或 Linux 后台服务(如 systemd)。

发布命令:

dotnet publish -c Release -r win-x64 --self-contained true

生成的可执行文件可以直接运行或注册为系统服务。

基本上就这些。通过 BackgroundService + Timer 的组合,你可以轻松实现一个稳定可靠的后台定时任务。关键是避免阻塞主线程,并正确处理取消令牌。