可能你已經(jīng)閱讀 C#5 關(guān)于 async 和 await 關(guān)鍵字以及它們?nèi)绾螏椭喕惒骄幊痰?可惜的是在升級VS2010后短短兩年時間,任然沒有準備好升級到VS2012,在VS2010和C#4中不能使用異步關(guān)鍵字,你可能會想 “如果我能在VS 2010中寫看起來同步的方法,但異步執(zhí)行.我的代碼會更清晰.”
看完這篇文章后,您將能夠做到這一點。我們將開發(fā)一個小的基礎(chǔ)結(jié)構(gòu)代碼,讓我們寫"看起來同步的方法,但異步執(zhí)行"的方法,這個VS2012 異步關(guān)鍵字一樣, 享受C#5的特性.
我們必須承認,async 和 await 是非常好的語法糖,我們的方法需要編寫更多的"AsyncResultcallback"方法適應這種變化.而當你終于升級到VS2012(或以后),這將是一件微不足道的小事,用C#關(guān)鍵字替換這個方法,只要簡單的語法變化,而不是一個艱苦的結(jié)構(gòu)重寫。
概要
async/await 是基于異步任務(wù)模式的關(guān)鍵字。鑒于 此處已經(jīng)有了非常完備的文檔描述,這里我就不再加以說明。但必須指出的是,TAP簡直帥到極點了!通過它你可以創(chuàng)建大量的將在未來某時間完成的小型單元工作(任務(wù));任務(wù)可以啟動其他的(嵌套)任務(wù) 并且/或者 建立一些僅當前置任務(wù)完成后才會啟動的后續(xù)任務(wù)。前置與后續(xù)任務(wù)則可以鏈接為一對多或是多對一的關(guān)系。當內(nèi)嵌任務(wù)完成時,父級任務(wù)無需與線程(重量級資源!)相綁定。執(zhí)行任務(wù)時也不必再擔心線程的時序安排,只需作出一些小小提示,框架將會自動為你處理這些事情。當程序開始運行,所有的任務(wù)將如溪流匯入大海般各自走向終點,又像柏青哥的小鐵球一樣相互反彈相互作用。
然而在C#4里面我們卻沒有async和await,不過缺少的也只是這一點點.Net5的新特性而已,這些新特性我們要么可以稍作回避,要么可以自己構(gòu)建,關(guān)鍵的Task類型還是可用的。
在一個C#5的異步(async)方法里,你要等待一個Task。這不會導致線程等待;而是這個方法返回一個Task給它的調(diào)用者,這個Task能夠等待(如果它自己是異步的)或者附上后續(xù)部分。(它同樣能在任務(wù)中或它的結(jié)果中調(diào)用Wait(),但這會和線程耦合,所以避免那樣做。)當?shù)却娜蝿?wù)成功完成,你的異步方法會在它中斷的地方繼續(xù)運行。
也許你會知道,C#5的編譯器會重寫它的異步方法為一個生成的實現(xiàn)了狀態(tài)機的嵌套類。C#正好還有一個特征(從2.0開始):迭代器(yield return 的方式)。這里的方法是使用一個迭代器方法在C#4中建造狀態(tài)機,返回一系列在全部處理過程中的等待步驟的Task。我們可以編寫一個方法接收一個從迭代器返回的任務(wù)的枚舉,返回一個重載過的Task來代表全部序列的完成以及提供它的最終結(jié)果(如果有)。
最終目標
Stephen Covey 建議我們目標有先后。這就是我們現(xiàn)在做的。已經(jīng)有大量例子來告訴我們?nèi)绾问褂胊sync/await來實現(xiàn)SLAMs(synchronous-looking asynchronous methods)。那么我們不使用這些關(guān)鍵字如何實現(xiàn)這個功能。我們來做一個C#5 async的例子,看看如何在C#4里實現(xiàn)它。然后我們討論一下轉(zhuǎn)換這些代碼的一般方法。
下面的例子展示了我們在C#5里實現(xiàn)異步讀寫方法Stream.CopyToAsync()的一種寫法。假設(shè)這個方法并沒有在.NET5里實現(xiàn)。
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,我們將分成兩塊:一個是相同訪問能力的方法,另一個是私有方法,參數(shù)一樣但返回類型不同。私有方法用迭代實現(xiàn)同樣的處理,結(jié)果是一連串等待的任務(wù)(IEnumerable
相同訪問能力(公用)方法返回與相應async方法一致的類型:void,Task,或者泛型Task
public static /*async*/ Task CopyToAsync( this Stream input, Stream output, CancellationToken cancellationToken = default(CancellationToken)) { return CopyToAsyncTasks(input, output, cancellationToken).ToTask(); } private static IEnumerableCopyToAsyncTasks( 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"結(jié)尾命名(除非它是事件處理器如startButton_Click)。給迭代器以同樣的名字后跟“Tasks”(如startButton_ClickTasks)。如果異步方法返回void值,它仍然會調(diào)用ToTask()但不會返回Task。如果異步方法返回Task
public /*async*/ void DoSomethingAsync() { DoSomethingAsyncTasks().ToTask(); } public /*async*/ Task DoSomethingAsync() { return DoSomethingAsyncTasks().ToTask(); } public /*async*/ TaskDoSomethingAsync() { return DoSomethingAsyncTasks().ToTask (); }
成對的迭代器方法不會更復雜。當異步方法等待非通用的Task時,迭代器簡單的將控制權(quán)轉(zhuǎn)給它。當異步方法等待task結(jié)果時,迭代器將task保存在一個變量中,轉(zhuǎn)到該方法,之后再使用它的返回值。兩種情況在上面的CopyToAsyncTasks()例子里都有顯示。
對包含通用resultTask
最后一件你需要知道的事情是如何處理中間返回的值。一個異步的方法可以從多重嵌套的塊中返回;我們的迭代器簡單的通過跳轉(zhuǎn)到結(jié)尾來模仿它。
// C#5 public async TaskDoSomethingAsync() { while (…) { foreach (…) { return "Result"; } } } // C#4; DoSomethingAsync() is necessary but omitted here. private IEnumerable DoSomethingAsyncTasks() { while (…) { foreach (…) { yield return TaskEx.FromResult("Result"); goto END; } } END: ; }
現(xiàn)在我們知道如何在C#4中寫SLAM了,但是只有實現(xiàn)了FromResult
簡單的開端
我們將在類System.Threading.Tasks.TaskEx下實現(xiàn)3個方法, 先從簡單的那2個方法開始。FromResult()方法先創(chuàng)建了一個TaskCompletionSource(), 然后給它的result賦值,最后返回Task。
public static TaskFromResult (TResult resultValue) { var completionSource = new TaskCompletionSource (); completionSource.SetResult(resultValue); return completionSource.Task; }
很顯然, 這2個ToTask()方法基本相同, 唯一的區(qū)別就是是否給返回對象Task的Result屬性賦值. 通常我們不會去寫2段相同的代碼, 所以我們會用其中的一個方法來實現(xiàn)另一個。 我們經(jīng)常使用泛型來作為返回結(jié)果集,那樣我們不用在意返回值同時也可以避免在最后進行類型轉(zhuǎn)換。 接下來我們先實現(xiàn)那個沒有用泛型的方法。
private abstract class VoidResult { } public static Task ToTask(this IEnumerabletasks) { return ToTask (tasks); }
目前為止我們就剩下一個 ToTask
第一次天真的嘗試
對于我們第一次嘗試實現(xiàn)的方法,我們將枚舉每個任務(wù)的Wait()來完成,然后將最終的任務(wù)做為結(jié)果(如果合適的話)。當然,我們不想占用當前線程,我們將另一個線程來執(zhí)行循環(huán)該任務(wù)。
// BAD CODE ! public static TaskToTask (this IEnumerable tasks) { var tcs = new TaskCompletionSource (); 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 ) 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,并且通過源代碼設(shè)置了完成狀態(tài)。
但這里有些主要的問題。最嚴重的是:
是需要想點辦法的時候了!
連續(xù)循環(huán)
最大的想法是直接從迭代器中獲取其所產(chǎn)生的第一個任務(wù)。 我們創(chuàng)建了一個延續(xù),使其在完成時能夠檢查任務(wù)的狀態(tài)并且(如果成功的話)能接收下一個任務(wù)和創(chuàng)建另一個延續(xù)直至其結(jié)束。(如果沒有,即迭代器沒有需要完成的需求。)
// 很牛逼,但是我們還沒有。 public static TaskToTask (this IEnumerable tasks) { var taskScheduler = SynchronizationContext.Current == null ? TaskScheduler.Default : TaskScheduler.FromCurrentSynchronizationContext(); var tcs = new TaskCompletionSource (); 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 ( IEnumerator taskEnumerator, TaskScheduler taskScheduler, TaskCompletionSource 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()) { // 設(shè)置最后任務(wù)返回的結(jié)果,直至無需
這里有許多值得分享的:
我們的后續(xù)部分(continuations)使用涉及SynchronizationContext的TaskScheduler,如果有的話。這使得我們的迭代器在UI線程初始化以后,立刻或者在一個繼續(xù)點被調(diào)用,去訪問UI控件。
進程不中斷的運行,因此沒有線程掛起等待!順便說一下,在ToTaskDoOneStep()中對自身的調(diào)用不是遞歸調(diào)用;它是在taskEnumerator.Currenttask結(jié)束后調(diào)用的匿名函數(shù),當前活動在調(diào)用ContinueWith()幾乎立刻退出,它完全獨立于后續(xù)部分。
此外,我們在繼續(xù)點中驗證每個嵌套task的狀態(tài),不是檢查一個預測值。
然而,這兒至少有一個大問題和一些小一點的問題。
如果迭代器拋出一個未處理異常,或者拋出OperationCanceledException而取消,我們沒有處理它或設(shè)置主task的狀態(tài)。這是我們以前曾經(jīng)做過的但在此版本丟失了。
為了修復問題1,我們不得不在兩個方法中調(diào)用MoveNext()的地方引入同樣的異常處理機制。即使是現(xiàn)在,兩個方法中都有一樣的后續(xù)部分建立。我們違背了“不要重復你自己”的信條。
如果異步方法被期望給出一個結(jié)果,但是迭代器沒有提供就退出了會怎么樣呢?或者它最后的task是錯誤的類型呢?第一種情形下,我們默默返回默認的結(jié)果類型;第二種情形,我們拋出一個未處理的InvalidCastException,主task永遠不會到達結(jié)束狀態(tài)!我們的程序?qū)⒂谰玫膾炱稹?/p>
最后,如果一個嵌套的task取消或者發(fā)生錯誤呢?我們設(shè)置主task狀態(tài),再也不會調(diào)用迭代器。可能是在一個using塊,或帶有finally的try塊的內(nèi)部,并且有一些清理要做。我們應當遵守過程在中斷的時候使它結(jié)束,而不要等垃圾收集器去做這些。我們怎么做到呢?當然通過一個后續(xù)部分!
為了解決這些問題,我們從ToTask()中移走MoveNext()調(diào)用,取而代之一個對ToTaskDoOneStep()的初始化的同步調(diào)用。然后我們將在一個提防增加合適的異常處理。
最終版本
這里是ToTask
public static TaskToTask (this IEnumerable tasks) { var taskScheduler = SynchronizationContext.Current == null ? TaskScheduler.Default : TaskScheduler.FromCurrentSynchronizationContext(); var taskEnumerator = tasks.GetEnumerator(); var completionSource = new TaskCompletionSource (); // 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 ( IEnumerator taskEnumerator, TaskScheduler taskScheduler, TaskCompletionSource 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 )) { // Wrong result completionSource.SetException(new InvalidOperationException( "Asynchronous iterator " + taskEnumerator + " requires a final result task of type " + typeof(Task ).FullName + (completedTask == null ? ", but none was provided." : "; the actual task type was " + completedTask.GetType().FullName))); } else { completionSource.SetResult(((Task ) completedTask).Result); } } else { // When the nested task completes, continue by performing this function again. taskEnumerator.Current.ContinueWith( nextTask => ToTaskDoOneStep(taskEnumerator, taskScheduler, completionSource, nextTask), taskScheduler); } }
瞧! 現(xiàn)在你會在Visual Studio 2010中用沒有async和await的 C#4 (或 VB10)寫SLAMs(看起來同步的方法,但異步執(zhí)行)。
有趣的地方
直到最后那個版本,我一直在給ToTask()傳遞一個CancellationTokenUp,并且將它傳播進后續(xù)部分的ToTaskDoOneStep()。(這與本文毫不相關(guān),所以我去掉了它們。你可以在樣例代碼中看注釋掉的痕跡。)這有兩個原因。第一,處理OperationCanceledException時,我會檢查它的CancellationToken以確認它與這個操作是匹配的。如果不是,它將用一個錯誤來代替取消動作。雖然技術(shù)上沒錯,但不幸的是取消令牌可能會混淆,在其傳遞給ToTask()調(diào)用和后續(xù)部分之間的無關(guān)信息使它不值得。(如果你們這些 Task專家能給我一個注釋里的可確認發(fā)生的好的用例,我會重新考慮)
第二個原因是我會檢查令牌是否取消,在每次MoveNext()調(diào)用迭代器之前,立即取消主task時,和退出進程的時候。這使你可以不經(jīng)過迭代器檢查令牌,具有取消的行為。我不認為這是要做的正確事情(因為對一個異步進程在yield return處取消是不合適的)——更可能是它完全在迭代器進程控制之下——但我想試試。它無法工作。我發(fā)現(xiàn)在某些情形,task會取消而卻后續(xù)部分不會觸發(fā)。請看樣例代碼;我靠繼續(xù)執(zhí)行來恢復按鈕可用,但它沒有發(fā)生因此按鈕在進程結(jié)束之后仍不可用。我在樣例代碼中留下了注釋掉的取消檢測;你可以將取消令牌的方法參數(shù)放回去并測試它。(如果你們Task專家能解釋為什么會是這種情形,我將很感激!)
聲明:本網(wǎng)頁內(nèi)容旨在傳播知識,若有侵權(quán)等問題請及時與本網(wǎng)聯(lián)系,我們將在第一時間刪除處理。TEL:177 7030 7066 E-MAIL:11247931@qq.com