¿Cómo usar WebClient dentro de ASP.NET MVC de forma asincrónica?

Question

Tengo una aplicación ASP.NET MVC que actualmente usa la clase WebClient para realizar una simple llamada a un servicio web externo desde una acción del controlador.

Actualmente estoy usando el método DownloadString, que se ejecuta de forma síncrona. Me he encontrado con problemas en los que el servicio web externo no responde, lo que hace que toda mi aplicación ASP.NET carezca de hilos y no responda.

¿Cuál es la mejor manera de solucionar este problema? Hay un método DownloadStringAsync, pero no estoy seguro de cómo llamarlo desde el controlador. ¿Necesito usar la clase AsyncController? Si es así, ¿cómo interactúan el AsyncController y el método DownloadStringAsync?

Gracias por la ayuda.

Answer 1

Creo que el uso de AsyncControllers le ayudará aquí ya que descargan el procesamiento del subproceso de solicitud.

que haría uso de algo como esto (utilizando el patrón de eventos como se describe en this article):

public class MyAsyncController : AsyncController 
{ 
    // The async framework will call this first when it matches the route 
    public void MyAction() 
    { 
     // Set a default value for our result param 
     // (will be passed to the MyActionCompleted method below) 
     AsyncManager.Parameters["webClientResult"] = "error"; 
     // Indicate that we're performing an operation we want to offload 
     AsyncManager.OutstandingOperations.Increment(); 

     var client = new WebClient(); 
     client.DownloadStringCompleted += (s, e) => 
     { 
      if (!e.Cancelled && e.Error == null) 
      { 
       // We were successful, set the result 
       AsyncManager.Parameters["webClientResult"] = e.Result; 
      } 
      // Indicate that we've completed the offloaded operation 
      AsyncManager.OutstandingOperations.Decrement(); 
     }; 
     // Actually start the download 
     client.DownloadStringAsync(new Uri("http://www.apple.com")); 
    } 

    // This will be called when the outstanding operation(s) have completed 
    public ActionResult MyActionCompleted(string webClientResult) 
    { 
     ViewData["result"] = webClientResult; 
     return View(); 
    } 
} 

y asegúrese de que la configuración sea cual sea rutas que necesita, por ejemplo (en Global.asax.cs):

public class MvcApplication : System.Web.HttpApplication 
{ 
    public static void RegisterRoutes(RouteCollection routes) 
    { 
     routes.IgnoreRoute("{resource}.axd/{*pathInfo}"); 

     routes.MapAsyncRoute(
      "Default", 
      "{controller}/{action}/{id}", 
      new { controller = "Home", action = "Index", id = "" } 
     ); 
    } 
} 

Answer 2

El método DownloadStringAsync usa un modelo de evento, elevando el DownloadStringCompleted cuando haya finalizado. También puede detener la solicitud si tarda demasiado llamando al WebClient.CancelAsync(). Esto permitirá que el hilo de su solicitud principal y el hilo de su WebClient se ejecuten en paralelo, y le permitirá decidir exactamente cuánto tiempo quiere que espere el hilo principal antes de volver.

En el siguiente ejemplo, iniciamos la descarga y establecemos el controlador de eventos que queremos invocar cuando termina. DownloadStringAsync se devuelve inmediatamente, por lo que podemos seguir procesando el resto de nuestra solicitud.

Para demostrar un control más granular de esta operación, cuando lleguemos al final de nuestra acción de controlador, podemos verificar si la descarga ya está completa; si no, déjalo 3 segundos más y luego aborta.

string downloadString = null; 

ActionResult MyAction() 
{ 
    //get the download location 
    WebClient client = StartDownload(uri); 
    //do other stuff 
    CheckAndFinalizeDownload(client); 
    client.Dispose(); 
} 

WebClient StartDownload(Uri uri) 
{ 
    WebClient client = new WebClient(); 
    client.DownloadStringCompleted += new DownloadStringCompletedEventHandler(Download_Completed); 
    client.DownloadStringAsync(uri); 
    return client; 
} 

void CheckAndFinalizeDownload(WebClient client) 
{ 
    if(this.downloadString == null) 
    { 
     Thread.Sleep(3000); 
    } 
    if(this.downloadString == null) 
    { 
     client.CancelAsync(); 
     this.downloadString = string.Empty; 
    } 
} 

void Download_Completed(object sender, DownloadStringCompletedEventArgs e) 
{ 
    if(!e.Cancelled && e.Error == null) 
    { 
     this.downloadString = (string)e.Result; 
    } 
}