在 .NET Core 项目启动时运行定时任务

在现代应用程序开发中，定时任务（或后台服务）是不可或缺的一部分，它们用于在特定时间间隔内执行某些操作，如数据清理、状态更新等。在 .NET Core 中，我们可以利用 IHostedService 接口来实现启动时运行定时任务。本文将介绍如何在 .NET Core 项目中配置和运行定时任务，并提供一个示例代码。

前置要求

• .NET Core 3.1 及以上版本

• 基本的 .NET Core 项目结构理解

步骤

1. 创建 .NET Core 项目

首先，我们需要一个 .NET Core 控制台应用程序或 ASP.NET Core Web 应用程序。假设你已经创建了一个项目，接下来我们将添加定时任务功能。

2. 实现 IHostedService 接口

IHostedService 接口提供了两个方法：StartAsync 和 StopAsync，用于控制后台任务的启动和停止。我们将创建一个类来实现这个接口，并在 StartAsync 方法中配置我们的定时任务。

示例代码

创建一个名为 TimedBackgroundService 的类：

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

public class TimedBackgroundService : IHostedService, IDisposable
{
    private readonly ILogger<TimedBackgroundService> _logger;
    private Timer _timer;

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

    public Task StartAsync(CancellationToken stoppingToken)
    {
        _logger.LogInformation("Timed Background Service is starting.");

        _timer = new Timer(DoWork, null, TimeSpan.Zero, TimeSpan.FromSeconds(5));

        return Task.CompletedTask;
    }

    private void DoWork(object state)
    {
        _logger.LogInformation("Timed Background Service is working at {time}", DateTimeOffset.Now);

        // 这里执行你的定时任务逻辑
    }

    public Task StopAsync(CancellationToken stoppingToken)
    {
        _logger.LogInformation("Timed Background Service is stopping.");

        _timer?.Change(Timeout.Infinite, 0);

        return Task.CompletedTask;
    }

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

3. 注册服务

在 Program.cs（对于 .NET Core 3.1 及以后版本）或 Startup.cs（对于 ASP.NET Core 项目）中注册 TimedBackgroundService。

修改 Program.cs

对于 .NET Core 3.1 及以后的版本，通常在 Program.cs 中配置主机服务。

public class Program
{
    public static async Task Main(string[] args)
    {
        var host = CreateHostBuilder(args).Build();

        // 配置 TimedBackgroundService 作为 IHostedService 实现
        await host.RunAsync();
    }

    public static IHostBuilder CreateHostBuilder(string[] args) =>
        Host.CreateDefaultBuilder(args)
            .ConfigureServices((hostContext, services) =>
            {
                services.AddHostedService<TimedBackgroundService>();
            })
            .ConfigureWebHostDefaults(webBuilder =>
            {
                webBuilder.UseStartup<Startup>(); // 如果你有 Startup 类
            });
}

如果你的项目是基于 ASP.NET Core 的，并且你有一个 Startup.cs 文件，你也可以在 ConfigureServices 方法中注册服务：

public void ConfigureServices(IServiceCollection services)
{
    services.AddHostedService<TimedBackgroundService>();
    // 其他服务配置
}

4. 运行项目

现在，当你运行你的 .NET Core 项目时，TimedBackgroundService 将会随着应用程序的启动而启动，并且每 5 秒钟执行一次 DoWork 方法中的逻辑。

结论

通过实现 IHostedService 接口并在服务容器中注册，我们可以轻松地在 .NET Core 项目中启动和运行定时任务。这种方法不仅适用于控制台应用程序，也适用于 ASP.NET Core Web 应用程序，提供了一种灵活且强大的后台任务处理方式。

希望这篇文章能够帮助你在你的 .NET Core 项目中成功实现定时任务功能。如果你有任何问题或需要进一步的帮助，请随时留言！