实现异步的技巧

实现异步的技巧

一般情况下，函数都是同步调用的，就是说调用者在调用一个函数时，必须等到被调用函数执行完毕，调用者的后续代码才能继续执行。
对于有些函数，可能执行完毕需要很长时间，让调用者等到其执行完毕，可能会让用户觉得程序挂起。因此常常需要提供一种异步方法，允许调用者在调用之后，立即继续执行后续代码。
使用.NET Framework提供的Delegate机制，很容易将一个耗时很长的函数改写成一个支持异步调用的方法。下面是一个实现异步方法的例子。

（1）创建一个Windows Application Project，在默认的Form1上，添加一个Button1。
（2）创建一个Class Library类型的Project，将默认的Class1更改为AsynchronousProcess。
（3）编写一个耗时很长的方法：
Private Sub DoLongJob(ByVal parameters As JobArgs)
' Simulate the long running job
System.Threading.Thread.Sleep(5000)
End Sub
注意：JobArgs是一个自定义的类，用于从调用者向被调用者传入参数：
Public Class JobArgs
Public Duration As Integer ' Milliseconds
Public Sub New()
Me.Duration = 0
End Sub
Public Sub New(ByVal milliSeconds As Integer)
Me.Duration = milliSeconds
End Sub
End Class

（4）定义一个Delegate：
Private Delegate Sub LongRunningOperationDelegate()
注意：这个Delegate的signature应该与耗时方法一致，比如，如果DoLongJob带有参数，那么LongRunningOperationDelegate也应该有相同的参数。

（5）编写一个新的public方法，供调用者调用：
Public Sub StartLongJob(ByVal milliSeconds As Integer)
' The instance of the delegate
Dim myDelegate As New LongRunningOperationDelegate(AddressOf DoLongJob)
Dim aResult As System.IAsyncResult
aResult = myDelegate.BeginInvoke(New JobArgs(milliSeconds), Nothing, Nothing)
End Sub
在这个新方法中，对DoLongJob的调用被转换成对Delegate的BeginInvoke方法的调用。这样，调用者在调用StartLongJob之后，就可以立即获得控制权，以继续执行后续代码。
（6）编写客户端的调用代码，与调用普通方法无异，例如在Button的Click事件中：
Dim obj As New LongOperation.AsynchronousProcess
obj.StartLongJob(CInt(TextBox1.Text))
此时运行程序，就可以发现，obj.StartLongJob语句是立即返回的，不用等到一个耗时操作完成。这就是最简单的异步方法的效果。
注意：客户端程序需要先添加对Class Library Project的引用。

（7）被调用者一般还应提供一个方法执行完毕的事件，以便调用者在得到“执行完毕”的通知之后，执行一些相应的操作。为此，可修改StartLongJob方法，使用System.AsyncCallback类，提供自定义的事件：
Public Sub StartLongJob(ByVal milliSeconds As Integer)
' The instance of the delegate
Dim myDelegate As New LongRunningOperationDelegate(AddressOf DoLongJob)
' The instance of AsynchronousCallBack
Dim myCallBack As New System.AsyncCallback(AddressOf Me.DoPostJob)
Dim aResult As System.IAsyncResult
aResult = myDelegate.BeginInvoke(New JobArgs(milliSeconds), myCallBack, Nothing)
End Sub
其中，DoPostJob是一个用于触发事件的函数：
Public Event JobCompleted(ByVal progressEventArgs As ProgressEventArgs)
Private Sub DoPostJob(ByVal ar As System.IAsyncResult)
' Notify the caller of job completion
Dim evtArgs As New ProgressEventArgs
evtArgs.ProgressPercentage = 100.0
RaiseEvent JobCompleted(evtArgs)
End Sub
在BeginInvoke所调用的Delegate完成之后，此函数将被调用，这样就不需要不停地轮询操作是否已经完成了。
注意：ProgressEventArgs是一个继承自EventArgs的事件参数类：
Public Class ProgressEventArgs
Inherits EventArgs
Public ProgressPercentage As Single
End Class

（8）调用者做相应修改：
Dim obj As New LongOperation.AsynchronousProcess
AddHandler obj.JobCompleted, AddressOf Job_Completed
obj.StartLongJob(CInt(TextBox1.Text))
其中，Job_Completed是一个事件程序：
Private Sub Job_Completed(ByVal e As LongOperation.ProgressEventArgs)
MessageBox.Show(e.ProgressPercentage & "% finished.", Me.Text, MessageBoxButtons.OK)
End Sub

以上就是一个比较完整的异步操作的实现和调用过程。如果可能，异步方法还应该提供一种Processing事件，比如在一个循环中触发，事件参数中提供一个ByRef Cancel As Boolean，允许调用者中途停止被调用方法中的循环。