Compartilhar via


Programação assíncrona com Async e Await (Visual Basic)

Você pode evitar gargalos de desempenho e aprimorar a capacidade de resposta geral do aplicativo usando programação assíncrona. No entanto, as técnicas tradicionais para desenvolver aplicativos assíncronos podem ser complicadas, dificultando seu desenvolvimento, depuração e manutenção.

O Visual Studio 2012 introduziu uma abordagem simplificada, programação assíncrona, que aproveita o suporte assíncrono no .NET Framework 4.5 e superior, bem como no Windows Runtime. O compilador faz o trabalho difícil que o desenvolvedor costumava fazer e seu aplicativo mantém uma estrutura lógica semelhante a um código síncrono. Como resultado, você obtém todas as vantagens da programação assíncrona com uma fração do esforço.

Este tópico fornece uma visão geral de quando e como usar programação assíncrona e inclui links para tópicos de suporte que contêm detalhes e exemplos.

Async melhora a capacidade de resposta

A assincronia é essencial para atividades que podem bloquear, como quando seu aplicativo acessa a Web. Às vezes, o acesso a um recurso da Web é lento ou atrasado. Se essa atividade for bloqueada em um processo síncrono, todo o aplicativo deverá aguardar. Em um processo assíncrono, o aplicativo pode continuar com outro trabalho que não depende do recurso da Web até que a tarefa potencialmente bloqueada seja concluída.

A tabela a seguir mostra áreas típicas em que a programação assíncrona melhora a capacidade de resposta. As APIs listadas do .NET Framework 4.5 e do Windows Runtime contêm métodos que dão suporte à programação assíncrona.

Área do aplicativo Suportando APIs que contêm métodos assíncronos
Acesso à Web HttpClient, SyndicationClient
Trabalhando com arquivos StorageFile, StreamWriter, , StreamReaderXmlReader
Trabalhando com imagens MediaCapture BitmapEncoder BitmapDecoder
Programação do WCF Operações síncronas e assíncronas

A assincronia é especialmente importante para aplicativos que acessam o thread de interface de usuário porque todas as atividades relacionadas à interface do usuário normalmente compartilham um único thread. Se qualquer processo for bloqueado em um aplicativo síncrono, todos serão bloqueados. Seu aplicativo para de responder e você pode concluir que ele falhou quando estiver apenas aguardando.

Quando você usa métodos assíncronos, o aplicativo continua respondendo à interface do usuário. Você pode redimensionar ou minimizar uma janela, por exemplo, ou fechar o aplicativo se não quiser esperar que ela seja concluída.

A abordagem baseada em assíncrona adiciona o equivalente a uma transmissão automática à lista de opções que você pode escolher ao projetar operações assíncronas. Ou seja, você obtém todos os benefícios da programação assíncrona tradicional, mas com muito menos esforço do desenvolvedor.

Métodos assíncronos são mais fáceis de gravar

As palavras-chave Async e Await no Visual Basic são o coração da programação assíncrona. Usando essas duas palavras-chave, você pode usar recursos no .NET Framework ou no Windows Runtime para criar um método assíncrono quase tão facilmente quanto criar um método síncrono. Métodos assíncronos que você define usando Async e Await são chamados de métodos assíncronos.

O exemplo a seguir mostra um método assíncrono. Quase tudo no código deve parecer completamente familiar para você. Os comentários destacam os recursos que você adiciona para criar a assincronia.

Você pode encontrar um arquivo de exemplo completo do Windows Presentation Foundation (WPF) no final deste tópico e pode baixar o exemplo de Exemplo Assíncrono: Exemplo de "Programação Assíncrona com Async e Await".

' Three things to note about writing an Async Function:
'  - The function has an Async modifier.
'  - Its return type is Task or Task(Of T). (See "Return Types" section.)
'  - As a matter of convention, its name ends in "Async".
Async Function AccessTheWebAsync() As Task(Of Integer)
    Using client As New HttpClient()
        ' Call and await separately.
        '  - AccessTheWebAsync can do other things while GetStringAsync is also running.
        '  - getStringTask stores the task we get from the call to GetStringAsync.
        '  - Task(Of String) means it is a task which returns a String when it is done.
        Dim getStringTask As Task(Of String) =
            client.GetStringAsync("https://learn.microsoft.com/dotnet")
        ' You can do other work here that doesn't rely on the string from GetStringAsync.
        DoIndependentWork()
        ' The Await operator suspends AccessTheWebAsync.
        '  - AccessTheWebAsync does not continue until getStringTask is complete.
        '  - Meanwhile, control returns to the caller of AccessTheWebAsync.
        '  - Control resumes here when getStringTask is complete.
        '  - The Await operator then retrieves the String result from getStringTask.
        Dim urlContents As String = Await getStringTask
        ' The Return statement specifies an Integer result.
        ' A method which awaits AccessTheWebAsync receives the Length value.
        Return urlContents.Length

    End Using

End Function

Se AccessTheWebAsync não tiver nenhum trabalho que possa fazer entre chamar GetStringAsync e aguardar sua conclusão, você poderá simplificar seu código chamando e aguardando na instrução única a seguir.

Dim urlContents As String = Await client.GetStringAsync()

As seguintes características resumem o que torna o exemplo anterior um método assíncrono:

  • A assinatura do método inclui um Async modificador.

  • O nome de um método assíncrono, por convenção, termina com um sufixo "Assíncrono".

  • O tipo de retorno é um dos seguintes tipos:

    • Task(Of TResult) se o seu método tiver uma instrução de retorno na qual o operando tem o tipo TResult.
    • Task se o método não tiver nenhuma instrução de retorno ou tiver uma instrução de retorno sem operando.
    • Sub se você estiver escrevendo um manipulador de eventos assíncrono.

    Para obter mais informações, consulte "Tipos e parâmetros de retorno" mais adiante neste tópico.

  • O método geralmente inclui pelo menos uma expressão await, que marca um ponto em que o método não pode continuar até que a operação assíncrona aguardada seja concluída. Enquanto isso, o método é suspenso e o controle retorna ao chamador do método. A próxima seção deste tópico ilustra o que acontece no ponto de suspensão.

Em métodos assíncronos, você usa as palavras-chave e os tipos fornecidos para indicar o que deseja fazer e o compilador faz o restante, incluindo manter o controle do que deve acontecer quando o controle retorna a um ponto de espera em um método suspenso. Alguns processos rotineiros, como loops e tratamento de exceções, podem ser difíceis de lidar no código assíncrono tradicional. Em um método assíncrono, você escreve esses elementos da mesma forma que faria em uma solução síncrona e o problema é resolvido.

Para obter mais informações sobre assíncrona em versões anteriores do .NET Framework, consulte TPL e Programação Assíncrona tradicional do .NET Framework.

O que acontece em um método assíncrono

O mais importante a entender na programação assíncrona é como o fluxo de controle se move de método para método. O diagrama a seguir leva você ao processo:

Diagrama que mostra o rastreamento de um programa assíncrono.

Os números no diagrama correspondem às seguintes etapas:

  1. Um manipulador de eventos chama e aguarda o método assíncrono AccessTheWebAsync.

  2. AccessTheWebAsync cria uma HttpClient instância e chama o GetStringAsync método assíncrono para baixar o conteúdo de um site como uma cadeia de caracteres.

  3. Algo acontece em GetStringAsync que suspende seu progresso. Talvez ele deva aguardar o download de um site ou alguma outra atividade causadora de bloqueio. Para evitar o bloqueio de recursos, GetStringAsync gera controle ao chamador. AccessTheWebAsync

    GetStringAsync retorna uma Tarefa(de TResult) em que TResult é uma cadeia de caracteres e AccessTheWebAsync atribui a tarefa à getStringTask variável. A tarefa representa o processo contínuo para a chamada a GetStringAsync, com um compromisso de produzir um valor de cadeia de caracteres real quando o trabalho estiver concluído.

  4. Como getStringTask ainda não foi aguardado, AccessTheWebAsync pode continuar com outros trabalhos que não dependem do resultado final de GetStringAsync. Esse trabalho é representado por uma chamada para o método DoIndependentWorksíncrono.

  5. DoIndependentWork é um método síncrono que faz seu trabalho e retorna ao chamador.

  6. AccessTheWebAsync está sem trabalho que ele possa executar sem um resultado de getStringTask. AccessTheWebAsync Em seguida, deseja calcular e retornar o comprimento da cadeia de caracteres baixada, mas o método não pode calcular esse valor até que o método tenha a cadeia de caracteres.

    Portanto, AccessTheWebAsync usa um operador await para suspender seu progresso e gerar controle ao método chamado AccessTheWebAsync. AccessTheWebAsync retorna um Task(Of Integer) para o chamador. A tarefa representa uma promessa de produzir um resultado inteiro que é o comprimento da cadeia de caracteres baixada.

    Observação

    Se GetStringAsync (e portanto getStringTask) for concluído antes que AccessTheWebAsync o espere, o controle permanecerá em AccessTheWebAsync. A despesa de suspender e retornar AccessTheWebAsync será desperdiçada se o processo assíncrono chamado (getStringTask) já tiver sido concluído e AccessTheWebSync não precisar aguardar o resultado final.

    Dentro do chamador (o manipulador de eventos neste exemplo), o padrão de processamento continua. O chamador pode realizar outro trabalho que não dependa do resultado de AccessTheWebAsync antes de aguardar esse resultado, ou o chamador pode aguardar imediatamente. O manipulador de eventos está aguardando AccessTheWebAsynce AccessTheWebAsync está aguardando GetStringAsync.

  7. GetStringAsync completa e produz um resultado de cadeia de caracteres. O resultado da cadeia de caracteres não é retornado pela chamada GetStringAsync da maneira que você pode esperar. (Lembre-se de que o método já retornou uma tarefa na etapa 3.) Em vez disso, o resultado da cadeia de caracteres é armazenado na tarefa que representa a conclusão do método. getStringTask O operador await recupera o resultado de getStringTask. A instrução de atribuição atribui o resultado recuperado a urlContents.

  8. Quando AccessTheWebAsync tem o resultado da cadeia de caracteres, o método pode calcular o comprimento da cadeia de caracteres. Em seguida, o trabalho de AccessTheWebAsync também é concluído e o manipulador de eventos de espera poderá retomar. No exemplo completo no final do tópico, é possível confirmar que o manipulador de eventos recuperou e imprimiu o valor do comprimento do resultado.

Se você não estiver familiarizado com a programação assíncrona, leve um minuto para considerar a diferença entre o comportamento síncrono e assíncrono. Um método síncrono retorna quando seu trabalho é concluído (etapa 5), mas um método assíncrono retorna um valor de tarefa quando seu trabalho é suspenso (etapas 3 e 6). Quando o método assíncrono eventualmente conclui seu trabalho, a tarefa é marcada como concluída e o resultado, se houver, é armazenado na tarefa.

Para obter mais informações sobre o fluxo de controle, consulte Fluxo de Controle em Programas Assíncronos (Visual Basic).

Métodos Assíncronos da API

Você pode estar se perguntando onde encontrar métodos como GetStringAsync que dão suporte à programação assíncrona. O .NET Framework 4.5 ou superior contém muitos membros que trabalham com Async e Await. Você pode reconhecer esses membros pelo sufixo "Async" anexado ao nome do membro e um tipo de retorno de Task ou Task(Of TResult). Por exemplo, a System.IO.Stream classe contém métodos como CopyToAsync, ReadAsynce WriteAsync ao lado dos métodos CopyTosíncronos, Reade Write.

O Windows Runtime também contém muitos métodos que você pode usar com Async e Await em aplicativos do Windows. Para obter mais informações e métodos de exemplo, consulte Chamar APIs assíncronas em C# ou Visual Basic, programação assíncrona (aplicativos do Windows Runtime) e WhenAny: Ponte entre o .NET Framework e o Windows Runtime.

Fios

Os métodos assíncronos destinam-se a operações sem bloqueio. Uma Await expressão em um método assíncrono não bloqueia o thread atual enquanto a tarefa aguardada está em execução. Em vez disso, a expressão inscreve o restante do método como uma continuação e retorna o controle ao chamador do método assíncrono.

As palavras-chave Async e Await não fazem com que threads adicionais sejam criadas. Os métodos assíncronos não exigem multithreading porque um método assíncrono não é executado em sua própria thread. O método é executado no contexto de sincronização atual e usa o tempo no thread somente quando o método está ativo. Você pode usar Task.Run para mover o trabalho associado à CPU para um thread em segundo plano, mas um thread em segundo plano não ajuda com um processo que está apenas aguardando que os resultados fiquem disponíveis.

A abordagem baseada em async para programação assíncrona é preferível às abordagens existentes em quase todos os casos. Em particular, essa abordagem é melhor do que BackgroundWorker para operações associadas a E/S porque o código é mais simples e você não precisa se proteger contra condições de corrida. Em combinação com Task.Run, a programação assíncrona é melhor do que BackgroundWorker para operações que são limitadas pela CPU, pois a programação assíncrona separa os detalhes de coordenação da execução do seu código do trabalho que Task.Run transfere para o threadpool.

Async e Await

Se você especificar que um método é um método assíncrono usando um modificador assíncrono , habilite os dois recursos a seguir.

  • O método assíncrono marcado pode usar Await para designar pontos de suspensão. O operador await informa ao compilador que o método assíncrono não pode continuar além desse ponto até que o processo assíncrono aguardado seja concluído. Enquanto isso, o controle retorna para o chamador do método assíncrono.

    A suspensão de um método assíncrono em uma Await expressão não constitui uma saída do método e Finally os blocos não são executados.

  • O método assíncrono marcado pode ele próprio ser aguardado por métodos que o chamam.

Um método assíncrono normalmente contém uma ou mais ocorrências de um Await operador, mas a ausência de Await expressões não causa um erro do compilador. Se um método assíncrono não usar um Await operador para marcar um ponto de suspensão, o método será executado como um método síncrono, apesar do Async modificador. O compilador emite um aviso para esses métodos.

Async e Await são palavras-chave contextuais. Para obter mais informações e exemplos, consulte os seguintes tópicos:

Tipos e parâmetros de retorno

Na programação do .NET Framework, um método assíncrono normalmente retorna um Task ou um Task(Of TResult). Dentro de um método assíncrono, um Await operador é aplicado a uma tarefa retornada de uma chamada para outro método assíncrono.

Especifique Task(Of TResult) como o tipo de retorno se o método contiver uma instrução Return que especifica um operando do tipo TResult.

Você usará Task como o tipo de retorno se o método não tiver nenhuma instrução de retorno ou tiver uma instrução de retorno que não retorne um operando.

O exemplo a seguir mostra como você declara e chama um método que retorna um Task(Of TResult) ou um Task:

' Signature specifies Task(Of Integer)
Async Function TaskOfTResult_MethodAsync() As Task(Of Integer)

    Dim hours As Integer
    ' . . .
    ' Return statement specifies an integer result.
    Return hours
End Function

' Calls to TaskOfTResult_MethodAsync
Dim returnedTaskTResult As Task(Of Integer) = TaskOfTResult_MethodAsync()
Dim intResult As Integer = Await returnedTaskTResult
' or, in a single statement
Dim intResult As Integer = Await TaskOfTResult_MethodAsync()

' Signature specifies Task
Async Function Task_MethodAsync() As Task

    ' . . .
    ' The method has no return statement.
End Function

' Calls to Task_MethodAsync
Task returnedTask = Task_MethodAsync()
Await returnedTask
' or, in a single statement
Await Task_MethodAsync()

Cada tarefa retornada representa o trabalho em andamento. Uma tarefa encapsula informações sobre o estado do processo assíncrono e, eventualmente, o resultado final do processo ou a exceção que o processo gera se não for bem-sucedido.

Um método assíncrono também pode ser um Sub método. Esse tipo de retorno é usado principalmente para definir manipuladores de eventos, em que um tipo de retorno é necessário. Manipuladores de eventos assíncronos geralmente servem como ponto de partida para programas assíncronos.

Um método assíncrono que é um procedimento Sub não pode ser esperado, e o chamador não pode capturar nenhuma exceção acionada pelo método.

Um método assíncrono não pode declarar parâmetros ByRef , mas o método pode chamar métodos que têm esses parâmetros.

Para obter mais informações e exemplos, consulte Tipos de Retorno Assíncronos (Visual Basic). Para obter mais informações sobre como capturar exceções em métodos assíncronos, consulte Try...Catch...Finally Statement.

As APIs assíncronas na programação do Windows Runtime têm um dos seguintes tipos de retorno, semelhantes a tarefas:

Para obter mais informações e um exemplo, consulte Chamar APIs assíncronas em C# ou Visual Basic.

Convenção de nomenclatura

Por convenção, você acrescenta "Async" aos nomes dos métodos que têm um Async modificador.

Você pode ignorar a convenção em que um evento, uma classe base ou um contrato de interface sugere um nome diferente. Por exemplo, você não deve renomear manipuladores de eventos comuns, como Button1_Click.

Tópicos e exemplos relacionados (Visual Studio)

Título Descrição Amostra
Passo a passo: acessando a Web usando Async e Await (Visual Basic) Mostra como converter uma solução do WPF síncrona em uma solução assíncrona do WPF. O aplicativo baixa uma série de sites. Exemplo Async: programação assíncrona com Async e Await (Visual Basic)
Como estender o passo a passo assíncrono usando Task.WhenAll (Visual Basic) Adiciona Task.WhenAll à explicação passo a passo anterior. O uso de WhenAll inicia todos os downloads ao mesmo tempo.
Como fazer várias solicitações da Web em paralelo usando Async e Await (Visual Basic) Demonstra como iniciar várias tarefas ao mesmo tempo. Exemplo assíncrono: fazer várias solicitações da Web em paralelo
Tipos de retorno assíncronos (Visual Basic) Ilustra os tipos que os métodos assíncronos podem retornar e explica quando cada tipo é apropriado.
Fluxo de controle em programas assíncronos (Visual Basic) Rastreia em detalhes o fluxo de controle através de uma sequência de expressões 'await' em um programa assíncrono. Exemplo assíncrono: fluxo de controle em programas assíncronos
Fine-Tuning Seu Aplicativo Assíncrono (Visual Basic) Mostra como adicionar a seguinte funcionalidade à sua solução assíncrona:

- Cancelar uma tarefa assíncrona ou uma lista de tarefas (Visual Basic)
- Cancelar tarefas assíncronas após um período de tempo (Visual Basic)
- Cancelar tarefas assíncronas restantes após a conclusão de uma (Visual Basic)
- Iniciar várias tarefas assíncronas e processá-las conforme elas são concluídas (Visual Basic)
Exemplo assíncrono: ajuste fino do aplicativo
Manipulando a reentração em aplicativos assíncronos (Visual Basic) Mostra como lidar com casos em que uma operação assíncrona ativa é reiniciada enquanto está em execução.
WhenAny: Ponte entre o .NET Framework e o Windows Runtime Mostra como fazer a ponte entre tipos de tarefa no .NET Framework e IAsyncOperations no Windows Runtime para que você possa usar WhenAny com um método do Windows Runtime. Exemplo assíncrono: ponte entre o .NET e o Windows Runtime (AsTask e WhenAny)
Cancelamento assíncrono: ponte entre o .NET Framework e o Windows Runtime Mostra como fazer a ponte entre tipos de tarefa no .NET Framework e IAsyncOperations no Windows Runtime para que você possa usar CancellationTokenSource com um método do Windows Runtime. Exemplo de assincronia: ponte entre o .NET e o Windows Runtime (AsTask & Cancellation)
Usando Assíncrono para Acesso a Arquivos (Visual Basic) Lista e demonstra os benefícios de usar assíncrono e aguardar para acessar arquivos.
TAP (Padrão Assíncrono baseado em tarefa) Descreve um novo padrão para assíncrona no .NET Framework. O padrão é baseado nos tipos Task e Task(Of TResult).

Exemplo completo

O código a seguir é o arquivo MainWindow.xaml.vb do aplicativo WPF (Windows Presentation Foundation) que este tópico aborda. Você pode baixar a amostra de Async Sample: Exemplo da 'Programação Assíncrona com Async e Await'.


Imports System.Net.Http

' Example that demonstrates Asynchronous Programming with Async and Await.
' It uses HttpClient.GetStringAsync to download the contents of a website.
' Sample Output:
' Working . . . . . . .
'
' Length of the downloaded string: 39678.

Class MainWindow

    ' Mark the event handler with Async so you can use Await in it.
    Private Async Sub StartButton_Click(sender As Object, e As RoutedEventArgs)

        ' Call and await immediately.
        ' StartButton_Click suspends until AccessTheWebAsync is done.
        Dim contentLength As Integer = Await AccessTheWebAsync()

        ResultsTextBox.Text &= $"{vbCrLf}Length of the downloaded string: {contentLength}.{vbCrLf}"

    End Sub


    ' Three things to note about writing an Async Function:
    '  - The function has an Async modifier.
    '  - Its return type is Task or Task(Of T). (See "Return Types" section.)
    '  - As a matter of convention, its name ends in "Async".
    Async Function AccessTheWebAsync() As Task(Of Integer)

        Using client As New HttpClient()

            ' Call and await separately.
            '  - AccessTheWebAsync can do other things while GetStringAsync is also running.
            '  - getStringTask stores the task we get from the call to GetStringAsync.
            '  - Task(Of String) means it is a task which returns a String when it is done.
            Dim getStringTask As Task(Of String) =
                client.GetStringAsync("https://learn.microsoft.com/dotnet")

            ' You can do other work here that doesn't rely on the string from GetStringAsync.
            DoIndependentWork()

            ' The Await operator suspends AccessTheWebAsync.
            '  - AccessTheWebAsync does not continue until getStringTask is complete.
            '  - Meanwhile, control returns to the caller of AccessTheWebAsync.
            '  - Control resumes here when getStringTask is complete.
            '  - The Await operator then retrieves the String result from getStringTask.
            Dim urlContents As String = Await getStringTask

            ' The Return statement specifies an Integer result.
            ' A method which awaits AccessTheWebAsync receives the Length value.
            Return urlContents.Length

        End Using

    End Function

    Sub DoIndependentWork()
        ResultsTextBox.Text &= $"Working . . . . . . .{vbCrLf}"
    End Sub

End Class

Consulte também