Singkatnya: Async / Menunggu Praktik Terbaik di .NET

Async / Menunggu - Pendahuluan

Mesin Negara (IAsyncStateMachine)

using System.Diagnostics;

namespace AsyncAwait
{
    public class AsyncAwait
    {

        public async Task AsyncAwaitExample()
        {
            int myVariable = 0;

            await DummyAsyncMethod();
            Debug.WriteLine("Continuation - After First Await");
            myVariable = 1;

            await DummyAsyncMethod();
            Debug.WriteLine("Continuation - After Second Await");
            myVariable = 2;

        }

        public async Task DummyAsyncMethod()
        {
            // 
        }

    }
}

Kapan Menggunakan Async / Menunggu

• Pekerjaan terkait I / O : Kode Anda akan mengharapkan sesuatu, seperti data dari database, membaca file, memanggil layanan web. Dalam hal ini, Anda harus menggunakan Async / Menunggu, bukan Perpustakaan Paralel Tugas.
• Pekerjaan terkait CPU : kode Anda akan melakukan perhitungan yang rumit. Dalam hal ini, Anda harus menggunakan Async / Menunggu, tetapi Anda harus mulai bekerja di utas lain menggunakan Task.Run. Anda juga dapat mempertimbangkan menggunakan Perpustakaan Tugas Paralel .

Async sepanjang jalan

Jika metode ini dinyatakan sebagai async, pastikan ada yang menunggu!

Hindari async void

public async void AsyncVoidMethod()
{
    //!
}

public async Task AsyncTaskMethod()
{
    //!
}

• Pengecualian yang dilemparkan dalam metode void async tidak dapat ditangkap di luar metode ini :

public async void AsyncVoidMethodThrowsException()
{
    throw new Exception("Hmmm, something went wrong!");
}

public void ThisWillNotCatchTheException()
{
    try
    {
        AsyncVoidMethodThrowsException();
    }
    catch(Exception ex)
    {
        //     
        Debug.WriteLine(ex.Message);
    }
}

public async Task AsyncTaskMethodThrowsException()
{
    throw new Exception("Hmmm, something went wrong!");
}

public async Task ThisWillCatchTheException()
{
    try
    {
        await AsyncTaskMethodThrowsException();
    }
    catch (Exception ex)
    {
        //    
        Debug.WriteLine(ex.Message);
    }
}

• Metode async void dapat menyebabkan efek samping yang tidak diinginkan jika penelepon tidak mengharapkannya asinkron : jika metode asinkron Anda tidak menghasilkan apa-apa, gunakan Tugas async (tanpa " <T >" untuk Tugas) sebagai jenis pengembalian.
• Metode batal async sangat sulit untuk diuji : karena perbedaan dalam penanganan kesalahan dan tata letak, sulit untuk menulis unit test yang memanggil metode batal async. Tes Asynchronous MSTest hanya bekerja untuk metode asynchronous yang mengembalikan Task atau Task <T >.

Lebih suka mengembalikan tugas daripada menunggu kembali

public async Task<string> AsyncTask()

{
   //  !
   //...  -  
   //await -   ,  await  

   return await GetData();

}

public Task<string> JustTask()

{
   //!
   //...  -  
   // Task

   return GetData();

}

Jangan bungkus kembali tugas di dalam try..catch {} atau menggunakan {} blok

public Task<string> ReturnTaskExceptionNotCaught()

{
   try
   {
       // ...

       return GetData();

   }
   catch (Exception ex)

   {
       //     

       Debug.WriteLine(ex.Message);
       throw;
   }

}

public Task<string> ReturnTaskUsingProblem()

{
   using (var resource = GetResource())
   {

       // ...  ,     , ,    

       return GetData(resource);
   }
}

Hindari menggunakan .Wait()atau .Result- gunakan sajaGetAwaiter().GetResult()

public void GetAwaiterGetResultExample()

{
   // ,    ,     AggregateException  

   string data = GetData().Result;

   // ,   ,      

   data = GetData().GetAwaiter().GetResult();
}

Jika metode ini tidak sinkron, tambahkan akhiran Async ke namanya

Metode pustaka asinkron harus menggunakan Task.ConfigureAwait (false) untuk meningkatkan kinerja

public async Task ConfigureAwaitExample()

{
   //   ConfigureAwait(false)   .

   var data = await GetData().ConfigureAwait(false);
}

Laporan kemajuan tugas tidak sinkron

Batalkan Tugas Asinkron

1. Penelepon membuat objek PembatalanTokenSource.
2. Penelepon memanggil API asinkron yang dibatalkan dan melewati CancurToken dari CancurTokenSource (CancurTokenSource.Token).
3. Penelepon meminta pembatalan menggunakan objek PembatalanTokenSource (PembatalanTokenSource.Cancel ()).
4. Tugas mengkonfirmasi pembatalan dan membatalkan itu sendiri, biasanya menggunakan metode PembatalanToken.ThrowIfCancellationRequested.

Laporan Kemajuan dan Pembatalan - Contoh

using System;
using System.Threading.Tasks;
using System.Windows.Forms;
using System.Threading;
namespace TestAsyncAwait
{
   public partial class AsyncProgressCancelExampleForm : Form
   {
       public AsyncProgressCancelExampleForm()
       {
           InitializeComponent();
       }

       CancellationTokenSource _cts = new CancellationTokenSource();

       private async void btnRunAsync_Click(object sender, EventArgs e)

       {

           //   .

            <int>   ,          ,   ,    , ETA  . .

           var progressIndicator = new Progress<int>(ReportProgress);

           try

           {
               //   ,         

               await AsyncMethod(progressIndicator, _cts.Token);

           }

           catch (OperationCanceledException ex)

           {
               // 

               lblProgress.Text = "Cancelled";
           }
       }

       private void btnCancel_Click(object sender, EventArgs e)

       {
          // 
           _cts.Cancel();

       }

       private void ReportProgress(int value)

       {
           //    

           lblProgress.Text = value.ToString();

       }

       private async Task AsyncMethod(IProgress<int> progress, CancellationToken ct)

       {

           for (int i = 0; i < 100; i++)

           {
              //   ,     

               await Task.Delay(1000);

               //   

               if (ct != null)

               {

                   ct.ThrowIfCancellationRequested();

               }

               //   

               if (progress != null)

               {

                   progress.Report(i);
               }
           }
       }
   }
}

Menunggu beberapa saat

Menunggu beberapa tugas tidak sinkron diselesaikan