Perché dovrei preoccuparmi di usare Task.ConfigureAwait (continueOnCapturedContext: false);

Question

Si consideri il seguente codice di Windows Form:

private async void UpdateUIControlClicked(object sender, EventArgs e) 
    { 
     this.txtUIControl.Text = "I will be updated after 2nd await - i hope!"; 
     await Task.Delay(5000).ConfigureAwait(continueOnCapturedContext: false); 
     this.txtUIControl.Text = "I am updated now."; 
    } 

Qui l'eccezione viene generata al 3 ° linea perché dopo attendono il codice viene eseguito sul filetto non-UI. Dove ConfigureAwait (false) è utile?

Answer 1

Stephen Cleary has a really good series on this you can find here, ho citato il pezzo specifico alla tua domanda:

maggior parte del tempo, non è necessità per sincronizzare di nuovo al contesto “principale”. La maggior parte dei metodi asincroni verranno progettati tenendo conto della composizione: attendono altre operazioni e ognuna rappresenta un'operazione stessa asincrona (che può essere composta da altri). In questo caso, si vuole dire al awaiter a non cattura contesto corrente chiamando ConfigureAwait e passando false, ad esempio:

private async Task DownloadFileAsync(string fileName) 
{ 
    // Use HttpClient or whatever to download the file contents. 
    var fileContents = await DownloadFileContentsAsync(fileName).ConfigureAwait(false); 

    // Note that because of the ConfigureAwait(false), we are not on the original context here. 
    // Instead, we're running on the thread pool. 

    // Write the file contents out to a disk file. 
    await WriteToDiskAsync(fileName, fileContents).ConfigureAwait(false); 

    // The second call to ConfigureAwait(false) is not *required*, but it is Good Practice. 
} 

// WinForms example (it works exactly the same for WPF). 
private async void DownloadFileButton_Click(object sender, EventArgs e) 
{ 
    // Since we asynchronously wait, the UI thread is not blocked by the file download. 
    await DownloadFileAsync(fileNameTextBox.Text); 

    // Since we resume on the UI context, we can directly access UI elements. 
    resultTextBox.Text = "File downloaded!"; 
} 

La cosa importante da notare con questo esempio è che ogni “livello” delle chiamate al metodo asincrono ha il suo contesto. DownloadFileButton_Click avviato nel contesto dell'interfaccia utente e denominato DownloadFileAsync. DownloadFileAsync avviato anche nel contesto dell'interfaccia utente, ma poi uscito dal suo contesto chiamando ConfigureAwait(false). Il resto di DownloadFileAsync viene eseguito nel contesto del pool di thread. Tuttavia, quando DownloadFileAsync completa e DownloadFileButton _Click riprende, lo riprende nel contesto UI.

Una buona regola empirica è quella di utilizzare ConfigureAwait(false) a meno che non si conosca lo do necessario il contesto.

Answer 2

Se ConfigureAwait è inizializzato a false, il codice non verrà eseguito sul thread principale (thread UI), ma se è true, allora sarà.

Vi consiglio di utilizzare SyncContext più spesso su questo.