yield 是 C# 中一个非常巧妙的语法糖,它的核心作用是实现“延迟执行(Lazy Evaluation)”。
简单来说,它允许你在一个方法中逐个返回数据,而不需要一次性把所有数据都计算好并塞进一个 List 里返回。
???? 核心概念:从“批发”到“零售”
为了理解 yield,我们先看一个不使用 yield 的传统写法:
|
1
2
3
4
5
6
7
8
9
10
|
// 传统写法:一次性生成所有数据(批发)
public List<int> GetNumbers(int count)
{
var list = new List<int>();
for (int i = 0; i < count; i++)
{
list.Add(i); // 把所有数字都塞进内存里的集合
}
return list; // 最后一次性返回整个集合
}
|
缺点:如果 count 是 100 万,这个方法会瞬间在内存中分配一个包含 100 万个元素的数组,造成极大的内存浪费。
现在看看使用 yield 的写法:
|
1
2
3
4
5
6
7
8
|
// yield 写法:按需生成数据(零售)
public IEnumerable<int> GetNumbersYield(int count)
{
for (int i = 0; i < count; i++)
{
yield return i; // 每次吐出一个数字,然后“暂停”在这里
}
}
|
优点:调用这个方法时,它根本不会立刻执行循环。只有当外部真正去读取下一个数据时,它才会执行一次循环,吐出一个值,然后暂停。内存中永远只存在当前这一个数字。
????? 两个核心关键字
- yield return:返回当前值,并记住当前的执行状态(包括局部变量、循环索引等)。下次调用时,直接从这行代码的下一行继续执行。
- yield break:提前结束迭代,相当于普通方法里的 return。
???? 典型应用场景
1. 读取超大文件或数据流
假设你要读取一个 10GB 的日志文件,如果用 File.ReadAllLines(),内存直接撑爆。用 yield 可以逐行处理:
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
|
public IEnumerable<string> ReadLargeFile(string filePath)
{
using (var reader = new StreamReader(filePath))
{
string line;
while ((line = reader.ReadLine()) != null)
{
yield return line; // 读一行,吐出一行,内存占用极小
}
}
}
// 使用时:
foreach (var line in ReadLargeFile("huge_log.txt"))
{
if (line.Contains("ERROR")) Console.WriteLine(line);
}
|
2. 实现自定义迭代器
如果你想让你自己写的类支持 foreach 循环,就可以用 yield:
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
|
public class Countdown
{
private int _start;
public Countdown(int start) { _start = start; }
public IEnumerator<int> GetEnumerator()
{
for (int i = _start; i >= 0; i--)
{
yield return i;
}
}
}
// 使用时:
var countdown = new Countdown(5);
foreach (var num in countdown)
{
Console.WriteLine(num); // 输出 5, 4, 3, 2, 1, 0
}
|
3. 提前终止(yield break)
|
1
2
3
4
5
6
7
8
9
|
public IEnumerable<int> GetEvenNumbers(int max)
{
for (int i = 0; i <= max; i++)
{
if (i > 10) yield break; // 如果超过10,直接结束整个迭代
if (i % 2 == 0) yield return i;
}
}
|
?? 必须注意的“坑”
- 只能返回特定类型:包含 yield 的方法,返回类型只能是 IEnumerable、IEnumerable<T>、IEnumerator 或 IEnumerator<T>。不能直接返回 List<T> 或数组。
- 延迟执行的副作用:
|
1
2
3
4
|
var query = GetNumbersYield(100); // 此时循环一次都没执行!
// 只有走到这里,循环才开始
foreach(var item in query) { ... }
|
如果你在 GetNumbersYield 里面有参数校验(比如 if(count < 0) throw...),在调用方法时不会报错,只有在 foreach 第一次迭代时才会报错。
- 不要在 yield 方法里使用 try-catch-finally 包裹 yield return:C# 编译器不允许在包含 yield return 的 try 块中使用 catch(但可以使用 finally)。
???? 总结
yield 的本质是状态机。C# 编译器在底层帮你把 yield 方法编译成了一个复杂的类,自动帮你保存了局部变量和执行位置。
一句话口诀:当数据量很大,或者数据是按需生成的,且你只需要用 foreach 去遍历它时,果断使用 yield return。
|