C#异步编程模式IAsyncResult概述

C#异步编程模式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 方法来获取操作执行结果

    C#异步编程模式IAsyncResult之IAsyncResult 接口

  1. publicinterface IAsyncResult
  2. {
  3. object AsyncState { get; }
  4. WaitHandle AsyncWaitHandle { get; }
  5. bool CompletedSynchronously { get; }
  6. bool IsCompleted { get; }
  7. }

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

  1. publicclass AsyncDemo
  2. {
  3. // Use in asynchronous methods
  4. privatedelegatestring runDelegate();
  5. privatestring m_Name;
  6. private runDelegate m_Delegate;
  7. public AsyncDemo(string name)
  8. {
  9. m_Name = name;
  10. m_Delegate = new runDelegate(Run);
  11. }
  12. /**//// ﹤summary﹥
  13. /// Synchronous method
  14. /// ﹤/summary﹥
  15. /// ﹤returns﹥﹤/returns﹥
  16. publicstring Run()
  17. {
  18. return"My name is " + m_Name;
  19. }
  20. /**//// ﹤summary﹥
  21. /// Asynchronous begin method
  22. /// ﹤/summary﹥
  23. /// ﹤param name="callBack"﹥﹤/param﹥
  24. /// ﹤param name="stateObject"﹥﹤/param﹥
  25. /// ﹤returns﹥﹤/returns﹥
  26. public IAsyncResult BeginRun(
  27. AsyncCallback callBack, Object stateObject)
  28. {
  29. try
  30. {
  31. return m_Delegate.BeginInvoke(callBack, stateObject);
  32. }
  33. catch(Exception e)
  34. {
  35. // Hide inside method invoking stack
  36. throw e;
  37. }
  38. }
  39. /**//// ﹤summary﹥
  40. /// Asynchronous end method
  41. /// ﹤/summary﹥
  42. /// ﹤param name="ar"﹥﹤/param﹥
  43. /// ﹤returns﹥﹤/returns﹥
  44. publicstring EndRun(IAsyncResult ar)
  45. {
  46. if (ar == null)
  47. thrownew NullReferenceException(
  48. "Arggument ar can't be null");
  49. try
  50. {
  51. return m_Delegate.EndInvoke(ar);
  52. }
  53. catch (Exception e)
  54. {
  55. // Hide inside method invoking stack
  56. throw e;
  57. }
  58. }
  59. }

    C#异步编程模式IAsyncResult操作步骤：首先是 Begin 之后直接调用 End 方法，当然中间也可以做其他的操作

  1. class AsyncTest
  2. {
  3. staticvoid Main(string[] args)
  4. {
  5. AsyncDemo demo = new AsyncDemo("jiangnii");
  6. // Execute begin method
  7. IAsyncResult ar = demo.BeginRun(null, null);
  8. // You can do other things here
  9. // Use end method to block thread
  10. // until the operation is complete
  11. string demoName = demo.EndRun(ar);
  12. Console.WriteLine(demoName);
  13. }
  14. }

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

  1. class AsyncTest
  2. {
  3. staticvoid Main(string[] args)
  4. {
  5. AsyncDemo demo = new AsyncDemo("jiangnii");
  6. // Execute begin method
  7. IAsyncResult ar = demo.BeginRun(null, null);
  8. // You can do other things here
  9. // Use AsyncWaitHandle.WaitOne method to block thread for 1 second at most
  10. ar.AsyncWaitHandle.WaitOne(1000, false);
  11. if (ar.IsCompleted)
  12. {
  13. // Still need use end method to get result,
  14. // but this time it will return immediately
  15. string demoName = demo.EndRun(ar);
  16. Console.WriteLine(demoName);
  17. }
  18. else
  19. {
  20. Console.WriteLine("Sorry,
  21. can't get demoName, the time is over");
  22. }
  23. }
  24. }

    C#异步编程模式IAsyncResult要注意的还有：不中断的循环，每次循环输出一个 "."

  1. class AsyncTest
  2. {
  3. staticvoid Main(string[] args)
  4. {
  5. AsyncDemo demo = new AsyncDemo("jiangnii");
  6. // Execute begin method
  7. IAsyncResult ar = demo.BeginRun(null, null);
  8. Console.Write("Waiting..");
  9. while (!ar.IsCompleted)
  10. {
  11. Console.Write(".");
  12. // You can do other things here
  13. }
  14. Console.WriteLine();
  15. // Still need use end method to get result,
  16. //but this time it will return immediately
  17. string demoName = demo.EndRun(ar);
  18. Console.WriteLine(demoName);
  19. }
  20. }

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

  1. class AsyncTest
  2. {
  3. static AsyncDemo demo = new AsyncDemo("jiangnii");
  4. staticvoid Main(string[] args)
  5. {
  6. // State object
  7. bool state = false;
  8. // Execute begin method
  9. IAsyncResult ar = demo.BeginRun(
  10. new AsyncCallback(outPut), state);
  11. // You can do other thins here
  12. // Wait until callback finished
  13. System.Threading.Thread.Sleep(1000);
  14. }
  15. // Callback method
  16. staticvoid outPut(IAsyncResult ar)
  17. {
  18. bool state = (bool)ar.AsyncState;
  19. string demoName = demo.EndRun(ar);
  20. if (state)
  21. {
  22. Console.WriteLine(demoName);
  23. }
  24. else
  25. {
  26. Console.WriteLine(demoName + ", isn't it?");
  27. }
  28. }
  29. }

    C#异步编程模式IAsyncResult的后话：

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

    C#异步编程模式IAsyncResult的基本情况就向你介绍到这里，希望对你了解和学习C#异步编程模式IAsyncResult有所帮助。

posted @ 2012-11-26 16:18  zhangyoushugz  阅读(298)  评论(0)  编辑  收藏  举报