C# Async ApiController Vorzeitiges Schließen von OutputStream

Question

Das Problem bei der Verwendung von WebApi 2 und einer auf Async ApiController basierenden Get-Methode besteht darin, dass der Inhalt einer Datei zurückgegeben wird. Wenn ich die Get-Methode auf "synchron" ändere, funktioniert das problemlos, aber sobald ich es wieder in async konvertiere, schließt es den Stream vorzeitig. (Fiedler, berichtet die Verbindung abgebrochen wurde) Der Arbeits Synchron-Code ist:

public void Get(int id) 
    { 
     try 
     { 
      FileInfo fileInfo = logic.GetFileInfoSync(id); 
      HttpResponse response = HttpContext.Current.Response; 
      response.Clear(); 
      response.ClearContent(); 
      response.Buffer = true; 
      response.AddHeader("Content-Disposition", "attachment; filename=\"" + fileInfo.Node.Name + fileInfo.Ext + "\""); 
      response.AddHeader("Content-Length", fileInfo.SizeInBytes.ToString()); 
      response.ContentType = "application/octet-stream"; 
      logic.GetDownloadStreamSync(id, response.OutputStream); 
      response.StatusCode = (int)HttpStatusCode.OK; 
      //HttpContext.Current.ApplicationInstance.CompleteRequest(); 
      response.End(); 
     } 
     catch(Exception ex) 
     { 
      Console.WriteLine(ex.ToString()); 
     } 
    } 

Und das GetDownloadStreamSync ist wie folgt:

public async Task GetDownloadStream(string fileIdentifier, Stream streamToCopyTo) 
{ 
    string filePath = Path.Combine(fileIdentifierFolder, fileIdentifier); 
    using (FileStream fs = new FileStream(filePath, FileMode.Open, FileAccess.Read, FileShare.None, BufferSize, false)) 
    { 
     fs.CopyTo(streamToCopyTo); 
    } 
} 

-------- Async-Code ----- -----

die Async-Version ist genau das gleiche, außer:

public async Task Get(int id) 
{ 
    FileInfo fileInfo = await logic.GetFileInfoSync(id); // database opp 
      HttpResponse response = HttpContext.Current.Response; 
      response.Clear(); 
      response.ClearContent(); 
      response.Buffer = true; 
      response.AddHeader("Content-Disposition", "attachment; filename=\"" + fileInfo.Node.Name + fileInfo.Ext + "\""); 
      response.AddHeader("Content-Length", fileInfo.SizeInBytes.ToString()); 
      response.ContentType = "application/octet-stream"; 
      await logic.GetDownloadStreamSync(id, response.OutputStream); 
          //database opp + file I/O 
      response.StatusCode = (int)HttpStatusCode.OK; 
      //HttpContext.Current.ApplicationInstance.CompleteRequest(); 
      response.End(); 
} 

Mit der Asynchron-Implementierung von GetDo wnloadStream wie folgt: (streamToCopyTo ist die Output vom Response.OutputStream)

public async Task GetDownloadStream(string fileIdentifier, Stream streamToCopyTo) 
{ 
    using (FileStream fs = new FileStream(filePath, FileMode.Open, FileAccess.Read, FileShare.None, BufferSize, true)) 
    { 
     await fs.CopyToAsync(streamToCopyTo); 
    } 
} 

Wir versuchen, die async/await Muster von vorne zu umarmen, zu sichern, so hoffentlich jemand ist sich bewusst, warum dies nicht möglich wäre? Ich habe auch versucht, Response.End(), Response.Flush() und HttpContext.Current.ApplicationInstance.CompleteRequest() nicht aufzurufen. Als Reaktion auf die folgenden Fragen/Kommentare habe ich auch einen Haltepunkt auf die Antwort platziert.End() mit dem Ergebnis, dass die GetDownloadStream-Methode nicht getroffen wurde. Vielleicht ist der OutputStream nicht asynchron? Irgendwelche Ideen sind willkommen! Dank

************************** Endlösung **************** ***********

Vielen Dank an alle, die kommentiert haben, und besonders an @Noseratio für seinen Vorschlag zu FileOptions.DeleteOnClose.

[HttpGet] 
public async Task<HttpResponseMessage> Get(long id) 
{ 
     HttpResponseMessage result = new HttpResponseMessage(HttpStatusCode.OK); 
     Node node = await logic.GetFileInfoForNodeAsync(id); 

     result.Content = new StreamContent(await logic.GetDownloadStreamAsync(id)); 
     result.Content.Headers.ContentType = new MediaTypeHeaderValue("application/octet-stream"); 
     result.Content.Headers.ContentDisposition = new ContentDispositionHeaderValue("attachment") 
     { 
      FileName = node.Name + node.FileInfo.Extension 
     }; 
     result.Content.Headers.ContentLength = node.FileInfo.SizeInBytes; 
     return result 
} 

Mit dem GetDownloadStreamAsync wie folgt aussehen:

FileStream fs = new FileStream(filePath, FileMode.Open, FileAccess.Read, FileShare.None, BufferSize, FileOptions.DeleteOnClose | FileOptions.Asynchronous); 

verließ ich heraus, dass ich auch im Fluge den Dateistrom wurde zu entschlüsseln, und dies funktioniert, so für die Interessenten ...

FileStream fs = new FileStream(filePath, FileMode.Open, FileAccess.Read, FileShare.None, BufferSize, FileOptions.DeleteOnClose | FileOptions.Asynchronous); 
RijndaelManaged rm = new RijndaelManaged(); 
return new CryptoStream(fs, GetDecryptor(rm, password), CryptoStreamMode.Read); 

Answer 1

Es nehmen würde einen vollständigen Repro Fall, um Ihre genaue Frage zu beantworten sein, aber ich glaube nicht, Sie async/await hier überhaupt brauchen . Ich denke auch, dass Sie vermeiden sollten, HttpContext.Current.Response direkt wo möglich zu verwenden, besonders in asynchronen WebAPI-Controller-Methoden.

In diesem speziellen Fall könnten Sie HttpResponseMessage verwenden:

[HttpGet] 
public HttpResponseMessage Get(int id) 
{ 
    HttpResponseMessage result = new HttpResponseMessage(HttpStatusCode.OK); 
    FileInfo fileInfo = logic.GetFileInfoSync(id); 

    FileStream fs = new FileStream(
     filePath, FileMode.Open, FileAccess.Read, FileShare.None, BufferSize, false); 

    result.Content = new StreamContent(fs); 
    result.Content.Headers.ContentType = 
     new MediaTypeHeaderValue("application/octet-stream"); 
    result.Content.Headers.ContentDisposition = 
     new ContentDispositionHeaderValue("attachment") 
     { 
      FileName = fileInfo.Node.Name + fileInfo.Ext 
     }; 
    result.Content.Headers.ContentLength = fileInfo.SizeInBytes; 

    return result; 
} 

Es gibt keine hier explizit Asynchronität, so ist das Verfahren nicht async. Wenn Sie jedoch noch einige await einführen müssen, würde die Methode wie folgt erhalten:

[HttpGet] 
public async Task<HttpResponseMessage> Get(int id) 
{ 
    HttpResponseMessage result = new HttpResponseMessage(HttpStatusCode.OK); 
    // ... 
    await fs.CopyToAsync(streamToCopyTo) 
    // ... 
    return result; 
} 

Answer 2

Die Wurzel Ihres Problems liegt tatsächlich in der Verwendung von Response.End(). Wenn Sie Async ausführen, wird die Datei Response.End() ausgeführt, bevor der Inhalt der Datei gestreamt wird. Bei Verwendung der Sync-Version wird dies nicht angezeigt, da Response.End() erst aufgerufen wird, nachdem der Dateiinhalt gestreamt wurde.

Response.End() ist eine AUSSERGEWÖHNLICHE schlechte Möglichkeit zu sagen, dass Sie die Verarbeitung abgeschlossen haben, da es eine TreadAbortException auslöst. Stattdessen sollten Sie HttpContext.Current.ApplicationInstance.CompleteRequest()

Lesen Sie diesen Artikel für weitere Informationen Response.End, Response.Close, and How Customer Feedback Helps Us Improve MSDN Documentation