.NET Core 中的定时任务实现

在.NET Core中，定时任务是一个常见的需求，它允许你在特定的时间间隔或指定的时间点执行某些操作。无论是执行定期的数据同步、发送定期报告，还是进行系统的定时维护，定时任务都扮演着至关重要的角色。本文将介绍在.NET Core中实现定时任务的几种方法。

一、使用System.Threading.Timer

System.Threading.Timer是.NET Framework和.NET Core中都提供的一个简单的定时器类，它允许你指定一个回调函数和一个时间间隔，当定时器达到指定的时间间隔时，会调用这个回调函数。

using System;
using System.Threading;

public class TimerExample
{
    private static Timer _timer;

    public static void Main()
    {
        // 创建一个定时器，每隔2秒触发一次
        _timer = new Timer(TimerCallback, null, 0, 2000);

        Console.WriteLine("按任意键退出...");
        Console.ReadKey();
    }

    private static void TimerCallback(Object o)
    {
        // 每次定时器触发时执行的代码
        Console.WriteLine("Timer triggered at {0}", DateTime.Now);
    }
}

二、使用System.Timers.Timer

System.Timers.Timer与System.Threading.Timer类似，但提供了更多的功能和事件。它可以在指定的时间间隔后触发Elapsed事件，你可以在该事件处理程序中执行定时任务。

using System;
using System.Timers;

public class TimerExample
{
    private static System.Timers.Timer _timer;

    public static void Main()
    {
        // 创建一个定时器，设置间隔为2秒
        _timer = new System.Timers.Timer(2000);
        _timer.Elapsed += OnTimedEvent;
        _timer.Enabled = true;

        Console.WriteLine("按任意键退出...");
        Console.ReadKey();
    }

    private static void OnTimedEvent(Object source, ElapsedEventArgs e)
    {
        // 每次定时器触发时执行的代码
        Console.WriteLine("Timer triggered at {0}", e.SignalTime);
    }
}

三、使用Quartz.NET

Quartz.NET是一个开源的作业调度库，它允许你以更加灵活和强大的方式安排定时任务。Quartz.NET支持基于Cron表达式的复杂调度，并且可以持久化作业状态。

首先，你需要通过NuGet安装Quartz.NET包：

dotnet add package Quartz

然后，你可以创建一个作业类并实现IJob接口：

using Quartz;
using System;

public class HelloJob : IJob
{
    public Task Execute(IJobExecutionContext context)
    {
        Console.WriteLine("HelloJob is executing at " + DateTime.Now);
        return Task.CompletedTask;
    }
}

接下来，配置和启动Quartz调度器：

using Quartz;
using Quartz.Impl;
using System;
using System.Threading.Tasks;

public class QuartzExample
{
    public static async Task Main(string[] args)
    {
        // 创建调度器工厂和调度器实例
        StdSchedulerFactory factory = new StdSchedulerFactory();
        IScheduler scheduler = await factory.GetScheduler();
        await scheduler.Start();

        // 创建一个作业细节并绑定到HelloJob类
        IJobDetail job = JobBuilder.Create()
            .WithIdentity("job1", "group1")
            .Build();

        // 创建一个触发器，每5秒执行一次作业
        ITrigger trigger = TriggerBuilder.Create()
            .WithIdentity("trigger1", "group1")
            .StartNow()
            .WithSimpleSchedule(x => x.WithIntervalInSeconds(5).RepeatForever())
            .Build();

        // 将作业和触发器添加到调度器中
        await scheduler.ScheduleJob(job, trigger);

        Console.WriteLine("按任意键退出...");
        Console.ReadKey();
        
        // 停止调度器并等待所有作业完成
        await scheduler.Shutdown(true);
    }
}

四、使用内置的IHostedService在ASP.NET Core中

在ASP.NET Core应用中，你可以使用IHostedService接口来创建后台任务，这些任务可以在应用启动时开始运行，并在应用关闭时优雅地停止。这对于执行定时任务非常有用。

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

public class TimedHostedService : IHostedService, IDisposable
{
    private Timer _timer;
    private readonly ILogger _logger;

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

    public Task StartAsync(CancellationToken cancellationToken)
    {
        _timer = new Timer(DoWork, null, TimeSpan.Zero, 
            TimeSpan.FromSeconds(5)); // 设置时间间隔为5秒

        return Task.CompletedTask;
    }

    private void DoWork(object state)
    {
        _logger.LogInformation("TimedHostedService running at: {time}", DateTimeOffset.Now);
    }

    public Task StopAsync(CancellationToken cancellationToken)
    {
        _timer?.Change(Timeout.Infinite, Timeout.Infinite);
        return Task.CompletedTask;
    }

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

在Startup.cs的ConfigureServices方法中注册该服务：

public void ConfigureServices(IServiceCollection services)
{
    // ... 其他服务配置 ...
    services.AddHostedService(); // 注册TimedHostedService为后台服务
}

结论

在.NET Core中实现定时任务有多种方法，从简单的System.Threading.Timer到功能强大的Quartz.NET库，再到ASP.NET Core中的IHostedService，你可以根据项目的具体需求选择合适的方法。定时任务能够帮助你自动化执行重复性的工作，从而提高应用程序的效率和可靠性。