使用C# yield關鍵字來提高效能和可讀性

對於”yield”這個關鍵字我已經見過N次了，直到最近我才知道這個關鍵字所蘊含的力量。我將在下面展示出一些使用”yield”讓你的代碼有更高可讀性和更好效能的例子.

為了讓你對yield有一些快速概覽,我首先要展示一個沒有使用這個關鍵字的例子,下面的代碼很簡單，但在我最近的項目中卻很常見

IList<string> FindBobs(IEnumerable<string> names){var bobs = new List<string>();foreach(var currName in names){if(currName == "Bob")bobs.Add(currName);}return bobs;}

注意在這裡我使用IEnumerable<string>作為參數類型並以IList<string>作為傳回型別，通常來說，我更傾向於在參數輸入的類型方面的範圍越寬越好，但在傳回型別上面更加嚴格（譯者按：即輸入時多用基類或介面，返回時用子類或實作類別），對於輸入來說，如果你需要用foreach來對其進行迴圈的話，使用IEnumerable會更有意義。而對於輸出（譯者按：也就是返回），我使用介面來讓實現部分可以改變。在這裡我想讓調用者省去產生列表的麻煩，所以我選擇list作為傳回型別.

而問題在於，我的設計並不具有可連結性，這樣的設計需要產生列表作為傳回值，實現上，這個列表或許不會很大，但這並不必要

現在,讓我們來看看以“yield”的方式來做這些，而後我會解釋如何使用它，以及它工作的原理。

IEnumerable<string> FindBobs(IEnumerable<string> names){foreach(var currName in names){if(currName == "Bob")yield return currName;}}

在這個版本中，我們將傳回型別改為IEnumerable，並且我們使用”yield return”.注意我再也不需要建立一個列表，現在是不是有些迷惑的？別著急，在理解它的工作方式的情況它會變的越來越簡單.

當使用”yield return”關鍵片語時，.net會為你產生一大串管道代碼，你可以儘管假裝這是個魔法。當開始在被調用的代碼中迴圈時（這裡不是list),實現上發生的是這個函數被一遍一遍的調用，但每一次都從上一次執行退出的部分開始繼續執行.

傳統的執行方法

1. 調用函數
2. 函數執行並返回list
3. 調用部分使用返回的list

Yield的執行方法

1. 調用函數
2. 調用者請求item
3. 下一個item返回
4. 回到步驟2

雖然yield執行的實現貌似有些複雜，但我們最終只需要一次“彈出”一個item，而不是建立整個list並返回.

對於句法說，我個人認為yield更加簡潔，並且對於傳遞函數的用途表現的更好（譯者按：也就是代碼可讀性）,我使用IEnumerable作為傳回型別來通知調用者它可以被foreach迴圈並且返回資料，而調用者現在可以自己決定它是否願意將傳回值存放到列表中，即使這會以效能作為代價。

在我提供的這個簡單例子中，也許你並不能發現很多使用yield的好處，然而，你可以在調用者需要取消遍曆所有的函數提供的內容時節省很多不必要的工作，當你在方法連結時使用yield，你可以省下的工作(時間）或許會成倍疊加。

Ayende已經有了很棒的例子:using yield for a slick pipes & filters implementation,他甚至還講述了：version that is multi-threaded。這讓我覺得非常有趣.

最開始我對yield的保留意見是使用這個關鍵字或許會導致潛在的效能問題，但實際上，至今為止我還未能發現任何資訊來說明關於yield對效能的影響,而我在上面提到提高效能的地方遠遠大於編譯器overhead那部分。

小結

Yield可以讓你的代碼更加高效並擁有更高的可讀性，已經是.net 2.0時代了，我想已經沒有什麼借口可以阻止我們學習和使用yield.