Synchrones Warten auf eine asynchrone Operation und warum friert Wait () das Programm hier ein

Vorwort : Ich suche eine Erklärung, nicht nur eine Lösung. Ich kenne die Lösung bereits.

Obwohl ich mehrere Tage damit verbracht habe, MSDN-Artikel über das aufgabenbasierte asynchrone Muster (TAP) zu studieren, asynchron zu sein und zu warten, bin ich immer noch etwas verwirrt über einige der feineren Details.

Ich schreibe einen Logger für Windows Store Apps und möchte sowohl die asynchrone als auch die synchrone Protokollierung unterstützen. Die asynchronen Methoden folgen dem TAP, die synchronen sollten all dies verbergen und wie normale Methoden aussehen und funktionieren.

Dies ist die Kernmethode der asynchronen Protokollierung:

private async Task WriteToLogAsync(string text)
{
    StorageFolder folder = ApplicationData.Current.LocalFolder;
    StorageFile file = await folder.CreateFileAsync("log.log",
        CreationCollisionOption.OpenIfExists);
    await FileIO.AppendTextAsync(file, text,
        Windows.Storage.Streams.UnicodeEncoding.Utf8);
}

Nun die entsprechende synchrone Methode ...

Version 1 :

private void WriteToLog(string text)
{
    Task task = WriteToLogAsync(text);
    task.Wait();
}

Das sieht richtig aus, funktioniert aber nicht. Das ganze Programm friert für immer ein.

Version 2 :

Hmm .. Vielleicht wurde die Aufgabe nicht gestartet?

private void WriteToLog(string text)
{
    Task task = WriteToLogAsync(text);
    task.Start();
    task.Wait();
}

Das wirft InvalidOperationException: Start may not be called on a promise-style task.

Version 3:

Hmm .. Task.RunSynchronouslyklingt vielversprechend.

private void WriteToLog(string text)
{
    Task task = WriteToLogAsync(text);
    task.RunSynchronously();
}

Das wirft InvalidOperationException: RunSynchronously may not be called on a task not bound to a delegate, such as the task returned from an asynchronous method.

Version 4 (die Lösung):

private void WriteToLog(string text)
{
    var task = Task.Run(async () => { await WriteToLogAsync(text); });
    task.Wait();
}

Das funktioniert. 2 und 3 sind also die falschen Werkzeuge. Aber 1? Was ist los mit 1 und was ist der Unterschied zu 4? Was bringt 1 zum Einfrieren? Gibt es ein Problem mit dem Aufgabenobjekt? Gibt es einen nicht offensichtlichen Stillstand?

In awaitIhrer asynchronen Methode wird versucht, zum UI-Thread zurückzukehren.

Da der UI-Thread damit beschäftigt ist, auf den Abschluss der gesamten Aufgabe zu warten, liegt ein Deadlock vor.

Durch Verschieben des asynchronen Aufrufs wird Task.Run()das Problem behoben .
Da der asynchrone Aufruf jetzt in einem Thread-Pool-Thread ausgeführt wird, wird nicht versucht, zum UI-Thread zurückzukehren, und daher funktioniert alles.

Alternativ können Sie aufrufen, StartAsTask().ConfigureAwait(false)bevor Sie auf die innere Operation warten, damit sie zum Thread-Pool und nicht zum UI-Thread zurückkehrt, wodurch der Deadlock vollständig vermieden wird.

Das Aufrufen von asyncCode aus synchronem Code kann sehr schwierig sein.

Die vollständigen Gründe für diesen Deadlock erkläre ich in meinem Blog . Kurz gesagt, es gibt einen "Kontext", der standardmäßig am Anfang jedes Kontextes gespeichert awaitund zum Fortsetzen der Methode verwendet wird.

Wenn dies in einem UI-Kontext aufgerufen wird await, asyncversucht die Methode nach Abschluss des Vorgangs, diesen Kontext erneut einzugeben, um die Ausführung fortzusetzen. Leider blockiert Code mit Wait(oder Result) einen Thread in diesem Kontext, sodass die asyncMethode nicht abgeschlossen werden kann.

Die Richtlinien, um dies zu vermeiden, sind:

1. Verwenden Sie ConfigureAwait(continueOnCapturedContext: false)so viel wie möglich. Auf diese Weise können Ihre asyncMethoden weiter ausgeführt werden, ohne den Kontext erneut eingeben zu müssen.
2. Verwenden Sie den asyncganzen Weg. Verwenden Sie awaitanstelle von Resultoder Wait.

Wenn Ihre Methode von Natur aus asynchron ist, sollten Sie (wahrscheinlich) keinen synchronen Wrapper verfügbar machen .

Hier ist was ich getan habe

private void myEvent_Handler(object sender, SomeEvent e)
{
  // I dont know how many times this event will fire
  Task t = new Task(() =>
  {
    if (something == true) 
    {
        DoSomething(e);  
    }
  });
  t.RunSynchronously();
}

funktioniert super und blockiert nicht den UI-Thread

In einem kleinen benutzerdefinierten Synchronisationskontext kann die Synchronisierungsfunktion auf den Abschluss der Asynchronisierungsfunktion warten, ohne einen Deadlock zu verursachen. Hier ist ein kleines Beispiel für die WinForms-App.

Imports System.Threading
Imports System.Runtime.CompilerServices

Public Class Form1

    Private Sub Form1_Load(sender As Object, e As EventArgs) Handles MyBase.Load
        SyncMethod()
    End Sub

    ' waiting inside Sync method for finishing async method
    Public Sub SyncMethod()
        Dim sc As New SC
        sc.WaitForTask(AsyncMethod())
        sc.Release()
    End Sub

    Public Async Function AsyncMethod() As Task(Of Boolean)
        Await Task.Delay(1000)
        Return True
    End Function

End Class

Public Class SC
    Inherits SynchronizationContext

    Dim OldContext As SynchronizationContext
    Dim ContextThread As Thread

    Sub New()
        OldContext = SynchronizationContext.Current
        ContextThread = Thread.CurrentThread
        SynchronizationContext.SetSynchronizationContext(Me)
    End Sub

    Dim DataAcquired As New Object
    Dim WorkWaitingCount As Long = 0
    Dim ExtProc As SendOrPostCallback
    Dim ExtProcArg As Object

    <MethodImpl(MethodImplOptions.Synchronized)>
    Public Overrides Sub Post(d As SendOrPostCallback, state As Object)
        Interlocked.Increment(WorkWaitingCount)
        Monitor.Enter(DataAcquired)
        ExtProc = d
        ExtProcArg = state
        AwakeThread()
        Monitor.Wait(DataAcquired)
        Monitor.Exit(DataAcquired)
    End Sub

    Dim ThreadSleep As Long = 0

    Private Sub AwakeThread()
        If Interlocked.Read(ThreadSleep) > 0 Then ContextThread.Resume()
    End Sub

    Public Sub WaitForTask(Tsk As Task)
        Dim aw = Tsk.GetAwaiter

        If aw.IsCompleted Then Exit Sub

        While Interlocked.Read(WorkWaitingCount) > 0 Or aw.IsCompleted = False
            If Interlocked.Read(WorkWaitingCount) = 0 Then
                Interlocked.Increment(ThreadSleep)
                ContextThread.Suspend()
                Interlocked.Decrement(ThreadSleep)
            Else
                Interlocked.Decrement(WorkWaitingCount)
                Monitor.Enter(DataAcquired)
                Dim Proc = ExtProc
                Dim ProcArg = ExtProcArg
                Monitor.Pulse(DataAcquired)
                Monitor.Exit(DataAcquired)
                Proc(ProcArg)
            End If
        End While

    End Sub

     Public Sub Release()
         SynchronizationContext.SetSynchronizationContext(OldContext)
     End Sub

End Class