باختصار: Async / Await أفضل الممارسات في .NET

غير متزامن / انتظار - مقدمة

آلة الدولة (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()
        {
            // 
        }

    }
}

متى تستخدم Async / Await

• العمل المرتبط بإدخال / إخراج : يتوقع الرمز الخاص بك شيئًا ، مثل البيانات من قاعدة بيانات ، أو قراءة ملف ، أو الاتصال بخدمة ويب. في هذه الحالة ، يجب عليك استخدام Async / Await ، وليس مكتبة المهام المتوازية.
• العمل المتعلق بوحدة المعالجة المركزية : سيقوم الكود الخاص بك بإجراء حسابات معقدة. في هذه الحالة ، يجب عليك استخدام Async / Await ، لكنك تحتاج إلى بدء العمل في موضوع آخر باستخدام Task.Run. يمكنك أيضًا التفكير في استخدام Task Parallel Library .

غير متزامن على طول الطريق

إذا تم إعلان الطريقة غير متزامنة ، فتأكد من وجود انتظار!

تجنب الفراغ غير المتزامن

public async void AsyncVoidMethod()
{
    //!
}

public async Task AsyncTaskMethod()
{
    //!
}

• لا يمكن اكتشاف الاستثناءات التي تم طرحها في طريقة إلغاء التزامن خارج هذه الطريقة :

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

• يمكن أن تتسبب طرق الفراغ غير المتزامن في حدوث آثار جانبية غير مرغوب فيها إذا لم يتوقع المتصل أن تكون غير متزامنة : إذا لم تُرجع طريقتك غير المتزامنة أي شيء ، فاستخدم مهمة غير متزامنة (بدون " <T >" للمهمة) كنوع الإرجاع.
• من الصعب جدًا اختبار طرق الفراغ غير المتزامن : نظرًا للاختلافات في معالجة الأخطاء والتخطيط ، يصعب كتابة اختبارات الوحدة التي تستدعي طرق الفراغ غير المتزامن. غير المتزامن MSTest اختبار يعمل فقط لأساليب غير متزامن التي ترجع مهمة أو مهمة <T >.

تفضل مهمة الإرجاع بدلاً من انتظار العودة

public async Task<string> AsyncTask()

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

   return await GetData();

}

public Task<string> JustTask()

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

   return GetData();

}

لا تلف مهمة الإرجاع داخل try..catch {} أو استخدام {} block

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

تجنب استخدام .Wait()أو .Result- استخدم بدلاً من ذلكGetAwaiter().GetResult()

public void GetAwaiterGetResultExample()

{
   // ,    ,     AggregateException  

   string data = GetData().Result;

   // ,   ,      

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

إذا كانت الطريقة غير متزامنة ، قم بإضافة لاحقة Async إلى اسمها

يجب أن تستخدم أساليب المكتبة غير المتزامنة Task.ConfigureAwait (false) لتحسين الأداء

public async Task ConfigureAwaitExample()

{
   //   ConfigureAwait(false)   .

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

تقرير تقدم المهمة غير المتزامن

إلغاء المهام غير المتزامنة

1. يقوم المتصل بإنشاء كائن CancellationTokenSource.
2. يتصل المتصل بواجهة برمجة التطبيقات غير المتزامنة الملغاة ويمرر CancellationToken من CancellationTokenSource (CancellationTokenSource.Token).
3. يطلب المتصل إلغاء باستخدام كائن CancellationTokenSource (CancellationTokenSource.Cancel ()).
4. تؤكد المهمة الإلغاء وتلغي نفسها ، عادةً باستخدام طريقة CancellationToken.ThrowIfCancellationRequested.

تقرير التقدم والإلغاء - مثال

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

الانتظار لفترة من الزمن

في انتظار اكتمال العديد من المهام غير المتزامنة