C#异步委托

在C#中，委托类型是一个类型安全的、面向对象的函数指针。当我们通过delegate关键字定义一个委托类型后，编译器会给委托类型生成三个方法：Invoke、BeginInvoke和EndInvoke。

例如对于下面委托类型，可以通过ILSpy查看编译器生成的三个方法。

private delegate int NumberAdd(int a, int b);

同步执行委托实例

在使用委托的应用中，最常见的就是通过Invoke()方法以同步方式执行委托实例。也就是说，调用委托的线程将会一直等待，直到委托调用完成。

下面看一个同步执行委托的例子，在numberAdd委托实例中，通过Sleep(3000)模拟了一个耗时的操作：

NumberAdd numberAdd = (a, b) => {
    Thread.Sleep(3000);
    Console.WriteLine("----> NumberAdd() on thread is {0}", Thread.CurrentThread.ManagedThreadId);
    Console.WriteLine("----> start to calc {0} + {1}",a,b);
    Console.WriteLine("----> test result is {0}",a+b);
    return a + b;
};

Console.WriteLine("main thread (id: {0}) invoke numberAdd function", Thread.CurrentThread.ManagedThreadId);
//int result = numberAdd(2, 5);
int result = numberAdd.Invoke(2, 5);
Console.WriteLine("main thread (id: {0}) get the result: {1}", Thread.CurrentThread.ManagedThreadId, result);

代码的输出为下，从结果中可以看出，主线程执行委托实例过程中将会被阻塞，直到委托实例执行完成，主线程才会继续执行。

在很多应用中，一个方法可能要执行很久，例如加载一个很大的文档，或者执行一个耗时的数据库操作。如果我们使用同步的方式执行方法，那么主线程会一直阻塞，直到这个方法执行完成，表现就是应用程序没有相应，影响用户体验。这时，就可以考虑通过委托的异步性进行方法调用。

BeginInvoke()和EndInvoke()

开始介绍异步执行委托之前，首先看看BeginInvoke()和EndInvoke()方法，结合上面的委托类型NumberAdd来分析一下这两个方法的参数和返回类型。

.method public hidebysig newslot virtual 
    instance class [mscorlib]System.IAsyncResult BeginInvoke (
        int32 a,
        int32 b,
        class [mscorlib]System.AsyncCallback callback,
        object 'object'
    ) runtime managed 
{
} // end of method NumberAdd::BeginInvoke

• BeginInvoke()方法用来启动异步调用，它与委托类型具有相同的参数；该例子中为int32 a和int32 b
• BeginInvoke()方法还有两个可选参数：
  • AsyncCallback委托，通过这个参数可以指定异步调用完成时要调用的方法（回调函数）
  • 用户定义的对象，该对象可向回调方法传递信息
• BeginInvoke()方法调用后立即返回，不等待委托执行完成；也就是说调用线程不会阻塞，可以继续执行
• BeginInvoke()将返回实现IAsyncResult接口的对象，这个对象可用于监视异步调用的进度；在准备获取方法调用的结果时，可以把它传给EndInvoke()方法

.method public hidebysig newslot virtual 
    instance int32 EndInvoke (
        class [mscorlib]System.IAsyncResult result
    ) runtime managed 
{
} // end of method NumberAdd::EndInvoke

• EndInvoke方法返回类型就是委托类型的返回类型，该例子中为int32
• EndInvoke只有一个实现IAsyncResult接口的参数（BeginInvoke()方法的返回结果），结合这个参数EndInvoke()方法可以获取异步调用的结果
• 在调用BeginInvoke()方法后，可以随时调用EndInvoke()方法，如果异步调用尚未完成，则EndInvoke()方法将一直阻止调用线程，直到异步调用完成后才允许调用线程执行

异步执行委托实例

介绍过BeginInvoke()和EndInvoke()方法后，看一个异步调用方法的例子。

Console.WriteLine("main thread (id: {0}) invoke numberAdd function", Thread.CurrentThread.ManagedThreadId);
IAsyncResult iAsyncResult = numberAdd.BeginInvoke(2, 5, null, null);
Console.WriteLine("main thread (id: {0}) can do something after BeginInvoke", Thread.CurrentThread.ManagedThreadId);
for (int i = 0; i < 5; i++)
    Console.WriteLine("......");
Console.WriteLine("main thread (id: {0}) wait at EndInvoke", Thread.CurrentThread.ManagedThreadId);
//主线程将在EndInvoke调用处阻塞，知道异步调用执行完成为止
int result = numberAdd.EndInvoke(iAsyncResult);
Console.WriteLine("main thread get the result: {0}", result);

代码的输出为，可以看到其实异步委托使用了一个新的线程来执行numberAdd实例，这样主线程就不会在BeginInvoke后阻塞，可以继续执行；但是当主线程执行到EndInvoke时，由于异步调用还没有完成，主线程将在EndInvoke处阻塞。

其实这个例子中还是有很大的问题，主线程还是会被阻塞。下面进行一点点改进，通过轮询的方式查看异步调用状态。

轮询异步调用状态

在IAsyncResult接口中，通过实现这个接口的实例的IsCompleted属性，可以检测异步操作是否已完成的指示，如果操作完成则为True，否则为False

简单看看IAsyncResult 的成员：

• AsyncState：获取用户定义的对象，可以作为回调函数的参数，从调用线程想回调函数传递信息
• AsyncWaitHandle：获取用于等待异步操作完成的 WaitHandle
• CompletedSynchronously：获取一个值，该值指示异步操作是否同步完成
• IsCompleted：获取一个布尔值，该值指示异步操作是否已完成

所以，代码中就可以利用IsCompleted来获取异步操作的状态：

Console.WriteLine("main invoke numberAdd function");
IAsyncResult iAsyncResult = numberAdd.BeginInvoke(2, 5, null, null);
while (iAsyncResult.IsCompleted != true)
{
    Console.WriteLine("main thread can do something after BeginInvoke");
    Console.WriteLine("......");
    Thread.Sleep(500);
}
int result = numberAdd.EndInvoke(iAsyncResult);
Console.WriteLine("main thread get the result: {0}", result);

同样，IAsyncResult类型实例中还有一个AsyncWaitHandle属性，通过这个属性可以实现更加灵活的等待逻辑。

该属性返回一个WaitHandle类型的实例，通过这个实例的WaitOne方法就可以调用线程和异步方法之间的同步：

Console.WriteLine("main invoke numberAdd function");
IAsyncResult iAsyncResult = numberAdd.BeginInvoke(2, 5, null, null);
while (!iAsyncResult.AsyncWaitHandle.WaitOne(500))
{
    Console.WriteLine("main thread can do something after BeginInvoke");
    Console.WriteLine("......");
}
int result = numberAdd.EndInvoke(iAsyncResult);
Console.WriteLine("main thread get the result: {0}", result);

使用AsyncCallback

通过轮询的方式来检测异步调用方法的执行状态也不是一种很好的实现方式，对于异步方法的调用，最好的实现方式就是通过AsyncCallback委托来指定回调函数。这样在异步方法完成后，异步线程将会主动通知调用线程。

下面例子中提供了一个回调函数NumberAddCompleted，当异步方法执行完成后，回调函数就会被调用。

注意：回调函数中需要得到委托实例，然后才可以调用EndInvoke方法来获取异步方法执行的结果，所以例子中使用了“System.Runtime.Remoting.Messaging”命名空间中的AsyncResult类型来获取委托的实例。

Console.WriteLine("main invoke numberAdd function");
IAsyncResult iAsyncResult = numberAdd.BeginInvoke(2, 5, NumberAddCompleted, "this is a msg from main");
for (int i = 0; i < 5; i++)
{
    Console.WriteLine("main thread can do something after BeginInvoke");
    Console.WriteLine("......");
    Thread.Sleep(500);
}

private static void NumberAddCompleted(IAsyncResult iAsyncResult)
{
    Console.WriteLine("numberAdd function complete, run callback function");
    AsyncResult asyncResult = (AsyncResult)iAsyncResult;
   
    Console.WriteLine(asyncResult.AsyncState as string);
　　 //通过AsyncResult类型实例获取委托实例
    NumberAdd numberAdd = (NumberAdd)asyncResult.AsyncDelegate;
    int result = numberAdd.EndInvoke(iAsyncResult);
    Console.WriteLine("main thread get the result: {0}", result);
    
}

总结

本文介绍了C#编译器为委托类型生成的BeginInvoke()和EndInvoke()方法。通过了一下简单的例子演示了如何通过BeginInvoke()和EndInvoke()方法来完成方法的异步调用。

当我们需要执行耗时的操作，又不希望调用线程被阻塞的时候，就可以考虑使用异步委托。通过委托异步执行的例子可以看出，其实异步委托的底层使用了多线程（直接使用线程池中的线程）。所以，使用异步委托的地方，我们也可以通过多线程的方式实现。