使用异步方式调用同步方法

使用异步方式调用同步方法/zh-cn/library/2e08f6yc(v=VS.90).aspx主页技术资源库学习下载支持社区登录| United States - English | |MSDN Library 开发工具和语言Visual Studio 2008 Visual Studio Visual Studio 中的.NET Framework 编程.NET Framework 高级开发异步编程设计模式使用委托进行异步编程使用异步方式调用同步方法异步委托编程示例社区内容添加代码示例和提示以增强此主题。

更多... 使用异步方式调用同步方法Visual Studio 2008 其他版本.NET Framework 4Visual Studio 2005更新：2008 年7 月.NET Framework 允许您异步调用任何方法。

为此，应定义与您要调用的方法具有相同签名的委托；公共语言运行时会自动使用适当的签名为该委托定义BeginInvoke 和EndInvoke 方法。

说明：.NET Compact Framework 中不支持异步委托调用，也就是BeginInvoke 和EndInvoke 方法。

BeginInvoke 方法启动异步调用。

该方法与您需要异步执行的方法具有相同的参数，还有另外两个可选参数。

第一个参数是一个AsyncCallback 委托，该委托引用在异步调用完成时要调用的方法。

第二个参数是一个用户定义的对象，该对象将信息传入回调方法。

BeginInvoke 会立即返回，而不等待异步调用完成。

BeginInvoke 返回一个可用于监视异步调用进度的IAsyncResult。

EndInvoke 方法检索异步调用的结果。

在调用BeginInvoke 之后随时可以调用该方法。

如果异步调用尚未完成，则EndInvoke 会一直阻止调用线程，直到异步调用完成。

EndInvoke 的参数包括您需要异步执行的方法的out 和ref 参数（在Visual Basic 中为<Out> ByRef 和ByRef）以及由BeginInvoke 返回的IAsyncResult。

说明：Visual Studio 2005 中的IntelliSense 功能显示BeginInvoke 和EndInvoke 的参数。

如果您没有使用Visual Studio 或类似工具，或您使用的是带有Visual Studio 2005 的C#，请参见异步编程概述以获取为这些方法定义的参数的说明。

本主题中的代码示例演示了使用BeginInvoke 和EndInvoke 进行异步调用的四种常用方法。

调用BeginInvoke 之后，您可以执行下列操作：进行某些操作，然后调用EndInvoke 一直阻止到调用完成。

使用IAsyncResult.AsyncWaitHandle 属性获取WaitHandle，使用其WaitOne 方法一直阻止执行直到发出WaitHandle 信号，然后调用EndInvoke。

轮询由BeginInvoke 返回的IAsyncResult，以确定异步调用何时完成，然后调用EndInvoke。

将用于回调方法的委托传递给BeginInvoke。

异步调用完成后，将在ThreadPool 线程上执行该方法。

回调方法调用EndInvoke。

重要说明：无论您使用何种方法，都要调用EndInvoke 来完成异步调用。

定义测试方法和异步委托--------------------------------------------------------------------------------下面的代码示例演示异步调用同一个长时间运行的方法TestMethod 的各种方式。

TestMethod 方法会显示一条控制台消息，说明该方法已开始处理，休眠了几秒钟，然后结束。

TestMethod 有一个out 参数，该参数用于演示此种参数添加到BeginInvoke 和EndInvoke 的签名中的方式。

您可以按同样的方式处理ref 参数。

下面的代码示例演示TestMethod 的定义和名为AsyncMethodCaller 的、可用来异步调用TestMethod 的委托。

若要编译代码示例，必须包括TestMethod 的定义和AsyncMethodCaller 委托。

VB C# C++ F# JScript复制using System;using System.Threading;namespace Examples.AdvancedProgramming.AsynchronousOperations{public class AsyncDemo{// The method to be executed asynchronously.public string TestMethod(int callDuration, out int threadId){Console.WriteLine("Test method begins.");Thread.Sleep(callDuration);threadId = Thread.CurrentThread.ManagedThreadId;return String.Format("My call time was {0}.", callDuration.ToString());}}// The delegate must have the same signature as the method// it will call asynchronously.public delegate string AsyncMethodCaller(int callDuration, out int threadId);}使用EndInvoke 等待异步调用--------------------------------------------------------------------------------异步执行方法的最简单方式是通过调用委托的BeginInvoke 方法来开始执行方法，在主线程上执行一些操作，然后调用委托的EndInvoke 方法。

EndInvoke 可能会阻止调用线程，因为该方法直到异步调用完成后才返回。

这种方式非常适合执行文件或网络操作。

重要说明：因为EndInvoke 可能会阻塞，所以不应从服务于用户界面的线程调用该方法。

VB C# C++ F# JScript复制using System;using System.Threading;namespace Examples.AdvancedProgramming.AsynchronousOperations{public class AsyncMain{public static void Main(){// The asynchronous method puts the thread id here.int threadId;// Create an instance of the test class.AsyncDemo ad = new AsyncDemo();// Create the delegate.AsyncMethodCaller caller = new AsyncMethodCaller(ad.TestMethod);// Initiate the asychronous call.IAsyncResult result = caller.BeginInvoke(3000,out threadId, null, null);Thread.Sleep(0);Console.WriteLine("Main thread {0} does some work.",Thread.CurrentThread.ManagedThreadId);// Call EndInvoke to wait for the asynchronous call to complete,// and to retrieve the results.string returnValue = caller.EndInvoke(out threadId, result);Console.WriteLine("The call executed on thread {0}, with return value \"{1}\".", threadId, returnValue);}}}/* This example produces output similar to the following:Main thread 1 does some work.Test method begins.The call executed on thread 3, with return value "My call time was 3000.".*/使用WaitHandle 等待异步调用--------------------------------------------------------------------------------您可以使用由BeginInvoke 返回的IAsyncResult 的AsyncWaitHandle 属性来获取WaitHandle。

异步调用完成时会发出WaitHandle 信号，而您可以通过调用WaitOne 方法等待它。

如果您使用WaitHandle，则在异步调用完成之前或之后，但在通过调用EndInvoke 检索结果之前，还可以执行其他处理。

说明：调用EndInvoke 时不会自动关闭等待句柄。

如果释放对等待句柄的所有引用，则当垃圾回收功能回收等待句柄时，将释放系统资源。

若要在等待句柄使用完毕后立即释放系统资源，请调用WaitHandle.Close 方法来释放等待句柄。

显式释放可释放的对象时，垃圾回收的工作效率会更高。

VB C# C++ F# JScript复制using System;using System.Threading;namespace Examples.AdvancedProgramming.AsynchronousOperations{public class AsyncMain{static void Main(){// The asynchronous method puts the thread id here.int threadId;// Create an instance of the test class.AsyncDemo ad = new AsyncDemo();// Create the delegate.AsyncMethodCaller caller = new AsyncMethodCaller(ad.TestMethod);// Initiate the asychronous call.IAsyncResult result = caller.BeginInvoke(3000,out threadId, null, null);Thread.Sleep(0);Console.WriteLine("Main thread {0} does some work.",Thread.CurrentThread.ManagedThreadId);// Wait for the WaitHandle to become signaled.result.AsyncWaitHandle.WaitOne();// Perform additional processing here.// Call EndInvoke to retrieve the results.string returnValue = caller.EndInvoke(out threadId, result);// Close the wait handle.result.AsyncWaitHandle.Close();Console.WriteLine("The call executed on thread {0}, with return value \"{1}\".", threadId, returnValue);}}}/* This example produces output similar to the following:Main thread 1 does some work.Test method begins.The call executed on thread 3, with return value "My call time was 3000.".*/轮询异步调用完成--------------------------------------------------------------------------------您可以使用由BeginInvoke 返回的IAsyncResult 的IsCompleted 属性来发现异步调用何时完成。