Async (Visual Basic)

  • 發行項

Async 修飾詞表示其修飾的方法或 Lambda 運算式是非同步的。 此類方法稱為非同步方法。

非同步方法提供了方便進行可能需要長時間執行之工作的方式，而不需封鎖呼叫端的執行緒。 非同步方法的呼叫端可以繼續執行其工作，而不需等待非同步方法完成。

注意

Async 和 Await 關鍵字是在 Visual Studio 2012 中引入。 如需非同步程式設計的簡介，請參閱使用 async 和 await 進行非同步程式設計。

以下範例將示範非同步方法的結構。 依照慣例，非同步方法的名稱會以 "Async" 結尾。

Public Async Function ExampleMethodAsync() As Task(Of Integer)
    ' . . .

    ' At the Await expression, execution in this method is suspended and,
    ' if AwaitedProcessAsync has not already finished, control returns
    ' to the caller of ExampleMethodAsync. When the awaited task is
    ' completed, this method resumes execution.
    Dim exampleInt As Integer = Await AwaitedProcessAsync()

    ' . . .

    ' The return statement completes the task. Any method that is
    ' awaiting ExampleMethodAsync can now get the integer result.
    Return exampleInt
End Function

通常 Async 關鍵字所修飾的方法會包含至少一個 Await 運算式或陳述式。 方法會以同步方式執行，直到達到第一個 Await，此時它會暫止，直到等候的工作完成。 同時，控制權會返回方法的呼叫端。 如果方法未包含 Await 運算式或陳述式，則方法就不會暫止，並且會像同步方法一樣執行。 如果有任何非同步方法未包含 Await，編譯器警告就會發出警示，因為這種情況可能表示發生錯誤。 如需詳細資訊，請參閱編譯器錯誤。

Async 關鍵字是未保留的關鍵字。 它是修飾方法或 Lambda 運算式時的關鍵字。 在所有其他內容中，它會解譯為識別項。

傳回型別

非同步方法是 Sub 程序，或是傳回類行為 Task 或 Task<TResult> 的 Function 程序。 此方法無法宣告任何 ByRef 參數。

如果方法的 Return 陳述式擁有 TResult 類型的運算元，則您必須指定 Task(Of TResult) 做為非同步方法的傳回型別。 如果方法完成時未傳回任何有意義的值，則使用 Task。 也就是說，呼叫方法會傳回 Task，但是當 Task 完成時，任何等候 Await 的 Task 陳述式都不會產生結果值。

Async 副程式主要是用來定義需要 Sub 程序的事件處理常式。 非同步副程式的呼叫端無法等候它，而且無法攔截方法擲回的例外狀況。

如需詳細資訊和範例，請參閱非同步方法的傳回型別。

範例

下列範例將示範非同步事件處理常式、非同步 Lambda 運算式及非同步方法。 如需使用這些項目的完整範例，請參閱逐步解說：使用 async 和 await 存取 Web。 您可以從 .NET 範例瀏覽器下載範例。 範例程式碼位於 SerialAsyncExample 專案中。

' An event handler must be a Sub procedure.
Async Sub button1_Click(sender As Object, e As RoutedEventArgs) Handles button1.Click
    textBox1.Clear()
    ' SumPageSizesAsync is a method that returns a Task.
    Await SumPageSizesAsync()
    textBox1.Text = vbCrLf & "Control returned to button1_Click."
End Sub

' The following async lambda expression creates an equivalent anonymous
' event handler.
AddHandler button1.Click, Async Sub(sender, e)
                              textBox1.Clear()
                              ' SumPageSizesAsync is a method that returns a Task.
                              Await SumPageSizesAsync()
                              textBox1.Text = vbCrLf & "Control returned to button1_Click."
                          End Sub

' The following async method returns a Task(Of T).
' A typical call awaits the Byte array result:
'      Dim result As Byte() = Await GetURLContents("https://msdn.com")
Private Async Function GetURLContentsAsync(url As String) As Task(Of Byte())

    ' The downloaded resource ends up in the variable named content.
    Dim content = New MemoryStream()

    ' Initialize an HttpWebRequest for the current URL.
    Dim webReq = CType(WebRequest.Create(url), HttpWebRequest)

    ' Send the request to the Internet resource and wait for
    ' the response.
    Using response As WebResponse = Await webReq.GetResponseAsync()
        ' Get the data stream that is associated with the specified URL.
        Using responseStream As Stream = response.GetResponseStream()
            ' Read the bytes in responseStream and copy them to content.
            ' CopyToAsync returns a Task, not a Task<T>.
            Await responseStream.CopyToAsync(content)
        End Using
    End Using

    ' Return the result as a byte array.
    Return content.ToArray()
End Function

另請參閱