C# 非同步編程

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);
}
/**////
/// Synchronous method
///
///
public string Run()
{
return "My name is " + m_Name;
}
/**////
/// Asynchronous begin method
///
///
///
///
public IAsyncResult BeginRun(AsyncCallback callBack, Object stateObject)
{
try
{
return m_Delegate.BeginInvoke(callBack, stateObject);
}
catch(Exception e)
{
// Hide inside method invoking stack
throw e;
}
}
/**////
/// Asynchronous end method
///
///
///
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 方法就可以了