C# System.Threading.Timer 详解及示例阅读目录

Myth丶恋晨 2024-03-16 14:14 37阅读 0赞

**阅读目录**

*  [前言][Link 1]
 *  [一、两类重载][Link 2]
    
     *  [1、 Timer(TimerCallback)][1_ Timer_TimerCallback]
     *  [2、Timer(TimerCallback, Object, Int32, Int32)][2_Timer_TimerCallback_ Object_ Int32_ Int32]
 *  [二、属性 ActiveCount][ActiveCount]
 *  [三、方法][Link 3]
    
     *  [1、Timer.Change 方法][1_Timer.Change]
     *  [2、Timer.Dispose 方法][2_Timer.Dispose]
     *  [3、Timer.DisposeAsync 方法][3_Timer.DisposeAsync]

--------------------

[回到顶部][Link 4]

### 前言 ###

定时器功能在日常开发中也是比较常用的，在 .Net 中实际上总共有五种定时器，分别是：*[System.Timers.Timer][]、[System.Threading.Timer][]、[System.Windows.Forms.Timer][]、[System.Web.UI.Timer][]*(仅 .NET Framework)、[System.Windows.Threading.DispatcherTimer。][System.Windows.Threading.DispatcherTimer]

其中最常用的就是 System.Threading.Timer 基于线程池的定时器，相较于另外几种定时器，其安全性较高，适用性最强，因此本文将详细介绍此定时器的相关内容。

[回到顶部][Link 4]

### 一、两类重载 ###

*参考：[Timer 构造函数][Timer]*

#### 1、 Timer(TimerCallback) ####

使用**新创建的 Timer 对象**作为**状态对象**，用一个**无限周期**和一个**无限到期时间**初始化 Timer 类的新实例。当循环任务达成时，可以在回调函数中将当前的 Timer 对象释放掉。

<table> 
 <tbody> 
  <tr> 
   <td></td> 
   <td><code>// 语法</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>public Timer (System.Threading.TimerCallback callback);</code></td> 
  </tr> 
 </tbody> 
</table>

下面是一个简单示例：（在回调函数 TimerProc 中，我们可以通过将 Timer 对象释放掉，来结束循环过程）

#### 2、Timer(TimerCallback, Object, Int32, Int32) ####

使用 32 位的有符号整数指定时间间隔，初始化 Timer 类的新实例。**callback：**回调函数名；**state：**包含回调方法要使用的信息的状态对象，可为空；**dueTime：**延迟调用的时间；**period：**重复回调的时间间隔。

<table> 
 <tbody> 
  <tr> 
   <td></td> 
   <td><code>// 语法</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>public Timer (System.Threading.TimerCallback callback, object? state, int dueTime, int period);</code></td> 
  </tr> 
 </tbody> 
</table>

下面是一个示例：（*关于线程自动重置类：[AutoResetEvent 类][AutoResetEvent]*）

点击查看代码 通过线程同步事件，演示不同时间间隔输出结果的区别

与此重载类似用法的另外三个重载如下：

<table> 
 <tbody> 
  <tr> 
   <td></td> 
   <td><code>// 1、用 64 位整数表示时间间隔</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>Timer(TimerCallback, Object, Int64, Int64)</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>// 2、时间戳参数</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>// 时间戳语法：public TimeSpan (int hours, int minutes, int seconds);</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>// TimeSpan delayTime = new TimeSpan(0, 0, 1); </code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>// 时间戳语法：public TimeSpan (int days, int hours, int minutes, int seconds, int milliseconds, int microseconds);</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>// TimeSpan intervalTime = new TimeSpan(0, 0, 0, 0, 250);</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>Timer(TimerCallback, Object, TimeSpan, TimeSpan)</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>// 3、用 32 位无符号整数来表示时间间隔</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>Timer(TimerCallback, Object, UInt32, UInt32)</code></td> 
  </tr> 
 </tbody> 
</table>

[回到顶部][Link 4]

### 二、属性 ActiveCount ###

获取**当前活动的计时器数量**。 活动计数器定义为，在未来某一时间点触发且尚未取消。

下面是一个简单的示例：

[回到顶部][Link 4]

### 三、方法 ###

#### 1、Timer.Change 方法 ####

更改计时器的**延迟启动时间**和方法循环调用之间的**时间间隔**。单位均为毫秒（ms）。

其和 Timer 的构造函数重载类似，都是有四个重载，之间只有参数不同，用法相同。

四种类型分别是：Int32（32 位正整数）、Int64（64 位正整数）、TimeSpan（时间戳）、UInt32（32 位无符号整数）。

下面例举一个时间为正整数的示例：

<table> 
 <tbody> 
  <tr> 
   <td></td> 
   <td><code>// 先创建一个 Timer 对象</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>var stateTimer = new Timer((para)=&gt;{ }, null, 1000, 250);</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>// 调用变更对象的方法如下：1000 表示：延迟 1s 触发；500 表示间隔 0.5s 循环调用</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>stateTimer.Change(1000, 500);</code></td> 
  </tr> 
 </tbody> 
</table>

#### 2、Timer.Dispose 方法 ####

此方法共有两个重载，分别是：Dispose()、Dispose(WaitHandle)。

<table> 
 <tbody> 
  <tr> 
   <td></td> 
   <td><code>Dispose() </code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>// 释放由 Timer 实例使用的当前所有资源</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>Dispose(WaitHandle) </code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>// 释放由 Timer 实例使用的当前所有资源，并在释放完成时发出信号</code></td> 
  </tr> 
 </tbody> 
</table>

Dispose() 方法就是直接将 Timer 对象释放调，这里就不再赘述了，下面来看一个关于 Dispose(WaitHandle) 的示例：

<table> 
 <tbody> 
  <tr> 
   <td></td> 
   <td><code>using System;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>using System.Threading;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>namespace TimerDispose</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>{ </code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>class Program</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>{ </code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>static Timer timer = null; //**声明一个全局变量，避免 Timer 对象后续没有调用时，被 GC回收</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>// ManualResetEvent 继承自 WaitHandle</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>// 是否手动重置事件（是 WaitHandle 的子类） false 初始状态为无信号 true 初始状态为有信号</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>static ManualResetEvent timerDisposed = null;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>static void CreateAndStartTimer()</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>{ </code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>// 初始化 Timer，设置触发间隔为 2000 毫秒，设置 dueTime 参数为 Timeout.Infinite 表示不启动 Timer</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>timer = new Timer(TimerCallBack, null, Timeout.Infinite, 2000);</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>// 启动 Timer，设置 dueTime 参数为 0 表示立刻启动 Timer</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>//**先实例化再启动的目的是：避免在调用 Dispose 方法前，timer 对象还未完成赋值，所导致的空对象错误</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>timer.Change(0, 2000);</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>}</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>/// &lt;summary&gt;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>/// TimerCallBack 方法是 Timer 每一次触发后的事件处理方法</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>/// &lt;/summary&gt;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>static void TimerCallBack(object state)</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>{ </code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>// Thread.Sleep(10000); // Change() 报错：System.ObjectDisposedException: 'Cannot access a disposed object.'</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>try</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>{ </code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>timer.Change(0, 1000);</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>}</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>catch (ObjectDisposedException) //**当 Timer 对象已经调用了 Dispose 方法后，再调用 Change 方法，会抛出 ObjectDisposedException 异常</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>{ </code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>Console.WriteLine("在 Timer.Dispose 方法执行后，再调用 Timer.Change 方法已经没有意义");</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>}</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>Thread.Sleep(10000); // 在 Change() 之后可正常运行</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>}</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>static void Main(string[] args)</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>{ </code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>CreateAndStartTimer();</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>Console.WriteLine("按任意键调用Timer.Dispose方法...");</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>Console.ReadKey();</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>timerDisposed = new ManualResetEvent(false);</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>// 调用 Timer 的 bool Dispose(WaitHandle notifyObject) 重载方法，来结束Timer的触发，</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>// 当线程池中的所有 TimerCallBack 方法都执行完毕后，Timer 会发一个信号给 timerDisposed</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>timer.Dispose(timerDisposed);</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>// WaitHandle.WaitOne() 方法会等待收到一个信号，否则一直被阻塞</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>timerDisposed.WaitOne();</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>timerDisposed.Dispose();</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>Console.WriteLine("Timer已经结束，按任意键结束整个程序...");</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>Console.ReadKey();</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>}</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>}</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>}</code></td> 
  </tr> 
 </tbody> 
</table>

另外一个很不错的示例，是一个国外的高手所写，不仅考虑到了 Timer.Change 方法会抛出 ObjectDisposedExceptio n异常，他还给 WaitHandle.WaitOne 方法添加了超时限制（\_disposalTimeout），并且还加入了逻辑来防止 Timer.Dispose 方法被多次重复调用，注意 Timer 的 bool Dispose(WaitHandle notifyObject) 重载方法是会返回一个 bool 值的，如果它返回了 false，那么表示 Timer.Dispose 方法已经被调用过了，代码如下所示：

点击查看代码 一个更优秀的示例代码

*参考：[System.Threading.Timer如何正确地被Dispose][System.Threading.Timer_Dispose]*

#### 3、Timer.DisposeAsync 方法 ####

其为上一部分的一种异步实现。

从 .NET Core 开始，就意味着 .NET 来到了一个全新的异步时代。无论是各种基础类库（比如 System.IO）、AspNet Core、还是 EFCore 等等，它们都逐渐支持异步操作。其不阻止线程的执行，带来高性能的同时还基本不需要更改原有的编码习惯，因此后续针对异步的编程肯定会越来越普遍。

当一个实体类同时实现了 Dispose 和 DisposeAsync，由于程序会先判断时候实现了 DisposeAsync 异步释放，所以一般优先调用异步释放。*参考：[熟悉而陌生的新朋友——IAsyncDisposable][IAsyncDisposable]*

[Link 1]: https://www.cnblogs.com/czzj/p/SystemThreadingTimer.html#_label0
[Link 2]: https://www.cnblogs.com/czzj/p/SystemThreadingTimer.html#_label1
[1_ Timer_TimerCallback]: https://www.cnblogs.com/czzj/p/SystemThreadingTimer.html#_label1_0
[2_Timer_TimerCallback_ Object_ Int32_ Int32]: https://www.cnblogs.com/czzj/p/SystemThreadingTimer.html#_label1_1
[ActiveCount]: https://www.cnblogs.com/czzj/p/SystemThreadingTimer.html#_label2
[Link 3]: https://www.cnblogs.com/czzj/p/SystemThreadingTimer.html#_label3
[1_Timer.Change]: https://www.cnblogs.com/czzj/p/SystemThreadingTimer.html#_label3_0
[2_Timer.Dispose]: https://www.cnblogs.com/czzj/p/SystemThreadingTimer.html#_label3_1
[3_Timer.DisposeAsync]: https://www.cnblogs.com/czzj/p/SystemThreadingTimer.html#_label3_2
[Link 4]: https://www.cnblogs.com/czzj/p/SystemThreadingTimer.html#_labelTop
[System.Timers.Timer]: https://learn.microsoft.com/zh-cn/dotnet/api/system.timers.timer?view=net-7.0
[System.Threading.Timer]: https://learn.microsoft.com/zh-cn/dotnet/api/system.threading.timer?view=net-7.0
[System.Windows.Forms.Timer]: https://learn.microsoft.com/zh-cn/dotnet/api/system.windows.forms.timer?view=windowsdesktop-7.0&viewFallbackFrom=net-7.0
[System.Web.UI.Timer]: https://learn.microsoft.com/zh-cn/dotnet/api/system.web.ui.timer?view=netframework-4.8.1&viewFallbackFrom=net-7.0
[System.Windows.Threading.DispatcherTimer]: https://learn.microsoft.com/zh-cn/dotnet/api/system.windows.threading.dispatchertimer?view=windowsdesktop-7.0&viewFallbackFrom=net-7.0
[Timer]: https://learn.microsoft.com/zh-cn/dotnet/api/system.threading.timer.-ctor?view=net-7.0#system-threading-timer-ctor%28system-threading-timercallback-system-object-system-uint32-system-uint32%29
[AutoResetEvent]: https://learn.microsoft.com/zh-cn/dotnet/api/system.threading.autoresetevent?view=net-7.0
[System.Threading.Timer_Dispose]: https://www.cnblogs.com/OpenCoder/p/10728839.html
[IAsyncDisposable]: https://www.cnblogs.com/duck-coding/p/15190943.html