Praktik terbaik untuk memanggil ConfigureAwait untuk semua kode sisi server

Ketika Anda memiliki kode sisi server (yaitu beberapa ApiController) dan fungsi Anda tidak sinkron - sehingga kembali Task<SomeObject>- apakah dianggap praktik terbaik yang setiap kali Anda menunggu fungsi yang Anda panggil ConfigureAwait(false)?

Saya telah membaca bahwa itu lebih berkinerja karena tidak harus mengubah konteks utas kembali ke konteks utas asli. Namun, dengan ASP.NET Web Api, jika permintaan Anda masuk pada satu utas, dan Anda menunggu beberapa fungsi dan panggilan ConfigureAwait(false)yang berpotensi menempatkan Anda pada utas yang berbeda ketika Anda mengembalikan hasil akhir dari ApiControllerfungsi Anda .

Saya telah mengetik contoh dari apa yang saya bicarakan di bawah ini:

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;
    }
}

Pembaruan: ASP.NET Core tidak memilikiSynchronizationContext . Jika Anda menggunakan ASP.NET Core, tidak masalah apakah Anda menggunakan ConfigureAwait(false)atau tidak.

Untuk ASP.NET "Penuh" atau "Klasik" atau apa pun, sisa jawaban ini masih berlaku.

Posting asli (untuk ASP.NET non-Core):

Video ini oleh tim ASP.NET memiliki informasi terbaik tentang penggunaan asyncdi ASP.NET.

Saya telah membaca bahwa itu lebih berkinerja karena tidak harus mengubah konteks utas kembali ke konteks utas asli.

Ini berlaku untuk aplikasi UI, di mana hanya ada satu utas UI yang harus "disinkronkan" kembali.

Di ASP.NET, situasinya sedikit lebih kompleks. Ketika suatu asyncmetode melanjutkan eksekusi, itu mengambil sebuah utas dari kumpulan utas ASP.NET. Jika Anda menonaktifkan pengambilan konteks menggunakan ConfigureAwait(false), maka utas hanya melanjutkan menjalankan metode secara langsung. Jika Anda tidak menonaktifkan tangkapan konteks, maka utas akan memasukkan kembali konteks permintaan dan kemudian melanjutkan untuk mengeksekusi metode.

Jadi ConfigureAwait(false)tidak menghemat lompatan thread di ASP.NET; itu tidak menyelamatkan Anda memasukkan kembali konteks permintaan, tetapi ini biasanya sangat cepat. ConfigureAwait(false) bisa berguna jika Anda mencoba melakukan sejumlah kecil pemrosesan paralel permintaan, tetapi sebenarnya TPL lebih cocok untuk sebagian besar skenario tersebut.

Namun, dengan ASP.NET Web Api, jika permintaan Anda masuk dalam satu utas, dan Anda menunggu beberapa fungsi dan memanggil ConfigureAwait (false) yang berpotensi menempatkan Anda pada utas yang berbeda ketika Anda mengembalikan hasil akhir dari fungsi ApiController Anda .

Sebenarnya, hanya melakukan awaitdapat melakukan itu. Setelah asyncmetode Anda awaitmengenai, metode diblokir tetapi utas kembali ke kumpulan utas. Ketika metode siap untuk melanjutkan, semua utas diambil dari kumpulan utas dan digunakan untuk melanjutkan metode.

Satu-satunya perbedaan ConfigureAwaitdi ASP.NET adalah apakah utas itu memasuki konteks permintaan saat melanjutkan metode.

Saya memiliki lebih banyak informasi latar belakang di artikel MSDNSynchronizationContext saya dan asyncposting blog intro saya .

Jawaban singkat untuk pertanyaan Anda: Tidak. Anda tidak boleh menelepon ConfigureAwait(false)di tingkat aplikasi seperti itu.

TL; Versi DR dari jawaban yang panjang: Jika Anda menulis perpustakaan di mana Anda tidak mengenal konsumen Anda dan tidak memerlukan konteks sinkronisasi (yang seharusnya tidak Anda temukan di perpustakaan, saya harus selalu menggunakannya ConfigureAwait(false). Jika tidak, konsumen perpustakaan Anda mungkin menghadapi kebuntuan dengan mengonsumsi metode asinkron Anda dengan cara memblokir. Ini tergantung situasi.

Berikut adalah penjelasan yang sedikit lebih rinci tentang pentingnya ConfigureAwaitmetode (kutipan dari posting blog saya):

Ketika Anda sedang menunggu suatu metode dengan kata kunci yang menunggu, kompiler menghasilkan banyak kode untuk Anda. Salah satu tujuan tindakan ini adalah menangani sinkronisasi dengan utas UI (atau utama). Komponen utama dari fitur ini adalah SynchronizationContext.Currentyang mendapatkan konteks sinkronisasi untuk utas saat ini. SynchronizationContext.Currentdiisi sesuai dengan lingkungan tempat Anda berada. GetAwaiterMetode Tugas dicari SynchronizationContext.Current. Jika konteks sinkronisasi saat ini bukan nol, kelanjutan yang diteruskan ke penunggu itu akan dikirim kembali ke konteks sinkronisasi tersebut.

Saat menggunakan metode, yang menggunakan fitur bahasa asinkron baru, dengan cara memblokir, Anda akan berakhir dengan jalan buntu jika Anda memiliki SynchronizationContext yang tersedia. Saat Anda menggunakan metode tersebut dengan cara memblokir (menunggu pada tugas dengan metode Tunggu atau mengambil hasilnya langsung dari properti Hasil Tugas), Anda akan memblokir utas utama pada saat yang sama. Ketika akhirnya Tugas selesai di dalam metode itu di threadpool, itu akan memanggil kelanjutan untuk mengirim kembali ke utas utama karena SynchronizationContext.Currenttersedia dan ditangkap. Tetapi ada masalah di sini: utas UI diblokir dan Anda menemui jalan buntu!

Juga, berikut adalah dua artikel bagus untuk Anda yang tepat untuk pertanyaan Anda:

• Resep Sempurna untuk Memotret Diri Sendiri - Mengakhiri Kebuntuan Menggunakan C # 5.0 Fitur Bahasa Asinkron
• Pustaka Klien NET. Asynchronous untuk API HTTP Anda dan Kesadaran tentang Efek Buruk async / await

Akhirnya, ada video pendek yang bagus dari Lucian Wischik tepatnya tentang topik ini: Metode perpustakaan Async harus mempertimbangkan untuk menggunakan Task.ConfigureAwait (false) .

Semoga ini membantu.

Kelemahan terbesar yang saya temukan dengan menggunakan ConfigureAwait (false) adalah budaya thread dikembalikan ke default sistem. Jika Anda mengkonfigurasi budaya misalnya ...

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

dan Anda hosting di server yang budayanya diatur ke en-AS, maka Anda akan menemukan sebelum ConfigureAwait (false) disebut CultureInfo.CurrentCulture akan mengembalikan en-AU dan setelah Anda mendapatkan en-AS. yaitu

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

Jika aplikasi Anda melakukan sesuatu yang membutuhkan pemformatan khusus data kultur, maka Anda harus memperhatikan hal ini saat menggunakan ConfigureAwait (false).

Saya memiliki beberapa pemikiran umum tentang implementasi Task:

1. Tugas sekali pakai namun kita tidak seharusnya menggunakannya using.
2. ConfigureAwaitdiperkenalkan pada 4.5. Taskdiperkenalkan pada 4.0.
3. .NET Threads selalu digunakan untuk mengalir konteks (lihat C # melalui buku CLR) tetapi dalam implementasi default Task.ContinueWithmereka tidak b / c disadari bahwa konteks switch mahal dan dimatikan secara default.
4. Masalahnya adalah pengembang perpustakaan tidak perlu peduli apakah kliennya memerlukan aliran konteks atau tidak maka tidak harus memutuskan apakah mengalir konteks atau tidak.
5. [Ditambahkan nanti] Fakta bahwa tidak ada jawaban resmi dan referensi yang tepat dan kami terus memperjuangkan ini berarti seseorang belum melakukan pekerjaannya dengan benar.

Saya sudah mendapat beberapa posting tentang masalah ini tetapi pendapat saya - selain jawaban bagus Tugberk - adalah bahwa Anda harus mengubah semua API tidak sinkron dan idealnya mengalir konteksnya. Karena Anda melakukan async, Anda cukup menggunakan kelanjutan alih-alih menunggu sehingga tidak ada jalan buntu yang disebabkan karena tidak ada menunggu dilakukan di perpustakaan dan Anda tetap mengalir agar konteksnya dipertahankan (seperti HttpContext).

Masalahnya adalah ketika perpustakaan memperlihatkan API sinkron tetapi menggunakan API asinkron lain - maka Anda perlu menggunakan Wait()/ Resultdalam kode Anda.