Bewährte Methode zum Aufrufen von ConfigureAwait für den gesamten serverseitigen Code

Wenn Sie serverseitigen Code haben (dh einige ApiController) und Ihre Funktionen asynchron sind - sie kehren also zurück Task<SomeObject>-, wird dies als bewährte Methode angesehen, wenn Sie jedes Mal auf Funktionen warten, die Sie aufrufen ConfigureAwait(false)?

Ich hatte gelesen, dass es leistungsfähiger ist, da es nicht die Thread-Kontexte zurück zum ursprünglichen Thread-Kontext wechseln muss. Wenn Ihre Anforderung mit ASP.NET Web Api jedoch in einem Thread eingeht und Sie auf eine Funktion und einen Aufruf warten ConfigureAwait(false), die Sie möglicherweise in einen anderen Thread versetzen könnten, wenn Sie das Endergebnis Ihrer ApiControllerFunktion zurückgeben.

Ich habe ein Beispiel für das geschrieben, worüber ich unten spreche:

public class CustomerController : ApiController
{
    public async Task<Customer> Get(int id)
    {
        // you are on a particular thread here
        var customer = await SomeAsyncFunctionThatGetsCustomer(id).ConfigureAwait(false);

        // now you are on a different thread!  will that cause problems?
        return customer;
    }
}

Update: ASP.NET Core hat keineSynchronizationContext . Wenn Sie mit ASP.NET Core arbeiten, spielt es keine Rolle, ob Sie verwenden ConfigureAwait(false)oder nicht.

Für ASP.NET "Full" oder "Classic" oder was auch immer gilt der Rest dieser Antwort weiterhin.

Ursprünglicher Beitrag (für Nicht-Core-ASP.NET):

Dieses Video des ASP.NET-Teams enthält die besten Informationen zur Verwendung asyncin ASP.NET.

Ich hatte gelesen, dass es leistungsfähiger ist, da es nicht die Thread-Kontexte zurück zum ursprünglichen Thread-Kontext wechseln muss.

Dies gilt für UI-Anwendungen, bei denen es nur einen UI-Thread gibt, mit dem Sie "synchronisieren" müssen.

In ASP.NET ist die Situation etwas komplexer. Wenn eine asyncMethode die Ausführung fortsetzt, wird ein Thread aus dem ASP.NET-Thread-Pool abgerufen. Wenn Sie die Kontexterfassung mit deaktivieren ConfigureAwait(false), führt der Thread die Methode einfach direkt weiter aus. Wenn Sie die Kontexterfassung nicht deaktivieren, tritt der Thread erneut in den Anforderungskontext ein und führt die Methode weiter aus.

So ConfigureAwait(false)sparen Sie nicht einen Thread Sprung in ASP.NET; Es erspart Ihnen die erneute Eingabe des Anforderungskontexts, dies ist jedoch normalerweise sehr schnell. ConfigureAwait(false) Dies kann nützlich sein, wenn Sie versuchen, eine kleine Menge einer Anfrage parallel zu verarbeiten, TPL jedoch für die meisten dieser Szenarien besser geeignet ist.

Bei ASP.NET Web Api jedoch, wenn Ihre Anfrage in einem Thread eingeht und Sie auf eine Funktion warten und ConfigureAwait (false) aufrufen, die Sie möglicherweise in einen anderen Thread versetzen könnte, wenn Sie das Endergebnis Ihrer ApiController-Funktion zurückgeben .

Eigentlich kann man das nur tun await. Sobald Ihre asyncMethode auf trifft await, wird die Methode blockiert, aber der Thread kehrt zum Thread-Pool zurück. Wenn die Methode zum Fortfahren bereit ist, wird jeder Thread aus dem Thread-Pool entnommen und zum Fortsetzen der Methode verwendet.

Der einzige Unterschied ConfigureAwaitin ASP.NET besteht darin, ob dieser Thread beim Fortsetzen der Methode in den Anforderungskontext wechselt.

Ich habe weitere Hintergrundinformationen in meinem MSDN-ArtikelSynchronizationContext und meinem asyncIntro-Blog-Beitrag .

Kurze Antwort auf Ihre Frage: Nein. Sie sollten nicht ConfigureAwait(false)auf Anwendungsebene anrufen .

TL; DR-Version der langen Antwort: Wenn Sie eine Bibliothek schreiben, in der Sie Ihren Verbraucher nicht kennen und keinen Synchronisationskontext benötigen (den Sie meiner Meinung nach nicht in einer Bibliothek haben sollten), sollten Sie ihn immer verwenden ConfigureAwait(false). Andernfalls können die Konsumenten Ihrer Bibliothek Deadlocks ausgesetzt sein, indem sie Ihre asynchronen Methoden blockierend nutzen. Dies hängt von der Situation ab.

Hier ist eine etwas detailliertere Erklärung zur Wichtigkeit der ConfigureAwaitMethode (ein Zitat aus meinem Blog-Beitrag):

Wenn Sie auf eine Methode mit dem Schlüsselwort await warten, generiert der Compiler für Sie eine Reihe von Code. Einer der Zwecke dieser Aktion besteht darin, die Synchronisation mit dem UI- (oder Haupt-) Thread durchzuführen. Die Schlüsselkomponente dieser Funktion ist die, SynchronizationContext.Currentdie den Synchronisationskontext für den aktuellen Thread abruft. SynchronizationContext.Currentwird abhängig von der Umgebung, in der Sie sich befinden, ausgefüllt. Die GetAwaiterMethode von Task sucht nach SynchronizationContext.Current. Wenn der aktuelle Synchronisationskontext nicht null ist, wird die Fortsetzung, die an diesen Kellner übergeben wird, an diesen Synchronisationskontext zurückgesendet.

Wenn Sie eine Methode, die die neuen asynchronen Sprachfunktionen verwendet, blockierend verwenden, kommt es zu einem Deadlock, wenn Sie über einen verfügbaren SynchronizationContext verfügen. Wenn Sie solche Methoden blockierend verwenden (auf die Task mit Wait-Methode warten oder das Ergebnis direkt aus der Result-Eigenschaft der Task entnehmen), blockieren Sie gleichzeitig den Hauptthread. Wenn die Aufgabe innerhalb dieser Methode im Threadpool abgeschlossen ist, wird die Fortsetzung aufgerufen, um sie an den Hauptthread zurückzusenden, da sie SynchronizationContext.Currentverfügbar und erfasst ist. Aber hier gibt es ein Problem: Der UI-Thread ist blockiert und Sie haben einen Deadlock!

Hier sind auch zwei großartige Artikel für Sie, die genau für Ihre Frage sind:

• Das perfekte Rezept, um sich selbst in den Fuß zu schießen - mit den asynchronen Sprachfunktionen von C # 5.0 einen Deadlock zu erreichen
• Asynchrone .NET-Clientbibliotheken für Ihre HTTP-API und Kenntnis der schlechten Auswirkungen von async / await

Schließlich gibt es ein großartiges kurzes Video von Lucian Wischik genau zu diesem Thema: Asynchrone Bibliotheksmethoden sollten die Verwendung von Task.ConfigureAwait (false) in Betracht ziehen .

Hoffe das hilft.

Der größte Nachteil, den ich bei der Verwendung von ConfigureAwait (false) festgestellt habe, ist, dass die Thread-Kultur auf den Systemstandard zurückgesetzt wird. Wenn Sie eine Kultur konfiguriert haben, z.

<system.web>
    <globalization culture="en-AU" uiCulture="en-AU" />    
    ...

Wenn Sie auf einem Server hosten, dessen Kultur auf en-US eingestellt ist, werden Sie feststellen, bevor ConfigureAwait (false) CultureInfo heißt. CurrentCulture gibt en-AU zurück und nachdem Sie en-US erhalten. dh

// CultureInfo.CurrentCulture ~ {en-AU}
await xxxx.ConfigureAwait(false);
// CultureInfo.CurrentCulture ~ {en-US}

Wenn Ihre Anwendung etwas tut, das eine kulturspezifische Formatierung von Daten erfordert, müssen Sie dies bei der Verwendung von ConfigureAwait (false) berücksichtigen.

Ich habe einige allgemeine Gedanken zur Implementierung von Task:

1. Die Aufgabe ist verfügbar, aber wir sollten sie nicht verwenden using.
2. ConfigureAwaitwurde in 4.5 eingeführt. Taskwurde in 4.0 eingeführt.
3. .NET-Threads, die immer zum Fließen des Kontexts verwendet werden (siehe C # über das CLR-Buch), aber in der Standardimplementierung Task.ContinueWithnicht b / c wurde erkannt, dass der Kontextwechsel teuer ist und standardmäßig deaktiviert ist.
4. Das Problem ist, dass es einem Bibliotheksentwickler egal sein sollte, ob seine Clients einen Kontextfluss benötigen oder nicht. Daher sollte er nicht entscheiden, ob der Kontext fließt oder nicht.
5. [Später hinzugefügt] Die Tatsache, dass es keine maßgebliche Antwort und keinen richtigen Hinweis gibt und wir weiter darum kämpfen, bedeutet, dass jemand seine Arbeit nicht richtig gemacht hat.

Ich habe ein paar Beiträge zu diesem Thema, aber ich gehe davon aus, dass Sie - zusätzlich zu Tugberks netter Antwort - alle APIs asynchron machen und den Kontext idealerweise fließen lassen sollten. Da Sie asynchron arbeiten, können Sie einfach Fortsetzungen verwenden, anstatt zu warten, sodass kein Deadlock verursacht wird, da in der Bibliothek kein Warten erfolgt und Sie den Fluss beibehalten, damit der Kontext erhalten bleibt (z. B. HttpContext).

Problem ist, wenn eine Bibliothek eine synchrone API verfügbar macht, aber eine andere asynchrone API verwendet - daher müssen Sie Wait()/ Resultin Ihrem Code verwenden.