Modelo de programação assíncrona de tarefas

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

O C# oferece suporte a abordagem simplificada, programação assíncrona, que aproveita o suporte assíncrono no tempo de execução do .NET. O compilador faz o trabalho difícil que o desenvolvedor costumava fazer, e seu aplicativo mantém uma estrutura lógica que se assemelha ao 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 a programação assíncrona e inclui links para tópicos de suporte que contêm detalhes e exemplos.

Assíncrono melhora a capacidade de resposta

A assincronia é essencial para atividades que estão potencialmente bloqueando, como o acesso à web. O acesso a um recurso da Web às vezes é lento ou atrasado. Se tal 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 onde a programação assíncrona melhora a capacidade de resposta. As APIs listadas do .NET e do Tempo de Execução do Windows contêm métodos que oferecem suporte à programação assíncrona.

Área de aplicação	Tipos .NET com métodos assíncronos	Tipos do Tempo de Execução do Windows com métodos assíncronos
Acesso à Web	HttpClient	Windows.Web.Http.HttpClient SyndicationClient
Trabalhar com ficheiros	JsonSerializer StreamReader StreamWriter XmlReader XmlWriter	StorageFile
Trabalhar com imagens		MediaCapture BitmapEncoder BitmapDecoder
Programação WCF	Operações síncronas e assíncronas

A assincronia se mostra especialmente valiosa para aplicativos que acessam o thread da interface do usuário, porque todas as atividades relacionadas à interface do usuário geralmente compartilham um thread. Se algum 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, em vez disso, está apenas esperando.

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

A abordagem baseada em assincronia 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.

Os métodos assíncronos são fáceis de escrever

As palavras-chave async e await em C# são o coração da programação assíncrona. Usando essas duas palavras-chave, você pode usar recursos no .NET Framework, no .NET Core ou no Tempo de Execução do Windows para criar um método assíncrono quase tão facilmente quanto criar um método síncrono. Os métodos assíncronos que você define usando a palavra-chave são chamados de asyncmétodos assíncronos.

O exemplo a seguir mostra um método assíncrono. Quase tudo no código deve parecer familiar para você.

Você pode encontrar um exemplo completo do Windows Presentation Foundation (WPF) disponível para download em Programação assíncrona com assíncrono e aguardar em C#.

public async Task<int> GetUrlContentLengthAsync()
{
    using var client = new HttpClient();

    Task<string> getStringTask =
        client.GetStringAsync("https://learn.microsoft.com/dotnet");

    DoIndependentWork();

    string contents = await getStringTask;

    return contents.Length;
}

void DoIndependentWork()
{
    Console.WriteLine("Working...");
}

Você pode aprender várias práticas com o exemplo anterior. Comece com a assinatura do método. Inclui o async modificador. O tipo de retorno é Task<int> (Consulte a seção "Tipos de retorno" para obter mais opções). O nome do método termina em Async. No corpo do método, GetStringAsync retorna um Task<string>arquivo . Isso significa que quando você await a tarefa você vai ter um string (contents). Antes de aguardar a tarefa, você pode fazer um trabalho que não dependa string do GetStringAsync.

Preste muita atenção ao await operador. Suspende GetUrlContentLengthAsync:

• GetUrlContentLengthAsync não pode continuar até getStringTask estar concluído.
• Enquanto isso, o controle retorna para o chamador de GetUrlContentLengthAsync.
• O controle é retomado aqui quando getStringTask estiver concluído.
• Em await seguida, o operador recupera o string resultado de getStringTask.

A instrução return especifica um resultado inteiro. Todos os métodos que estão aguardando GetUrlContentLengthAsync recuperam o valor de comprimento.

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

string contents = await client.GetStringAsync("https://learn.microsoft.com/dotnet");

As características a seguir 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 "Async".

• O tipo de retorno é um dos seguintes tipos:

  • Task<TResult> se o seu método tiver uma instrução return na qual o operando tem o tipo TResult.
  • Task se o seu método não tiver nenhuma instrução de retorno ou tiver uma instrução de retorno sem operando.
  • void se você estiver escrevendo um manipulador de eventos assíncrono.
  • Qualquer outro tipo que tenha um GetAwaiter método.

  Para obter mais informações, consulte a seção Tipos e parâmetros de retorno.

• O método geralmente inclui pelo menos uma await expressão, que marca um ponto em que o método não pode continuar até que a operação assíncrona esperada 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 resto, incluindo acompanhar o que deve acontecer quando o controle retorna a um ponto de espera em um método suspenso. Alguns processos de rotina, 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 assincronia 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

A coisa 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 conduz você através do processo:

Os números no diagrama correspondem às etapas a seguir, iniciadas quando um método de chamada chama o método assíncrono.

1. Um método de chamada chama e aguarda o método assíncrono GetUrlContentLengthAsync .

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

3. Algo acontece que GetStringAsync suspende o seu progresso. Talvez deva esperar por um site para baixar ou alguma outra atividade de bloqueio. Para evitar o bloqueio de recursos, GetStringAsync cede o controle ao seu chamador, GetUrlContentLengthAsync.

   GetStringAsync Retorna um Task<TResult>, onde TResult é uma cadeia de caracteres e GetUrlContentLengthAsync atribui a tarefa à getStringTask variável. A tarefa representa o processo contínuo para a chamada para GetStringAsync, com um compromisso de produzir um valor de cadeia de caracteres real quando o trabalho for concluído.

4. Porque getStringTask ainda não foi aguardado, GetUrlContentLengthAsync pode continuar com outros trabalhos que não dependem do resultado final da 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 seu chamador.

6. GetUrlContentLengthAsync ficou sem trabalho que pode fazer sem um resultado de getStringTask. GetUrlContentLengthAsync next 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, GetUrlContentLengthAsync usa um operador await para suspender seu progresso e entregar o controle para o método que chamou GetUrlContentLengthAsync. GetUrlContentLengthAsync retorna a Task<int> para o chamador. A tarefa representa uma promessa de produzir um resultado inteiro que é o comprimento da cadeia de caracteres baixada.

   Nota

   Se GetStringAsync (e, portanto) getStringTaskcompletar antes GetUrlContentLengthAsync de esperar, o controle permanece em GetUrlContentLengthAsync. A despesa de suspender e depois voltar a GetUrlContentLengthAsync ser desperdiçada se o chamado processo getStringTask assíncrono já tiver sido concluído e GetUrlContentLengthAsync não tiver que esperar pelo resultado final.

   Dentro do método de chamada, o padrão de processamento continua. O chamador pode fazer outro trabalho que não depende do resultado de antes de GetUrlContentLengthAsync aguardar esse resultado, ou o chamador pode aguardar imediatamente. O método de chamada está aguardando GetUrlContentLengthAsynce GetUrlContentLengthAsync 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 da GetStringAsync maneira esperada. (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 contents.

8. Quando GetUrlContentLengthAsync tem o resultado da cadeia de caracteres, o método pode calcular o comprimento da cadeia de caracteres. Em seguida, o trabalho de também é concluído e o manipulador de eventos de GetUrlContentLengthAsync espera pode ser retomado. No exemplo completo no final do tópico, você pode confirmar que o manipulador de eventos recupera e imprime o valor do resultado de comprimento. Se você é novo na programação assíncrona, reserve um minuto para considerar a diferença entre 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.

Métodos assíncronos de API

Você pode estar se perguntando onde encontrar métodos como GetStringAsync os que suportam programação assíncrona. O .NET Framework 4.5 ou superior e o .NET Core contêm muitos membros que trabalham com async e await. Você pode reconhecê-los pelo sufixo "Async" que é anexado ao nome do membro e pelo tipo de retorno de Task ou Task<TResult>. Por exemplo, a System.IO.Stream classe contém métodos como CopyToAsync, ReadAsync, e WriteAsync ao lado dos métodos CopyTosíncronos , Reade Write.

O Tempo de Execução do Windows também contém muitos métodos que você pode usar com async e await em aplicativos do Windows. Para obter mais informações, consulte Threading e programação assíncrona para desenvolvimento UWP e Programação assíncrona (aplicativos da Windows Store) e Guia de início rápido: chamando APIs assíncronas em C# ou Visual Basic se você usar versões anteriores do Tempo de Execução do Windows.

Threads

Os métodos assíncronos destinam-se a ser 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 para o chamador do método assíncrono.

As async palavras-chave e await não fazem com que threads adicionais sejam criados. Os métodos assíncronos não exigem multithreading porque um método assíncrono não é executado em seu próprio 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 vinculado à 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 assincronia para programação assíncrona é preferível às abordagens existentes em quase todos os casos. Em particular, essa abordagem é melhor do que a BackgroundWorker classe para operações vinculadas 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 o método, a programação assíncrona Task.Run é melhor do que BackgroundWorker para operações ligadas à CPU porque a programação assíncrona separa os detalhes de coordenação da execução do código do trabalho que Task.Run é transferido para o pool de threads.

assíncrono e aguardar

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

• O método assíncrono marcado pode usar await para designar pontos de suspensão. O await operador informa ao compilador que o método assíncrono não pode continuar após esse ponto até que o processo assíncrono aguardado seja concluído. Enquanto isso, o controle retorna ao 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 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 expressões não causa um erro de await compilador. Se um método assíncrono não usa um await operador para marcar um ponto de suspensão, o método é executado como um método síncrono, apesar do async modificador. O compilador emite um aviso para tais métodos.

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

• assíncrono
• aguardar

Tipos e parâmetros de retorno

Um método assíncrono normalmente retorna um Task ou um Task<TResult>. Dentro de um método assíncrono, um await operador é aplicado a uma tarefa que é retornada de uma chamada para outro método assíncrono.

Você especifica Task<TResult> como o tipo de retorno se o método contém uma return instrução que especifica um operando do tipo TResult.

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

Você também pode especificar qualquer outro tipo de retorno, desde que o tipo inclua um GetAwaiter método. ValueTask<TResult> é um exemplo desse tipo. Ele está disponível no pacote NuGet System.Threading.Tasks.Extension .

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

async Task<int> GetTaskOfTResultAsync()
{
    int hours = 0;
    await Task.Delay(0);

    return hours;
}


Task<int> returnedTaskTResult = GetTaskOfTResultAsync();
int intResult = await returnedTaskTResult;
// Single line
// int intResult = await GetTaskOfTResultAsync();

async Task GetTaskAsync()
{
    await Task.Delay(0);
    // No return statement needed
}

Task returnedTask = GetTaskAsync();
await returnedTask;
// Single line
await GetTaskAsync();

Cada tarefa retornada representa o trabalho contínuo. 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 ter um tipo de void retorno. Esse tipo de retorno é usado principalmente para definir manipuladores de eventos, onde um tipo de void retorno é necessário. Os manipuladores de eventos assíncronos geralmente servem como ponto de partida para programas assíncronos.

Um método assíncrono que tem um void tipo de retorno não pode ser aguardado, e o chamador de um método de retorno de vazio não pode capturar nenhuma exceção que o método lança.

Um método assíncrono não pode declarar parâmetros in, ref ou out , mas o método pode chamar métodos que tenham esses parâmetros. Da mesma forma, um método assíncrono não pode retornar um valor por referência, embora possa chamar métodos com valores de retorno ref.

Para obter mais informações e exemplos, consulte Tipos de retorno assíncronos (C#).

As APIs assíncronas na programação do Tempo de Execução do Windows têm um dos seguintes tipos de retorno, que são semelhantes às tarefas:

• IAsyncOperation<TResult>, que corresponde a Task<TResult>
• IAsyncAction, que corresponde a Task
• IAsyncActionWithProgress<TProgress>
• IAsyncOperationWithProgress<TResult,TProgress>

Convenção de nomenclatura

Por convenção, os métodos que retornam tipos comumente esperados (por exemplo, Task, , Task<T>ValueTask, ValueTask<T>) devem ter nomes que terminam com "Async". Os métodos que iniciam uma operação assíncrona, mas não retornam um tipo aguardado, não devem ter nomes que terminem com "Async", mas podem começar com "Begin", "Start" ou algum outro verbo para sugerir que esse método não retorna ou lança o resultado da operação.

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

Artigos relacionados (Visual Studio)

Title	Description
Como fazer várias solicitações da Web em paralelo usando async e await (C#)	Demonstra como iniciar várias tarefas ao mesmo tempo.
Tipos de retorno assíncronos (C#)	Ilustra os tipos que os métodos assíncronos podem retornar e explica quando cada tipo é apropriado.
Cancele tarefas com um token de cancelamento como mecanismo de sinalização.	Mostra como adicionar a seguinte funcionalidade à sua solução assíncrona: - Cancelar uma lista de tarefas (C#) - Cancelar tarefas após um período de tempo (C#) - Processar tarefas assíncronas à medida que são concluídas (C#)
Usando assíncrono para acesso a arquivos (C#)	Lista e demonstra os benefícios de usar async e await para acessar arquivos.
Padrão assíncrono baseado em tarefas (TAP)	Descreve um padrão assíncrono Task , o padrão é baseado nos tipos e Task<TResult> .
Vídeos assíncronos no Canal 9	Fornece links para uma variedade de vídeos sobre programação assíncrona.

Consulte também

• Programação assíncrona com async e aguarde
• assíncrono
• aguardar