C#多线程之线程池篇3

　　在上一篇C#多线程之线程池篇2中，我们主要学习了线程池和并行度以及如何实现取消选项的相关知识。在这一篇中，我们主要学习如何使用等待句柄和超时、使用计时器和使用BackgroundWorker组件的相关知识。

五、使用等待句柄和超时

　　在这一小节中，我们将学习如何在线程池中实现超时和正确地实现等待。具体操作步骤如下：

1、使用Visual Studio 2015创建一个新的控制台应用程序。

2、双击打开“Program.cs”文件，编写代码如下所示：

using System;
using System.Threading;
using static System.Console;
using static System.Threading.Thread;

namespace Recipe05
{
    class Program
    {
        // CancellationTokenSource：通知System.Threading.CancellationToken，告知其应被取消。
        static void WorkerOperationWait(CancellationTokenSource cts, bool isTimedOut)
        {
            if (isTimedOut)
            {
                // 传达取消请求。
                cts.Cancel();
                WriteLine("Worker operation timed out and was canceled.");
            }
            else
            {
                WriteLine("Worker operation succeeded.");
            }
        }

        // CancellationToken：传播有关应取消操作的通知。
        // ManualResetEvent：通知一个或多个正在等待的线程已发生事件。
        static void WorkerOperation(CancellationToken token, ManualResetEvent evt)
        {
            for (int i = 0; i < 6; i++)
            {
                // 获取是否已请求取消此标记。如果已请求取消此标记，则为 true；否则为 false。
                if (token.IsCancellationRequested)
                {
                    return;
                }
                Sleep(TimeSpan.FromSeconds(1));
            }
            // 将事件状态设置为终止状态，允许一个或多个等待线程继续。
            evt.Set();
        }

        static void RunOperations(TimeSpan workerOperationTimeout)
        {
            using (var evt = new ManualResetEvent(false))
            using (var cts = new CancellationTokenSource())
            {
                // 注册一个等待System.Threading.WaitHandle的委托，并指定一个System.TimeSpan值来表示超时时间。
                // 第一个参数：要注册的System.Threading.WaitHandle。使用System.Threading.WaitHandle而非 System.Threading.Mutex。
                // 第二个参数：waitObject参数终止时调用的System.Threading.WaitOrTimerCallback 委托。
                // 第三个参数：传递给委托的对象。
                // 第四个参数：System.TimeSpan表示的超时时间。如果timeout为0（零），则函数将测试对象的状态并立即返回。如果timeout为 -1，则函数的超时间隔永远不过期。
                // 第五个参数：如果为true，表示在调用了委托后，线程将不再在waitObject参数上等待；如果为false，表示每次完成等待操作后都重置计时器，直到注销等待。
                // 返回值：封装本机句柄的System.Threading.RegisteredWaitHandle。
                var worker = ThreadPool.RegisterWaitForSingleObject(evt, (state, isTimedOut) => WorkerOperationWait(cts, isTimedOut), null, workerOperationTimeout, true);

                WriteLine("Starting long running operation...");
                // ThreadPool.QueueUserWorkItem：将方法排入队列以便执行。此方法在有线程池线程变得可用时执行。
                // cts.Token：获取与此System.Threading.CancellationTokenSource关联的System.Threading.CancellationToken。
                ThreadPool.QueueUserWorkItem(_ => WorkerOperation(cts.Token, evt));

                Sleep(workerOperationTimeout.Add(TimeSpan.FromSeconds(2)));

                // 取消由System.Threading.ThreadPool.RegisterWaitForSingleObject方法发出的已注册等待操作。
                worker.Unregister(evt);
            }
        }

        static void Main(string[] args)
        {
            // 实现超时
            RunOperations(TimeSpan.FromSeconds(5));
            // 实现等待
            RunOperations(TimeSpan.FromSeconds(7));
        }
    }
}

3、运行该控制台应用程序，运行效果如下图所示：

　　线程池还有另一个有用的方法：ThreadPool.RegisterWaitForSingleObject，该方法允许我们将回调方法放入线程池的队列中，当所提供的等待句柄发送信号或者超时发生时，该回调方法即被执行。这允许我们对线程池中的操作实现超时。

　　在第71行代码处，我们在主线程中调用了“RunOperations”方法，并给它的workerOperationTimeout参数传递了数值5，表示超时时间为5秒。

　　在第54行代码处，我们调用了ThreadPool的“RegisterWaitForSingleObject”静态方法，并指定了回调方法所要执行的操作是“WorkerOperationWait”方法，超时时间是5秒。

　　在第59行代码处，我们调用ThreadPool的“QueueUserWorkItem”静态方法来执行“WorkerOperation”方法，而该方法所消耗的时间为6秒，在这六秒中内已经在线程池中发送了超时，所以会执行第13~18行和第32~35行处的代码。

　　在第73行代码处，我们传递了数值7给“RunOperations”方法，设置线程池的超时时间为7秒，因为“WorkerOperation”方法的执行时间为6秒，所以在这种情况下没有发生超时，成功执行完毕“WorkerOperation”方法。

 六、使用计时器

　　在这一小节中，我们将学习如何使用System.Threading.Timer对象在线程池中定期地调用一个异步操作。具体操作步骤如下所示：

1、使用Visual Studio 2015创建一个新的控制台应用程序。

2、双击打开“Program.cs”文件，编写代码如下所示：

using System;
using System.Threading;
using static System.Console;
using static System.Threading.Thread;

namespace Recipe06
{
    class Program
    {
        static Timer timer;

        static void TimerOperation(DateTime start)
        {
            TimeSpan elapsed = DateTime.Now - start;
            WriteLine($"{elapsed.Seconds} seconds from {start}. Timer thread pool thread id: {CurrentThread.ManagedThreadId}");
        }

        static void Main(string[] args)
        {
            WriteLine("Press 'Enter' to stop the timer...");
            DateTime start = DateTime.Now;
            // 初始化Timer类的新实例，使用System.TimeSpan值来度量时间间隔。
            // 第一个参数：一个System.Threading.TimerCallback委托，表示要执行的方法。
            // 第二个参数：一个包含回调方法要使用的信息的对象，或者为null。
            // 第三个参数：System.TimeSpan，表示在callback参数调用它的方法之前延迟的时间量。指定-1毫秒以防止启动计时器。指定零(0)可立即启动计时器。
            // 第四个参数：在调用callback所引用的方法之间的时间间隔。指定-1毫秒可以禁用定期终止。
            timer = new Timer(_ => TimerOperation(start), null, TimeSpan.FromSeconds(1), TimeSpan.FromSeconds(2));
            try
            {
                Sleep(TimeSpan.FromSeconds(6));
                // 更改计时器的启动时间和方法调用之间的时间间隔，使用System.TimeSpan值度量时间间隔。
                // 第一个参数：一个System.TimeSpan，表示在调用构造System.Threading.Timer时指定的回调方法之前的延迟时间量。指定负-1毫秒以防止计时器重新启动。指定零(0)可立即重新启动计时器。
                // 第二个参数：在构造System.Threading.Timer时指定的回调方法调用之间的时间间隔。指定-1毫秒可以禁用定期终止。
                timer.Change(TimeSpan.FromSeconds(1), TimeSpan.FromSeconds(4));
                ReadLine();
            }
            finally
            {
                timer.Dispose();
            }
        }
    }
}

3、运行该控制台应用程序，运行效果（每次运行效果可能不同）如下图所示：

　　首先，我们创建了一个Timer实例，它的构造方法的第一个参数是一个lambda表达式，表示要在线程池中执行的代码，在该表达式中我们调用了“TimerOperation”方法，并给它提供了一个开始时间值。由于我们没有使用state对象，因此我们给Timer的构造方法的第二个参数传递了null。第三个参数表示第一次执行“TimerOperation”所要花费的时间为1秒钟。第四个参数表示每次调用“TimerOperation”之间的时间间隔为2秒钟。

　　在主线程阻塞6秒钟之后，我们调用了Timer实例的“Change”方法，更改了每次调用“TimerOperation”之间的时间间隔为4秒钟。

　　最后，我们等待输入“Enter”键来结束应用程序。

七、使用BackgroundWorker组件

 　　在这一小节中，我们学习另外一种异步编程的方式：BackgroundWorker组件。在这个组件的帮助下，我们可以通过一系列事件和事件处理方法组织我们的异步代码。具体操作步骤如下所示：

1、使用Visual Studio 2015创建一个新的控制台应用程序。

2、双击打开“Program.cs”文件，编写代码如下所示：

using System;
using System.ComponentModel;
using System.Threading;
using static System.Console;
using static System.Threading.Thread;

namespace Recipe07
{
    class Program
    {
        static void WorkerDoWork(object sender, DoWorkEventArgs e)
        {
            WriteLine($"DoWork thread pool thread id: {CurrentThread.ManagedThreadId}");
            var bw = (BackgroundWorker)sender;
            for (int i = 1; i <= 100; i++)
            {
                // 获取一个值，指示应用程序是否已请求取消后台操作。
                // 如果应用程序已请求取消后台操作，则为 true；否则为 false。默认值为 false。
                if (bw.CancellationPending)
                {
                    e.Cancel = true;
                    return;
                }

                if (i % 10 == 0)
                {
                    // 引发 System.ComponentModel.BackgroundWorker.ProgressChanged 事件。
                    // 参数：已完成的后台操作所占的百分比，范围从 0% 到 100%。
                    bw.ReportProgress(i);
                }

                Sleep(TimeSpan.FromSeconds(0.1));
            }

            // 获取或设置表示异步操作结果的值。
            e.Result = 42;
        }

        static void WorkerProgressChanged(object sender, ProgressChangedEventArgs e)
        {
            // e.ProgressPercentage：获取异步任务的进度百分比。
            WriteLine($"{e.ProgressPercentage}% completed. Progress thread pool thread id: {CurrentThread.ManagedThreadId}");
        }

        static void WorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
        {
            WriteLine($"Completed thread pool thread id: {CurrentThread.ManagedThreadId}");
            // e.Error：获取一个值，该值指示异步操作期间发生的错误。
            if (e.Error != null)
            {
                // 打印出异步操作期间发生的错误信息。
                WriteLine($"Exception {e.Error.Message} has occured.");
            }
            else if (e.Cancelled) // 获取一个值，该值指示异步操作是否已被取消。
            {
                WriteLine($"Operation has been canceled.");
            }
            else
            {
                // e.Result：获取表示异步操作结果的值。
                WriteLine($"The answer is: {e.Result}");
            }
        }

        static void Main(string[] args)
        {
            // 初始化System.ComponentModel.BackgroundWorker类的新实例。该类在单独的线程上执行操作。
            var bw = new BackgroundWorker();
            // 获取或设置一个值，该值指示System.ComponentModel.BackgroundWorker能否报告进度更新。
            // 如果System.ComponentModel.BackgroundWorker支持进度更新，则为true；否则为false。默认值为false。
            bw.WorkerReportsProgress = true;
            // 获取或设置一个值，该值指示System.ComponentModel.BackgroundWorker是否支持异步取消。
            // 如果System.ComponentModel.BackgroundWorker支持取消，则为true；否则为false。默认值为false。
            bw.WorkerSupportsCancellation = true;

            // 调用System.ComponentModel.BackgroundWorker.RunWorkerAsync时发生。
            bw.DoWork += WorkerDoWork;
            // 调用System.ComponentModel.BackgroundWorker.ReportProgress(System.Int32)时发生。
            bw.ProgressChanged += WorkerProgressChanged;
            // 当后台操作已完成、被取消或引发异常时发生。
            bw.RunWorkerCompleted += WorkerCompleted;

            // 开始执行后台操作。
            bw.RunWorkerAsync();

            WriteLine("Press C to cancel work");

            do
            {
                // 获取用户按下的下一个字符或功能键。按下的键可以选择显示在控制台窗口中。
                // 确定是否在控制台窗口中显示按下的键。如果为 true，则不显示按下的键；否则为 false。
                if (ReadKey(true).KeyChar == 'C')
                {
                    // 请求取消挂起的后台操作。
                    bw.CancelAsync();
                }
            }
            // 获取一个值，指示System.ComponentModel.BackgroundWorker是否正在运行异步操作。
            // 如果System.ComponentModel.BackgroundWorker正在运行异步操作，则为true；否则为false。
            while (bw.IsBusy);
        }
    }
}

3、运行该控制台应用程序，运行效果（每次运行效果可能不同）如下图所示：

 　　在第68行代码处，我们创建了一个BackgroundWorker组件的实例，并且在第71行代码和第74行代码处明确地说明该实例支持进度更新和异步取消操作。

　　在第77行代码、第79行代码和第81行代码处，我们给该实例挂载了三个事件处理方法。每当DoWork、ProgressChanged和RunWorkerCompleted事件发生时，都会执行相应的“WorkerDoWork方法”、“WorkerProgressChanged”方法和“WorkerCompleted”方法。

　　其他代码请参考注释。

　　源码下载