.NET 6新增Timer类PeriodicTimer

前言

在.NET中,已经存在了5个Timer类:

  • System.Threading.Timer
  • System.Timers.Timer
  • System.Web.UI.Timer
  • System.Windows.Forms.Timer
  • System.Windows.Threading.DispatcherTimer

不管以前这样设计的原因,现在.NET 6又为我们增加了一个新Timer,PeriodicTimer.

这又是为什么呢?

Demo

与其他Timer需要创建事件回调不同:

Timer timer = new Timer(delegate
{
    Thread.Sleep(3000);
    Console.WriteLine($"Timer Thread: {Thread.CurrentThread.ManagedThreadId}");
    Console.WriteLine($"{DateTime.Now.Second} Timer tick");
},null,0,1000
);

.NET 6新增Timer类PeriodicTimer

PeriodicTimer的使用方式如下:

//间隔时间1秒
using (var timer = new PeriodicTimer(TimeSpan.FromSeconds(1)))
{
    //在到达指定周期后执行方法
    while (await timer.WaitForNextTickAsync())
    {
        await Task.Delay(3000);
 
        Console.WriteLine($"Timer Thread: {Thread.CurrentThread.ManagedThreadId}");
        Console.WriteLine($"{DateTime.Now.Second} PeriodicTimer tick");
    }
}

.NET 6新增Timer类PeriodicTimer

await关键字可以看出,PeriodicTimer用于异步执行;并且一次只有一个线程可以执行。

另外,你可以控制停止PeriodicTimer计时。示例代码如下:

//创建CancellationTokenSource,指定在3秒后将被取消
var cts = new CancellationTokenSource(TimeSpan.FromSeconds(3));

using (var timer = new PeriodicTimer(TimeSpan.FromSeconds(1)))
{
    while (await timer.WaitForNextTickAsync(cts.Token))
    {
        Console.WriteLine($"{DateTime.Now.Second} PeriodicTimer tick");
    }
}

需要注意的是,这会引发OperationCancelled异常,你需要捕获该异常,然后根据需要进行处理:

.NET 6新增Timer类PeriodicTimer

当然,你也可以通过主动取消CancellationTokenSource,来停止PeriodicTimer计时,示例代码如下:

var cts = new CancellationTokenSource();

using (var timer = new PeriodicTimer(TimeSpan.FromSeconds(1)))
{
    int count = 0;
    while (await timer.WaitForNextTickAsync(cts.Token))
    {
        if (++count == 3)
        {
            //执行3次后取消
            cts.Cancel();
        }
        Console.WriteLine($"{DateTime.Now.Second} PeriodicTimer tick");
    }
}

这次换成了TaskCancelled异常:

.NET 6新增Timer类PeriodicTimer

如果,你不想抛出异常,则可以用PeriodicTimer.Dispose方法来停止计时,示例代码如下:

using (var timer = new PeriodicTimer(TimeSpan.FromSeconds(1)))
{
    int count = 0;
    while (await timer.WaitForNextTickAsync())
    {
        if (++count == 3)
        {
            //执行3次后取消
            timer.Dispose();
        }
        Console.WriteLine($"{DateTime.Now.Second} PeriodicTimer tick");
    }
}

.NET 6新增Timer类PeriodicTimer

结论

通过上面的代码,可以了解到,设计PeriodicTimer的原因,可以归结为:

  • 用于异步上下文
  • 一次仅由一个消费者使用