C#使用yield關鍵字提升迭代性能與效率

作者：大姚 2025-01-22 08:06:38

yield關鍵字在C#中簡化了數據迭代的方式，實現了按需生成數據，自動維護迭代狀態，減少了內存占用，并允許在迭代時執行復雜邏輯。

前言

yield關鍵字在C#中簡化了數據迭代的方式，實現了按需生成數據，自動維護迭代狀態，減少了內存占用，并允許在迭代時執行復雜邏輯。

傳統迭代和yield迭代方式對比

咱們來看看傳統迭代方式和yield關鍵字迭代方式對比，是否如傳說中的代碼實現起來更簡潔和高效：

/// <summary>
        /// 傳統迭代方式和yield關鍵字迭代方式對比
        /// </summary>
        public static void IteratorComparisonRun()
        {
            Console.WriteLine("迭代器方法使用yield關鍵字:");
            foreach (var number in GetNumbersWithYield())
            {
                Console.WriteLine(number);
            }

            Console.WriteLine("傳統迭代方法返回一個List<int>");
            var numbers = GetNumbersWithoutYield();
            foreach (var number in numbers)
            {
                Console.WriteLine(number);
            }
        }

        /// <summary>
        /// 迭代器方法使用yield關鍵字
        /// </summary>
        /// <returns></returns>
        public static IEnumerable<int> GetNumbersWithYield()
        {
            for (int i = 0; i < 6; i++)
            {
                yield return i;
            }
        }

        /// <summary>
        /// 傳統迭代方法返回一個List<int>
        /// </summary>
        /// <returns></returns>
        public static List<int> GetNumbersWithoutYield()
        {
            var numbers = new List<int>();
            for (int i = 0; i < 6; i++)
            {
                numbers.Add(i);
            }
            return numbers;
        }

輸出結果：

yield延遲加載按需獲取數據

yield關鍵字可以通過延遲執行的方式，僅在實際需要時生成數據，從而提高了性能和效率。

/// <summary>
        /// yield關鍵字延遲加載按需獲取數據
        /// </summary>
        public static void LazyLoadingRun()
        {
            Console.WriteLine("yield延遲加載按需獲取數據 開始...");

            foreach (var number in GetEvenNumbers(11))
            {
                Console.WriteLine($"返回值 === {number} ===");
                Thread.Sleep(500);
            }

            Console.WriteLine("yield延遲加載按需獲取數據 結束...");
        }

        /// <summary>
        /// 使用yield返回偶數的迭代器方法
        /// </summary>
        /// <returns></returns>
        public static IEnumerable<int> GetEvenNumbers(int number)
        {
            for (int i = 1; i < number; i++)
            {
                Console.WriteLine($"Yielding {i}");
                if (i % 2 == 0)
                {
                    yield return i; //只在需要時生成偶數
                }
            }
        }

輸出結果：

圖片

yield break顯式示迭代結束

yield break：顯式示迭代結束，如以下示例所示：

public static void YieldBreakRun()
        {
            Console.WriteLine(string.Join(" ", TakeWhilePositive(new int[] { 1, 3, 4, 5, -1, 3, 4 })));
            //輸出：1 3 4 5

            Console.WriteLine(string.Join(" ", TakeWhilePositive(new int[] { 9, 8, 7, 6, 5, -5, 88, 100 })));
            //輸出：9 8 7 6 5
        }

        public static IEnumerable<int> TakeWhilePositive(IEnumerable<int> numbers)
        {
            foreach (int n in numbers)
            {
                if (n > 0)
                {
                    yield return n;
                }
                else
                {
                    yield break;
                }
            }
        }

什么情況不能使用yield關鍵字

帶有 in、ref 或 out 參數的方法。
Lambda 表達式和匿名方法。
在 C# 13 之前，yield 在具有 unsafe 塊的任何方法中都無效。從 C# 13 開始，可以在包含 unsafe 塊的方法中使用 yield，但不能在 unsafe 塊中使用。
不能在catch和finally塊中使用yield return和yield break。
不能在具有catch塊的try塊中使用yield return和yield break。
可以在只有finally塊的try塊中使用yield return和yield break。