DIV CSS 佈局教程網

在 C# 4 中用迭代器實作出 await 般的非同步等待
編輯:關於JavaScript     

前言

C# 5 的 async 與 await 讓非同步程式碼寫起來幾乎跟同步一樣直覺。但如果你手上還是 Visual Studio 2010 加 C# 4,用不到這兩個關鍵字,那會很自然会想:能不能自己湊出一個「看起來同步、實際非同步執行」的寫法?本文示範如何做到。

我們會逐步打造一小段基礎結構,讓方法以同步的外觀撰寫、以非同步的方式執行。等到日後真的升級到 C# 5,替換成本幾乎只是把方法加上 async 修飾、把等待處改成 await,屬於語法層面的微調,而不是架構層面的重寫。

必須承認 async/await 是非常棒的語法糖。少了它,我們得自己寫一堆 callback 來串接,而本文的目標正是把這份繁瑣收攏起來。

TAP 的思維

async/await 建立在非同步任務模式(Task-based Asynchronous Pattern, TAP)之上。TAP 的概念很優雅:你可以建立大量「未來某個時間會完成」的小型工作單元,也就是 Task;任務之間可以巢狀、可以串接後續任務,形成一對多或多對一的關係。當內層任務完成時,父任務並不需要綁住一個執行緒這種重量級資源,也不必操心時序調度,交給框架處理即可。

問題是 C# 4 沒有 async 與 await。不過缺的其實只有這一點點新語法,關鍵的 Task 型別仍然可用,剩下的我們自己補。

在 C# 5 的 async 方法裡等待一個 Task,不會造成執行緒阻塞:方法會把 Task 交回呼叫者,由呼叫者決定要等待還是掛上後續動作。等被等待的任務成功完成,async 方法就從中斷處繼續。C# 5 編譯器會把 async 方法改寫成一個實作狀態機的巢狀類別。

而 C# 從 2.0 就具備另一個特性:迭代器(yield return)。它同樣是被編譯器改寫成狀態機。於是我們的作法就是:用迭代器方法在 C# 4 裡手動建立狀態機,讓它依序 yield 出整個流程中需要等待的 Task;再寫一個方法接收這個 Task 列舉器,回傳一個代表整段序列完成的 Task,並在適當時提供最終結果。

最終目標

先看 C# 5 的寫法長什麼樣子。以下示範實作一個 Stream.CopyToAsync()(假設 .NET 5 尚未內建):

 public static async Task CopyToAsync( this Stream input, Stream output, CancellationToken cancellationToken = default(CancellationToken)) { byte[] buffer = new byte[0x1000]; // 4 KiB while (true) { cancellationToken.ThrowIfCancellationRequested(); int bytesRead = await input.ReadAsync(buffer, 0, buffer.Length); if (bytesRead == 0) break; cancellationToken.ThrowIfCancellationRequested(); await output.WriteAsync(buffer, 0, bytesRead); } }

在 C# 4 中,我們把它拆成兩個方法:一個對外、簽章與 async 版本一致;一個私有,參數相同但回傳 IEnumerable<Task>,用迭代器實作同樣的流程,依序 yield 出每個要等待的任務。序列中的任務可以是無泛型或有泛型的任意組合(幸好 Task<T> 是 Task 的子類別)。

 public static /*async*/ Task CopyToAsync( this Stream input, Stream output, CancellationToken cancellationToken = default(CancellationToken)) { return CopyToAsyncTasks(input, output, cancellationToken).ToTask(); } private static IEnumerable<Task> CopyToAsyncTasks( Stream input, Stream output, CancellationToken cancellationToken) { byte[] buffer = new byte[0x1000]; // 4 KiB while (true) { cancellationToken.ThrowIfCancellationRequested(); var bytesReadTask = input.ReadAsync(buffer, 0, buffer.Length); yield return bytesReadTask; if (bytesReadTask.Result == 0) break; cancellationToken.ThrowIfCancellationRequested(); yield return output.WriteAsync(buffer, 0, bytesReadTask.Result); } }

命名慣例:async 方法以 Async 結尾(事件處理常式如 startButton_Click 例外),對應的迭代器則在同一名稱後加上 Tasks。依回傳型別不同,三種對應寫法如下:

 public /*async*/ void DoSomethingAsync() { DoSomethingAsyncTasks().ToTask(); } public /*async*/ Task DoSomethingAsync() { return DoSomethingAsyncTasks().ToTask(); } public /*async*/ Task<String> DoSomethingAsync() { return DoSomethingAsyncTasks().ToTask<String>(); }

成對的迭代器方法並不會更複雜:等待無泛型 Task 時,直接把控制權交出去;需要 Task 的結果時,把它存進變數、讓流程前進,之後再取用其回傳值。上面的 CopyToAsyncTasks() 兩種情況都出現了。

若 SLAM 帶有泛型結果 Task<X>,迭代器必須把控制權交給確切型別,由 ToTask<X>() 把最後一個 Task 轉型以取出結果。如果迭代器只是要打包一個中間計算值,.NET 5 提供了方便的靜態方法,.NET 4 沒有,所以我們自備 TaskEx.FromResult<T>(value)。

最後要處理的是「中途 return」。async 方法可以從多重巢狀區塊中回傳,我們的迭代器只要跳到結尾來模擬即可:

 // C#5 public async Task<String> DoSomethingAsync() { while (…) { foreach (…) { return "Result"; } } } // C#4; DoSomethingAsync() is necessary but omitted here. private IEnumerable<Task> DoSomethingAsyncTasks() { while (…) { foreach (…) { yield return TaskEx.FromResult("Result"); goto END; } } END: ; }

簡單的開端

我們在 System.Threading.Tasks.TaskEx 下實作三個方法。FromResult() 先建立一個 TaskCompletionSource,設定結果後回傳它的 Task:

 public static Task<TResult> FromResult<TResult>(TResult resultValue) { var completionSource = new TaskCompletionSource<TResult>(); completionSource.SetResult(resultValue); return completionSource.Task; }

兩個 ToTask() 幾乎相同,唯一差別是要不要給 Result 賦值。既然不想寫兩段重複程式,就用其中一個實作另一個:我們用泛型當作結果承載,這樣既能表達「不需要結果」,也省掉最後的型別轉換。先實作沒有泛型的那個:

 private abstract class VoidResult { } public static Task ToTask(this IEnumerable<Task> tasks) { return ToTask<VoidResult>(tasks); } 

於是只剩 ToTask<T>() 需要實作。

第一次天真嘗試

最直覺的做法是逐一呼叫每個 Task 的 Wait(),最後把末位任務當成結果。為了不佔用目前的執行緒,我們另開一個背景執行緒跑這個迴圈:

 // BAD CODE ! public static Task<TResult> ToTask<TResult>(this IEnumerable<Task> tasks) { var tcs = new TaskCompletionSource<TResult>(); Task.Factory.StartNew(() => { Task last = null; try { foreach (var task in tasks) { last = task; task.Wait(); } // Set the result from the last task returned, unless no result is requested. tcs.SetResult( last == null || typeof(TResult) == typeof(VoidResult) ? default(TResult) : ((Task<TResult>) last).Result); } catch (AggregateException aggrEx) { // If task.Wait() threw an exception it will be wrapped in an Aggregate; unwrap it. if (aggrEx.InnerExceptions.Count != 1) tcs.SetException(aggrEx); else if (aggrEx.InnerException is OperationCanceledException) tcs.SetCanceled(); else tcs.SetException(aggrEx.InnerException); } catch (OperationCanceledException cancEx) { tcs.SetCanceled(); } catch (Exception ex) { tcs.SetException(ex); } }); return tcs.Task; } 

這個版本有幾個可取之處:它確實回傳了由 TaskCompletionSource 產生的 Task,並透過原始碼設定完成狀態;示範了如何從迭代器最後一個任務取得最終 Result,同時避開「根本沒有結果」的情況;也示範了如何攔下迭代器丟出的例外並轉成 Canceled 或 Faulted 狀態。

但問題也很嚴重:

  • 迭代器之所以能維持「非同步」的假象,是因為它從 UI 執行緒啟動,方法體因此可以存取 UI 控制項。但這裡的 foreach 迴圈跑在背景執行緒上,從那一刻起就不能再碰 UI 了——這個版本完全沒有考慮 SynchronizationContext。
  • 即使不在 UI 環境下也有麻煩。我們可能想同時跑很多個由 SLAM 實作的並行 Task,但迴圈裡的 Wait() 會在等待巢狀任務(可能是需要很久的遠端呼叫)時把執行緒掛住,最終導致執行緒池耗盡。
  • 把 AggregateException 拆包再重新拋出,寫法並不自然。更好的作法是直接捕捉並傳遞狀態,而不是靠拋例外。
  • 有些 SLAM 其實能立刻決定完成狀態,C# 5 的 async 在這種情況下會有效率地同步完成;但我們這裡一律先排了一個背景任務,白白失去了這個優勢。

是時候換個思路了。

改用連續接續

核心想法是:直接從迭代器取出第一個產生的任務,建立一個 continuation,讓它在完成時檢查狀態,若成功就取下個任務並建立下一個 continuation,直到序列結束。

 // 很牛逼,但是我們還沒有。 public static Task<TResult> ToTask<TResult>(this IEnumerable<Task> tasks) { var taskScheduler = SynchronizationContext.Current == null ? TaskScheduler.Default : TaskScheduler.FromCurrentSynchronizationContext(); var tcs = new TaskCompletionSource<TResult>(); var taskEnumerator = tasks.GetEnumerator(); if (!taskEnumerator.MoveNext()) { tcs.SetResult(default(TResult)); return tcs.Task; } taskEnumerator.Current.ContinueWith( t => ToTaskDoOneStep(taskEnumerator, taskScheduler, tcs, t), taskScheduler); return tcs.Task; } private static void ToTaskDoOneStep<TResult>( IEnumerator<Task> taskEnumerator, TaskScheduler taskScheduler, TaskCompletionSource<TResult> tcs, Task completedTask) { var status = completedTask.Status; if (status == TaskStatus.Canceled) { tcs.SetCanceled(); } else if (status == TaskStatus.Faulted) { tcs.SetException(completedTask.Exception); } else if (!taskEnumerator.MoveNext()) { // 設置最後任務返回的結果,直至無需結果為止。 tcs.SetResult( typeof(TResult) == typeof(VoidResult) ? default(TResult) : ((Task<TResult>) completedTask).Result); } else { taskEnumerator.Current.ContinueWith( t => ToTaskDoOneStep(taskEnumerator, taskScheduler, tcs, t), taskScheduler); } } 

這版有幾個關鍵改進:

continuation 使用綁定 SynchronizationContext 的 TaskScheduler(若存在),因此迭代器能在 UI 執行緒上被呼叫,可以正常存取控制項。

流程不中斷,完全沒有執行緒被掛起等待。順帶一提,ToTaskDoOneStep() 對自身的呼叫並不是遞迴,而是註冊在當前任務完成後才執行的匿名函式,ContinueWith() 幾乎立刻返回。

我們在每個接續點逐一驗證巢狀任務的狀態,而不是依賴預測。

不過仍有幾個明顯缺陷:迭代器若拋出未處理例外或 OperationCanceledException,我們沒有攔下它,主任務的狀態也不會被設定;而為了修正這點,就必須在兩處呼叫 MoveNext() 的地方都加上一樣的例外處理,連帶造成 continuation 建立邏輯重複,違反了「不要重複自己」的原則。此外,若 async 方法預期要給結果,迭代器卻沒提供就結束,我們會默默回傳預設值;若最後一個任務型別不對,則會拋出未處理的 InvalidCastException,主任務永遠不會完成,程式就永久掛在那裡。最後,若某個巢狀任務被取消或出錯,我們設定了主任務狀態卻再也不回到迭代器,萬一它身處 using 區塊或帶 finally 的 try 區塊中,該做的清理就不會執行——這應該由我們主動收尾,而不是等垃圾回收。

最終版本

為了解決上述問題,我們把 MoveNext() 的呼叫從 ToTask() 移到 ToTaskDoOneStep() 開頭,並在那裡統一加上例外處理:

 public static Task<TResult> ToTask<TResult>(this IEnumerable<Task> tasks) { var taskScheduler = SynchronizationContext.Current == null ? TaskScheduler.Default : TaskScheduler.FromCurrentSynchronizationContext(); var taskEnumerator = tasks.GetEnumerator(); var completionSource = new TaskCompletionSource<TResult>(); // Clean up the enumerator when the task completes. completionSource.Task.ContinueWith(t => taskEnumerator.Dispose(), taskScheduler); ToTaskDoOneStep(taskEnumerator, taskScheduler, completionSource, null); return completionSource.Task; } private static void ToTaskDoOneStep<TResult>( IEnumerator<Task> taskEnumerator, TaskScheduler taskScheduler, TaskCompletionSource<TResult> completionSource, Task completedTask) { // Check status of previous nested task (if any), and stop if Canceled or Faulted. TaskStatus status; if (completedTask == null) { // This is the first task from the iterator; skip status check. } else if ((status = completedTask.Status) == TaskStatus.Canceled) { completionSource.SetCanceled(); return; } else if (status == TaskStatus.Faulted) { completionSource.SetException(completedTask.Exception); return; } // Find the next Task in the iterator; handle cancellation and other exceptions. Boolean haveMore; try { haveMore = taskEnumerator.MoveNext(); } catch (OperationCanceledException cancExc) { completionSource.SetCanceled(); return; } catch (Exception exc) { completionSource.SetException(exc); return; } if (!haveMore) { // No more tasks; set the result (if any) from the last completed task (if any). // We know it's not Canceled or Faulted because we checked at the start of this method. if (typeof(TResult) == typeof(VoidResult)) { // No result completionSource.SetResult(default(TResult)); } else if (!(completedTask is Task<TResult>)) { // Wrong result completionSource.SetException(new InvalidOperationException( "Asynchronous iterator " + taskEnumerator + " requires a final result task of type " + typeof(Task<TResult>).FullName + (completedTask == null ? ", but none was provided." : "; the actual task type was " + completedTask.GetType().FullName))); } else { completionSource.SetResult(((Task<TResult>) completedTask).Result); } } else { // When the nested task completes, continue by performing this function again. taskEnumerator.Current.ContinueWith( nextTask => ToTaskDoOneStep(taskEnumerator, taskScheduler, completionSource, nextTask), taskScheduler); } } 

這個版本用 TaskCompletionSource 回傳主任務、永遠不造成執行緒等待、在有 SynchronizationContext 時會正確參與其中、由迭代器本身處理例外、直接傳遞巢狀任務的結束狀態(而非包成 AggregateException)、在需要時回傳結果值,並且當型別不符時丟出友善的錯誤訊息而不是讓程式靜靜掛死。

到這裡,你就能在 Visual Studio 2010 的 C# 4(或 VB10)環境中,寫出「看起來同步、實際非同步執行」的方法了。

補充:一些嘗試過的弯路

在最終版本之前,我曾把 CancellationToken 一路傳進 ToTask() 與後續的 ToTaskDoOneStep()(與本文主題無關,故已移除)。這麼做有兩個理由:一是處理 OperationCanceledException 時,會先檢查它的 Token 是否與本次操作相符,若不符就以錯誤呈現;但實務上 Token 容易被誤傳,混進無關資訊後反而不值得。二是我會在每次 MoveNext() 之前檢查 Token,讓取消能立即生效;但實測發現某些情況下任務被取消了,後續的 continuation 卻沒有觸發,導致流程結束後按鈕仍停在不可用狀態。這段取消偵測的程式碼仍保留在範例檔案中(以註解呈現),有興趣的人可以自行測試。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved