[转]C#基础学习异步编程篇

本文转自：http://www.cnblogs.com/jiangnii/archive/2007/08/05/843872.aspx

 

C#基础学习 —— 异步编程篇 1

      .NET Framework 为异步操作提供了两种设计模式：使用 IAsyncResult 对象的异步操作与使用事件的异步操作。先来学习前者

      概述

      IAsyncResult 异步设计模式通过名为 BeginOperationName 和 EndOperationName 的两个方法来实现原同步方法的异步调用，如 FileStream 类提供了 BeginRead 和 EndRead 方法来从文件异步读取字节，它们是 Read 方法的异步版本

      Begin 方法包含同步方法签名中的任何参数，此外还包含另外两个参数：一个AsyncCallback 委托和一个用户定义的状态对象。委托用来调用回调方法，状态对象是用来向回调方法传递状态信息。该方法返回一个实现 IAsyncResult 接口的对象

      End 方法用于结束异步操作并返回结果，因此包含同步方法签名中的 ref 和 out 参数，返回值类型也与同步方法相同。该方法还包括一个 IAsyncResult 参数，用于获取异步操作是否完成的信息，当然在使用时就必须传入对应的 Begin 方法返回的对象实例

      开始异步操作后如果要阻止应用程序，可以直接调用 End 方法，这会阻止应用程序直到异步操作完成后再继续执行。也可以使用 IAsyncResult 的 AsyncWaitHandle 属性，调用其中的WaitOne等方法来阻塞线程。这两种方法的区别不大，只是前者必须一直等待而后者可以设置等待超时

      如果不阻止应用程序，则可以通过轮循 IAsyncResult 的 IsCompleted 状态来判断操作是否完成，或使用 AsyncCallback 委托来结束异步操作。AsyncCallback 委托包含一个 IAsyncResult 的签名，回调方法内部再调用 End 方法来获取操作执行结果

      尝试

      先来熟悉一下今天的主角，IAsyncResult 接口

    public interface IAsyncResult
    {
        object AsyncState { get; }
        WaitHandle AsyncWaitHandle { get; }
        bool CompletedSynchronously { get; }
        bool IsCompleted { get; }
    }

      我用一个 AsyncDemo 类作为异步方法的提供者，后面的程序都会调用它。内部很简单，构造函数接收一个字符串作为 name ，Run 方法输出 "My name is " + name ，而异步方法直接用委托的 BeginInvoke 和 EndInvoke 方法实现

    public class AsyncDemo
    {
        // Use in asynchronous methods
        private delegate string runDelegate();

        private string m_Name;
        private runDelegate m_Delegate;

        public AsyncDemo(string name)
        {
            m_Name = name;
            m_Delegate = new runDelegate(Run);
        }

        /**//// <summary>
        /// Synchronous method
        /// </summary>
        /// <returns></returns>
        public string Run()
        {
            return "My name is " + m_Name;
        }

        /**//// <summary>
        /// Asynchronous begin method
        /// </summary>
        /// <param name="callBack"></param>
        /// <param name="stateObject"></param>
        /// <returns></returns>
        public IAsyncResult BeginRun(AsyncCallback callBack, Object stateObject)
        {
            try
            {
                return m_Delegate.BeginInvoke(callBack, stateObject);
            }
            catch(Exception e)
            {
                // Hide inside method invoking stack
                throw e;
            }
        }

        /**//// <summary>
        /// Asynchronous end method
        /// </summary>
        /// <param name="ar"></param>
        /// <returns></returns>
        public string EndRun(IAsyncResult ar)
        {
            if (ar == null)
                throw new NullReferenceException("Arggument ar can't be null");

            try
            {
                return m_Delegate.EndInvoke(ar);
            }
            catch (Exception e)
            {
                // Hide inside method invoking stack
                throw e;
            }
        }
    }

      首先是 Begin 之后直接调用 End 方法，当然中间也可以做其他的操作

    class AsyncTest
    {
        static void Main(string[] args)
        {
            AsyncDemo demo = new AsyncDemo("jiangnii");

            // Execute begin method
            IAsyncResult ar = demo.BeginRun(null, null);

            // You can do other things here

            // Use end method to block thread until the operation is complete
            string demoName = demo.EndRun(ar);
            Console.WriteLine(demoName);
        }
    }

      也可以用 IAsyncResult 的 AsyncWaitHandle 属性，我在这里设置为1秒超时

    class AsyncTest
    {
        static void Main(string[] args)
        {
            AsyncDemo demo = new AsyncDemo("jiangnii");

            // Execute begin method
            IAsyncResult ar = demo.BeginRun(null, null);

            // You can do other things here

            // Use AsyncWaitHandle.WaitOne method to block thread for 1 second at most
            ar.AsyncWaitHandle.WaitOne(1000, false);

            if (ar.IsCompleted)
            {
                // Still need use end method to get result, but this time it will return immediately 
                string demoName = demo.EndRun(ar);
                Console.WriteLine(demoName);
            }
            else
            {
                Console.WriteLine("Sorry, can't get demoName, the time is over");
            }
        }
    }

      不中断的轮循，每次循环输出一个 "."

    class AsyncTest
    {
        static void Main(string[] args)
        {
            AsyncDemo demo = new AsyncDemo("jiangnii");

            // Execute begin method
            IAsyncResult ar = demo.BeginRun(null, null);

            Console.Write("Waiting..");
            while (!ar.IsCompleted)
            {
                Console.Write(".");
                // You can do other things here
            }
            Console.WriteLine();

            // Still need use end method to get result, but this time it will return immediately 
            string demoName = demo.EndRun(ar);
            Console.WriteLine(demoName);
        }
    }

      最后是使用回调方法并加上状态对象，状态对象被作为 IAsyncResult 参数的 AsyncState 属性被传给回调方法。回调方法执行前不能让主线程退出，我这里只是简单的让其休眠了1秒。另一个与之前不同的地方是 AsyncDemo 对象被定义成了类的静态字段，以便回调方法使用

    class AsyncTest
    {
        static AsyncDemo demo = new AsyncDemo("jiangnii");

        static void Main(string[] args)
        {
            // State object
            bool state = false;

            // Execute begin method
            IAsyncResult ar = demo.BeginRun(new AsyncCallback(outPut), state);

            // You can do other thins here

            // Wait until callback finished
            System.Threading.Thread.Sleep(1000);
        }

        // Callback method
        static void outPut(IAsyncResult ar)
        {
            bool state = (bool)ar.AsyncState;
            string demoName = demo.EndRun(ar);

            if (state)
            {
                Console.WriteLine(demoName);
            }
            else
            {
                Console.WriteLine(demoName + ", isn't it?");
            }
        }
    }

      其他

      对于一个已经实现了 BeginOperationName 和 EndOperationName  方法的对象，我们可以直接用上述方式调用，但对于只有同步方法的对象，我们要对其进行异步调用也不需要增加对应的异步方法，而只需定义一个委托并使用其 BeginInvoke 和 EndInvoke 方法就可以了

C#基础学习 —— 异步编程篇 2

      基于事件的异步模式是比 IAsyncResult 模式更高级的一种异步编程模式，也被用在更多的场合。对于相对简单的应用程序可以直接用 .Net 2.0 新增的 BackgroundWorker 组件来很方便的实现，对于更复杂的异步应用程序则需要自己实现一个符合基于事件的异步模式的类。这两者对我都是新东西，先从简单的入手，下一篇里我再去尝试复杂类模型的实现

      模式概述

      支持基于事件的异步模式的类会有若干个 MethodNameAsync 方法表示开始异步操作，并有对应的 MethodNameCompleted 事件。类里面还可能会有 CancelAsync 或 MethodNameAsyncCancel 方法用于取消异步操作，并可以有  ProgressChanged 或 MethodNameProgressChanged 事件来跟踪执行进度。下面分别作一下解释

      MethodNameAsync 方法可以有两个重载：单调用和多调用，多调用有一个额外的状态对象参数  userState。userState 参数用来区分各次异步操作，使得我们可以多次调用多调用形式的方法而不需要等待任何异步操作的完成（在学习 IAsyncResult 模式时我把状态对象仅仅当成传给回调方法的一个条件来用，可能在使用模式时这么做并没有什么关系，但在实现模式时不把状态对象用作异常调用的唯一标识而另作他用就值得商榷了）。而单调用形式的方法如果在前一个调用尚未完成时调用将会抛出 InvalidOperationException 异常

      如果有多个异步方法，则应使用 CancelAsync 方法来取消挂起的操作，并可使用 userState 来取消指定的挂起任务。如果只有一个异步方法则可以使用 MethodNameAsyncCancel 方法

      另外 MSDN 上说：一次只支持一个挂起的操作的方法（如 Method1Async(string param) ）是不可取消的。这句话我还没有理解，不可能说是单调用的异步方法就不能取消吧，BackgroundWorker 上都是这样做的

      先不管了，接着看ProgressChanged 事件。它有一个 ProgressChangedEventArgs 参数，事件处理程序通过检查该参数的 ProgressPercentage 属性来获取任务完成的百分比。如果有多个异步操作挂起，也可以通过检查参数的 UserState 属性来分辨操作。如果需要用 ProgressChanged 事件来报告增量结果，则可以把结果保存在派生自 ProgressChangedEventArgs 的类中，并在事件处理程序中使用

      BackgroundWorker

      BackgroundWorker 很好的符合了事件异步操作模式。它有两个重载版本的 RunWorkerAsync 方法（均为单调用形式）和 RunWorkerCompleted 事件，并有 CancelAsync 方法以及 ProcessChanged 事件。不同的是 BackgroundWorker 增加了 DoWork 事件，在 RunWorkerAsync 方法调用时发生，以达到将实际执行的开始方法与 BackgroundWorker 分离的目的。还需要提一下的是 WorkerReportsProcess 属性和 ReportProcess 方法，前者指示能否报告进度更新，后者引发 ProcessChanged 事件，它们会在接下来的 Demo 里用到

      尝试

      因为平时经常要处理几十兆的文本文件，这个 Demo 就做一个读取文件并显示进度的控制台程序。先看类名和字段

    class BackgroundWorkerDemo
    {
        private BackgroundWorker m_bw;
        string m_FilePath;
    }

      构造函数接收文件路径为参数，设置文件路径并初始化 BackgroundWorker

        public BackgroundWorkerDemo(string filePath)
        {
            m_FilePath = filePath;

            m_bw = new BackgroundWorker();
            m_bw.WorkerReportsProgress = true;
            m_bw.DoWork += new DoWorkEventHandler(BackgroundWorker_DoWork);
            m_bw.ProgressChanged += new ProgressChangedEventHandler(BackgroundWorker_ProgressChanged);
            m_bw.RunWorkerCompleted += new RunWorkerCompletedEventHandler(BackgroundWorker_RunWorkerCompleted);
        }

      接下来看这三个事件的处理程序。每一个事件都有各自的 EventArgs 参数类型，都很简单就不多说了

      第一个 BackgroundWorker_DoWork 方法写得我有些郁闷。我在方法里取文件长度，先是直接取 StreamReader.BaseStream.Length 或 FileInfo.Length ，结果却导致很多文件读不到 100% 就结束了，不得已改成先把整个文件读一次得到字符串的长度。这样的方法当然性能不好了，主要是因为自己对 IO 一直就不够清楚，等下一个主题重新认识下 IO 再回头过来改吧。也望有经验的朋友赐教，感激不尽

        /**//// <summary>
        /// DoWork event process method
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        private void BackgroundWorker_DoWork(object sender, DoWorkEventArgs e)
        {
            long length;
            using (StreamReader sr = new StreamReader(m_FilePath))
            {
                // Get file length
                length = sr.ReadToEnd().Length;
            }

            using (StreamReader sr = new StreamReader(m_FilePath))
            {
                long onePercentOfLength = length / 100;
                long currentPosition = 0;
                int i = 0;

                while (!sr.EndOfStream)
                {
                    sr.Read();
                    currentPosition ++;

                    // Produce ProcessChanged event in each percent reading
                    while (currentPosition > onePercentOfLength * i)
                    {
                        ((BackgroundWorker)sender).ReportProgress(i++);
                    }
                }

                // e.Result will be used in RunWorkerCompleted event process method
                e.Result = currentPosition;
            }
        }

      BackgroundWorker_ProgressChanged 方法，简单输出当前进度

        /**//// <summary>
        /// ProgressChanged event process method
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        private void BackgroundWorker_ProgressChanged(object sender, ProgressChangedEventArgs e)
        {
            Console.WriteLine("Reading percents: " + e.ProgressPercentage + "%");
        }

      BackgroundWorker_RunWorkerCompleted 方法，输出结果。这里要注意如果 RunWorkerCompletedEventArgs 参数的 Error 属性不为空则读取其他属性会产生异常，然后如果 Cancelled 属性为 true 则读取 Result 属性也会产生异常，因此必须依次判断各属性的值

        /**//// <summary>
        /// RunWorkerCompleted event process method
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        private void BackgroundWorker_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
        {
            if (e.Error != null)
            {
                Console.WriteLine("Error occurs: " + e.Error.Message);
            }
            else if(e.Cancelled)
            {
                Console.WriteLine("Work cancelled");
            }
            else
            {
                Console.WriteLine("Read finished, the file length is: " + e.Result);
            }
        }

      向外提供一个入口方法

        /**//// <summary>
        /// Test portal
        /// </summary>
        public void ReadAsync()
        {
            if (File.Exists(m_FilePath))
            {
                Console.WriteLine("Begin read");
                m_bw.RunWorkerAsync();
            }
            else
            {
                throw new FileNotFoundException("Can't find file: " + m_FilePath);
            }
        }

      最后是 Main 方法，比昨天有了小小的改变，用 Console.ReadLine 代替了 Thread.Sleep 来达到阻止主线程退出的目的

    class BackgroundWorkerTest
    {
        static void Main(string[] args)
        {
            Console.Write("Input file path: ");
            string filePath = Console.ReadLine();

            BackgroundWorkerDemo demo = new BackgroundWorkerDemo(filePath);
            demo.ReadAsync();

            // Thread waiting
            Console.ReadLine();
        }
    }

      其他

      回顾一下我用委托实现 IAsyncResult 模式的 Demo ，与用 BackgroundWorker 实现的基于事件的异步模式很相似吧。而且应用程序可以通过委托的 BeginInvoke 和 EndInvoke 方法来异步执行现有的同步方法而不需要作额外的修改，BackgroundWorker 也差不多是一样。我把这两者看成实现对应异步操作模式的范本，在性能要求不是很高的一些异步操作场合，用好委托和 BackgroundWorker 就可以简单有效的完成开发了