Breno Ferreira

Opniões e códigos de um desenvolvedor de software .NET.

Async no C# 5–Advanced

leave a comment »

Olá pessoal, tudo bem?

Há algum tempo atrás, eu postei aqui no blog sobre assincronia no C# 5. Hoje irei continuar falando sobre o assunto, porém, irei abordar alguns conceitos um pouco mais avançados para que voce consiga entender melhor como as coisas funcionam e tirar melhor proveito dessa nova funcionalidade da linguagem.

Under the Covers

Acho que sempre é bom saber o que acontece por debaixo dos panos, então, quando abri o código que o compilador do C# gera quando utilizamos o await, vi o seguinte trecho de código:

Esse código:

var webClient = new WebClient();
var html = await webClient.DownloadStringTaskAsync("http://www.bing.com");
return html;

Vira este código:

private struct <DownloadBingHomePageHTMLAsync>d__3 : <>t__IStateMachine
{
	private int <>1__state;
	public AsyncTaskMethodBuilder<string> <>t__builder;
	public Action <>t__MoveNextDelegate;
	public WebClient <webClient>5__4;
	public string <html>5__5;
	private object <>t__stack;
	private object <>t__awaiter;
	public void MoveNext()
	{
		string result;
		try
		{
			int num = this.<>1__state;
			TaskAwaiter<string> taskAwaiter;
			if (num != 1) //if execution of async method is not finished (State == 1 means that the execution is running)
			{
				if (this.<>1__state == -1)
				{
					return;
				}
				this.<webClient>5__4 = new WebClient();
				taskAwaiter = this.<webClient>5__4.DownloadStringTaskAsync("http://www.bing.com").GetAwaiter(); //start the async operation, and get the TaskAwaiter
				if (!taskAwaiter.IsCompleted) //if the async operation is not completed
				{
					this.<>1__state = 1; //set the state to "Running"
					TaskAwaiter<string>[] array;
					(array = new TaskAwaiter<string>[1])[0] = taskAwaiter;
					this.<>t__awaiter = array;
					Action action;
					if ((action = this.<>t__MoveNextDelegate) == null)
					{
						Task<string> arg_9A_0 = this.<>t__builder.Task;
						action = new Action(this.MoveNext); //define a delegate to the method itself.
						((<>t__IStateMachine)action.Target).<>t__SetMoveNextDelegate(action);
					}
					array[0].OnCompleted(action); //use that delegate (which points to the method itself) as a method which will be called when the async operation completes
					return;
				}
			}
			else //if the async is complete
			{
				taskAwaiter = ((TaskAwaiter<string>[])this.<>t__awaiter)[0]; //get the TaskAwaiter
				this.<>t__awaiter = null;
				this.<>1__state = 0; //set the state to "Initial"
			}
			string arg_110_0 = taskAwaiter.GetResult(); //get the result of the async operation from the TaskAwaiter
			taskAwaiter = default(TaskAwaiter<string>);
			string text = arg_110_0; //continue with the execution of the code that was defined after the "await" keyword (in this case, return the html as a String)
			this.<html>5__5 = text;
			result = this.<html>5__5;
		}
		catch (Exception exception)
		{
			this.<>1__state = -1;
			this.<>t__builder.SetException(exception);
			return;
		}
		this.<>1__state = -1; //set the result to "Complete"
		this.<>t__builder.SetResult(result);
	}
	[DebuggerHidden]
	void <>t__IStateMachine.<>t__SetMoveNextDelegate(Action param0)
	{
		this.<>t__MoveNextDelegate = param0;
	}
}

É um trecho de código bem extenso, como voce pode ver. Adicionei alguns comentários para que voce possa entender melhor, mas irei explicar melhor o que acontece.
Para cada await que adicionamos ao nosso código, o compilador cria uma estrutura de máquina de estados, responsável por coordenar a operação assíncrona e dar continuidade a execução do código.

Dentro da estrutura, há um método chamado MoveNext que possui toda a lógica. Basicamente ele é chamado quando há uma keyword await. Quando este método é chamado, ele verifica se a operação assíncrona já foi iniciada. Como ainda não foi, ele inicia a execução assíncrona, e então seta o estado para “Running“. Então ele guarda uma referencia para um Awaiter que será usado para definir um callback que será chamado quando a operação assíncrona terminar. Esse callback é definido para a própria função (MoveNext). Quando a operação termina, o método MoveNext() é novamente chamado, mas dessa vez ele verifica que o estado é “Running”, então com a referencia para o Awaiter ele pega o resultado retornado pela operação assíncrona e continua com a execução do código.

Tasks & Threads

Outro conceito bem importante de saber ao usar Tasks e Async é que essas Tasks não adicionam Threads adicionais. Ou seja, voce não precisa se preocupar com acesso concorrente, locks entre outros problemas inerentes a programação paralela. É claro que a operação assíncrona poderá ser executada em uma Thread separada (caso contrário é quase impossível executar um código de maneira assíncrona), mas nenhuma Thread extra será criada. O async e await são simplesmente syntax-sugars para callbacks. Podemos ver isso no código a seguir:

private Task<String> DownloadStringAsync(string uri)
{
    var webclient = new WebClient();

    var downloadTaskCompletionSource = new TaskCompletionSource<String>();
    var downloadTask = downloadTaskCompletionSource.Task;

    webclient.DownloadStringCompleted += (sender, e) =>
        {
            downloadTaskCompletionSource.SetResult(e.Result);
        };

    webclient.DownloadStringAsync( new Uri(uri));
    return downloadTask;
}

string str = await DownloadStringAsync("http://www.google.com");

No código acima, utilizamos a classe TaskCompletionSource, que pode ser usada para devolver uma Task associada à uma operação assíncrona. Neste caso, a Task será usada simplesmente para representar a operação assíncrona e dar ao usuário o poder de setar Continuations. Não há nenhuma Thread adicional envolvida.

UI, Libs & Synchronization Contexts

Quando escrevemos código assíncrono antigamente, as vezes tínhamos que nos preocupar com execução de código em Threads apropriadas. Por exemplo: quando executamos método assíncrono na camada de apresentação, por exemplo em Silverlight, WPF, etc., quando o callback do método assíncrono era chamado para tratarmos o resultado, precisávamos trocar o contexto das Threads caso fosse necessário fazer alguma atualização na interface. Para fazermos isso, era utilizado um SynchronizationContext (em Silverlight ou WPF era mais conhecido pela propriedade Dispatcher) que era responsável por enfileirar um delegate para execução na UI Thread (Thread responsável por renderizar os elementos de interface e tratar qualquer interação com o usuário).

Por padrão, quando utilizamos a keyword await, esse processo de troca de contexto de Threads é feito de maneira automática, ou seja, quando a operação assíncrona terminar, ele automaticamente utiliza o SynchroniationContext padrão para voltar para a Thread ideal. Isso é muito bom quando estamos desenvolvendo nossas aplicações que possuem algum tipo de UI (User Interface), como na maioria dos casos. Mas se estivermos desenvolvendo alguma biblioteca reutilizável, esse comportamento pode não ser o mais apropriado. Primeiro que essa troca de contexto tem um custo de performance que pode não ser apropriado, segundo que seu uso pode vir a ter alguns efeitos colaterais indesejados. Imagine o seguinte:

async Task AsyncOp()
{
	Task.Delay(1000); //simulate asynchronous operation
}

var task = AsyncOp();
task.Wait();

Esse código irá causar um deadlock. Porque? Acontece que quando chamamos o método Wait() de uma Task, ele bloqueia a Thread até a operação da Task terminar. Mas quando a operação assíncrona terminar e ele passar pelo await, ele vai tentar voltar para a UI Thread, que vai estar bloqueada, então temos um deadlock.
Para isso não acontecer, basta chamarmos o método ConfigureAwait(Boolean continueOnCapturedContext) da Task, e passarmos o valor false. Assim, ele irá continuar a execução da operação assíncrona na mesma Thread, sem troca de contexto.

async Task AsyncOp()
{
	Task.Delay(1000).ConfigureAwait(false); //simulate asynchronous operation
}

var task = AsyncOp();
task.Wait();

Bem, era isso pessoal. Até a próxima😉

Written by Breno Ferreira

03/01/2012 at 20:48

Posted in C#

Tagged with ,

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s