HttpClient.GetAsync(...) nunca regresa cuando se usa await/async
Editar: Esta pregunta parece que podría ser el mismo problema, pero no tiene respuestas...
Editar: en el caso de prueba 5, la tarea parece estar estancada en el WaitingForActivation
estado.
Encontré un comportamiento extraño al usar System.Net.Http.HttpClient en .NET 4.5, donde "esperar" el resultado de una llamada a (por ejemplo) httpClient.GetAsync(...)
nunca regresará.
Esto solo ocurre en ciertas circunstancias cuando se usa la nueva funcionalidad de lenguaje async/await y la API de tareas; el código siempre parece funcionar cuando se usan solo continuaciones.
Aquí hay un código que reproduce el problema: colóquelo en un nuevo "proyecto MVC 4 WebApi" en Visual Studio 11 para exponer los siguientes puntos finales GET:
/api/test1
/api/test2
/api/test3
/api/test4
/api/test5 <--- never completes
/api/test6
Cada uno de los puntos finales aquí devuelve los mismos datos (los encabezados de respuesta de stackoverflow.com), excepto /api/test5
que nunca se completa.
¿He encontrado un error en la clase HttpClient o estoy haciendo un mal uso de la API de alguna manera?
Código para reproducir:
public class BaseApiController : ApiController
{
/// <summary>
/// Retrieves data using continuations
/// </summary>
protected Task<string> Continuations_GetSomeDataAsync()
{
var httpClient = new HttpClient();
var t = httpClient.GetAsync("http://stackoverflow.com", HttpCompletionOption.ResponseHeadersRead);
return t.ContinueWith(t1 => t1.Result.Content.Headers.ToString());
}
/// <summary>
/// Retrieves data using async/await
/// </summary>
protected async Task<string> AsyncAwait_GetSomeDataAsync()
{
var httpClient = new HttpClient();
var result = await httpClient.GetAsync("http://stackoverflow.com", HttpCompletionOption.ResponseHeadersRead);
return result.Content.Headers.ToString();
}
}
public class Test1Controller : BaseApiController
{
/// <summary>
/// Handles task using Async/Await
/// </summary>
public async Task<string> Get()
{
var data = await Continuations_GetSomeDataAsync();
return data;
}
}
public class Test2Controller : BaseApiController
{
/// <summary>
/// Handles task by blocking the thread until the task completes
/// </summary>
public string Get()
{
var task = Continuations_GetSomeDataAsync();
var data = task.GetAwaiter().GetResult();
return data;
}
}
public class Test3Controller : BaseApiController
{
/// <summary>
/// Passes the task back to the controller host
/// </summary>
public Task<string> Get()
{
return Continuations_GetSomeDataAsync();
}
}
public class Test4Controller : BaseApiController
{
/// <summary>
/// Handles task using Async/Await
/// </summary>
public async Task<string> Get()
{
var data = await AsyncAwait_GetSomeDataAsync();
return data;
}
}
public class Test5Controller : BaseApiController
{
/// <summary>
/// Handles task by blocking the thread until the task completes
/// </summary>
public string Get()
{
var task = AsyncAwait_GetSomeDataAsync();
var data = task.GetAwaiter().GetResult();
return data;
}
}
public class Test6Controller : BaseApiController
{
/// <summary>
/// Passes the task back to the controller host
/// </summary>
public Task<string> Get()
{
return AsyncAwait_GetSomeDataAsync();
}
}
Estás haciendo un mal uso de la API.
Esta es la situación: en ASP.NET, sólo un hilo puede manejar una solicitud a la vez. Puede realizar algún procesamiento paralelo si es necesario (tomando prestados subprocesos adicionales del grupo de subprocesos), pero solo un subproceso tendría el contexto de solicitud (los subprocesos adicionales no tienen el contexto de solicitud).
Esto es administrado por ASP.NETSynchronizationContext
.
De forma predeterminada, cuando realiza await
un Task
, el método se reanuda en un capturado SynchronizationContext
(o en un capturado TaskScheduler
, si no hay SynchronizationContext
). Normalmente, esto es justo lo que desea: una acción de controlador asíncrono realizará await
algo y, cuando se reanude, se reanudará con el contexto de solicitud.
Entonces, he aquí por qué test5
falla:
Test5Controller.Get
se ejecutaAsyncAwait_GetSomeDataAsync
(dentro del contexto de solicitud de ASP.NET).AsyncAwait_GetSomeDataAsync
se ejecutaHttpClient.GetAsync
(dentro del contexto de solicitud de ASP.NET).- La solicitud HTTP se envía y
HttpClient.GetAsync
devuelve un archivoTask
. AsyncAwait_GetSomeDataAsync
espera elTask
; como no está completo,AsyncAwait_GetSomeDataAsync
devuelve un archivo incompletoTask
.Test5Controller.Get
bloquea el hilo actual hasta que seTask
complete.- Llega la respuesta HTTP y se completa el
Task
retorno .HttpClient.GetAsync
AsyncAwait_GetSomeDataAsync
intenta reanudarse dentro del contexto de solicitud de ASP.NET. Sin embargo, ya existe un hilo en ese contexto: el hilo bloqueado enTest5Controller.Get
.- Punto muerto.
He aquí por qué los demás funcionan:
- (
test1
,test2
ytest3
):Continuations_GetSomeDataAsync
programa la continuación al grupo de subprocesos, fuera del contexto de solicitud de ASP.NET. Esto permite que laTask
devoluciónContinuations_GetSomeDataAsync
se complete sin tener que volver a ingresar el contexto de la solicitud. - (
test4
ytest6
): dado queTask
se espera , el hilo de solicitud de ASP.NET no está bloqueado. Esto permiteAsyncAwait_GetSomeDataAsync
utilizar el contexto de solicitud de ASP.NET cuando esté listo para continuar.
Y aquí están las mejores prácticas:
- En sus
async
métodos de "biblioteca", utilíceloConfigureAwait(false)
siempre que sea posible. En su caso, esto cambiaríaAsyncAwait_GetSomeDataAsync
a servar result = await httpClient.GetAsync("http://stackoverflow.com", HttpCompletionOption.ResponseHeadersRead).ConfigureAwait(false);
- No bloquees en
Task
s; estáasync
completamente abajo. En otras palabras, utilíceloawait
en lugar deGetResult
(Task.Result
yTask.Wait
también debe reemplazarse porawait
).
De esa manera, obtiene ambos beneficios: la continuación (el resto del AsyncAwait_GetSomeDataAsync
método) se ejecuta en un subproceso de grupo de subprocesos básico que no tiene que ingresar al contexto de solicitud de ASP.NET; y el controlador en sí lo es async
(que no bloquea un hilo de solicitud).
Más información:
- Mi publicación
async
/await
introducción , que incluye una breve descripción de cómoTask
usan los camarerosSynchronizationContext
. - Las preguntas frecuentes sobre Async/Await , que detallan más los contextos. Consulte también Await, UI y puntos muertos. ¡Oh mi! lo cual se aplica aquí aunque esté en ASP.NET en lugar de en una interfaz de usuario, porque ASP.NET
SynchronizationContext
restringe el contexto de solicitud a solo un subproceso a la vez. - Esta publicación en el foro de MSDN .
- Stephen Toub hace una demostración de este punto muerto (usando una interfaz de usuario) , al igual que Lucian Wischik .
Actualización 13 de julio de 2012: se incorporó esta respuesta en una publicación de blog .
Editar: generalmente trate de evitar hacer lo siguiente, excepto como último esfuerzo para evitar puntos muertos. Lea el primer comentario de Stephen Cleary.
Solución rápida desde aquí . En lugar de escribir:
Task tsk = AsyncOperation();
tsk.Wait();
Intentar:
Task.Run(() => AsyncOperation()).Wait();
O si necesitas un resultado:
var result = Task.Run(() => AsyncOperation()).Result;
De la fuente (editada para que coincida con el ejemplo anterior):
AsyncOperation ahora se invocará en ThreadPool, donde no habrá un SynchronizationContext, y las continuaciones utilizadas dentro de AsyncOperation no se forzarán a regresar al subproceso que lo invoca.
Para mí, esto parece una opción utilizable ya que no tengo la opción de hacerlo asíncrono por completo (que preferiría).
De la fuente:
Asegúrese de que await en el método FooAsync no encuentre un contexto al que volver a reunir. La forma más sencilla de hacerlo es invocar el trabajo asincrónico desde ThreadPool, por ejemplo envolviendo la invocación en Task.Run, por ejemplo.
int Sync() { return Task.Run(() => Library.FooAsync()).Resultado; }
FooAsync ahora se invocará en ThreadPool, donde no habrá un SynchronizationContext, y las continuaciones utilizadas dentro de FooAsync no se forzarán a regresar al subproceso que invoca Sync().