PHP 里的 `yield` 主要用来**创建生成器 Generator**：它让函数可以“一边产生值，一边暂停执行”，而不是一次性把所有结果都放进数组返回。它特别适合处理**大数据遍历、文件逐行读取、分页数据流、惰性计算**等场景。

---

## 1. `yield` 是什么

简单说，普通函数用 `return` 是**一次性返回结果并结束函数**：

```php
function getNumbers() {
    return [1, 2, 3];
}

foreach (getNumbers() as $n) {
    echo $n . PHP_EOL;
}
```

而使用 `yield` 的函数不会立刻执行完整函数，也不会直接返回数组，而是返回一个 **Generator 对象**：

```php
function getNumbers() {
    yield 1;
    yield 2;
    yield 3;
}

foreach (getNumbers() as $n) {
    echo $n . PHP_EOL;
}
```

输出：

```text
1
2
3
```

看起来和数组类似，但底层完全不同。

---

## 2. `yield` 的核心作用：节省内存

如果你要生成一百万个数字，普通数组写法会一次性占用大量内存：

```php
function makeArray() {
    $data = [];

for ($i = 1; $i <= 1000000; $i++) {
        $data[] = $i;
    }

return $data;
}

foreach (makeArray() as $n) {
    // 处理 $n
}
```

这里 `$data` 会把一百万个数字全部装进内存。

使用 `yield`：

```php
function makeGenerator() {
    for ($i = 1; $i <= 1000000; $i++) {
        yield $i;
    }
}

foreach (makeGenerator() as $n) {
    // 处理 $n
}
```

这时 PHP 不会一次性生成一百万个数字，而是：

1. `foreach` 要一个值；
2. 函数执行到 `yield $i`；
3. 返回当前 `$i`；
4. 函数暂停；
5. 下一次循环时，从暂停位置继续执行。

所以它是**按需生成**，也叫**惰性迭代**。

---

## 3. `yield` 和 `return` 的区别

| 对比项 | `return` | `yield` |
|---|---|---|
| 返回内容 | 普通值、数组、对象等 | Generator 生成器 |
| 执行方式 | 一次性执行完 | 执行到 `yield` 暂停 |
| 内存占用 | 可能较高 | 通常很低 |
| 使用场景 | 返回一个完整结果 | 逐个产生结果 |
| 是否可遍历 | 数组可遍历 | Generator 可直接 `foreach` |

一句话理解：

> `return` 是“把饭一次性端上桌”，`yield` 是“边做边上菜”。  
> 厨房压力小很多，虽然服务员可能会多跑几趟。

---

## 4. 常见用法

### 4.1 逐行读取大文件

这是 `yield` 非常经典的用途。

```php
function readLines($file) {
    $handle = fopen($file, 'r');

if (!$handle) {
        return;
    }

while (($line = fgets($handle)) !== false) {
        yield trim($line);
    }

fclose($handle);
}

foreach (readLines('large.log') as $line) {
    echo $line . PHP_EOL;
}
```

优点是：即使文件有几个 GB，也不会一次性读入内存。

---

### 4.2 生成键值对

`yield` 可以像数组一样返回 key/value：

```php
function users() {
    yield 1 => 'Alice';
    yield 2 => 'Bob';
    yield 3 => 'Charlie';
}

foreach (users() as $id => $name) {
    echo $id . ': ' . $name . PHP_EOL;
}
```

输出：

```text
1: Alice
2: Bob
3: Charlie
```

---

### 4.3 包装数据库分页结果

假设数据库数据很多，你不想一次性查出来：

```php
function fetchUsers($pdo) {
    $page = 1;
    $pageSize = 100;

while (true) {
        $offset = ($page - 1) * $pageSize;

$stmt = $pdo->prepare(
            'SELECT id, name FROM users LIMIT :limit OFFSET :offset'
        );

$stmt->bindValue(':limit', $pageSize, PDO::PARAM_INT);
        $stmt->bindValue(':offset', $offset, PDO::PARAM_INT);
        $stmt->execute();

$rows = $stmt->fetchAll(PDO::FETCH_ASSOC);

if (!$rows) {
            break;
        }

foreach ($rows as $row) {
            yield $row;
        }

$page++;
    }
}

foreach (fetchUsers($pdo) as $user) {
    // 一个一个处理用户
}
```

这样调用方只需要 `foreach`，不用关心分页逻辑。

---

## 5. `yield` 的执行过程

看这个例子：

```php
function demo() {
    echo "A\n";
    yield 1;

echo "B\n";
    yield 2;

echo "C\n";
}

$gen = demo();

foreach ($gen as $value) {
    echo "Value: {$value}\n";
}
```

输出是：

```text
A
Value: 1
B
Value: 2
C
```

注意：调用 `demo()` 时，函数体并不会马上执行。

```php
$gen = demo();
```

这一步只是得到一个 Generator 对象。真正执行是在 `foreach` 开始迭代时。

---

## 6. `yield from`

PHP 7 开始支持 `yield from`，用于把另一个可迭代对象“展开”出来。

```php
function numbers() {
    yield 1;
    yield 2;
}

function moreNumbers() {
    yield 0;
    yield from numbers();
    yield 3;
}

foreach (moreNumbers() as $n) {
    echo $n . PHP_EOL;
}
```

输出：

```text
0
1
2
3
```

它类似于：

```php
foreach (numbers() as $n) {
    yield $n;
}
```

`yield from` 适合组合多个生成器，让代码更简洁。

---

## 7. 需要注意的地方

### 7.1 Generator 不是数组

下面这样不行：

```php
$gen = makeGenerator();

echo count($gen); // 不适合
```

如果你确实要数组，可以转换：

```php
$arr = iterator_to_array(makeGenerator());
```

但这样会重新把所有数据放进内存，就失去了节省内存的意义。

---

### 7.2 Generator 通常只能遍历一次

```php
$gen = makeGenerator();

foreach ($gen as $n) {
    echo $n;
}

foreach ($gen as $n) {
    echo $n;
}
```

第二次遍历可能会出问题，因为生成器已经执行完了。

更推荐这样：

```php
foreach (makeGenerator() as $n) {
    echo $n;
}

foreach (makeGenerator() as $n) {
    echo $n;
}
```

每次重新调用函数，得到新的 Generator。

---

### 7.3 函数里只要出现 `yield`，返回值就是 Generator

```php
function test($flag) {
    if ($flag) {
        yield 1;
    }

return 2;
}

$result = test(false);

var_dump($result);
```

即使 `$flag` 是 `false`，这个函数依然返回 Generator，因为函数定义里出现了 `yield`。

---

## 8. 什么时候适合用 `yield`

适合：

- 处理大文件；
- 处理大量数据库记录；
- 生成无限序列；
- 分页接口数据流式处理；
- 管道式数据处理；
- 不希望一次性占用大量内存的场景。

不太适合：

- 数据量很小；
- 你需要频繁随机访问元素；
- 你必须多次遍历同一批结果；
- 你需要立即知道总数量；
- 业务逻辑简单，用数组更直观。

---

## 9. 一个实用对比

普通数组方式：

```php
function getEvenNumbers($max) {
    $result = [];

for ($i = 1; $i <= $max; $i++) {
        if ($i % 2 === 0) {
            $result[] = $i;
        }
    }

return $result;
}

foreach (getEvenNumbers(10) as $n) {
    echo $n . PHP_EOL;
}
```

生成器方式：

```php
function getEvenNumbers($max) {
    for ($i = 1; $i <= $max; $i++) {
        if ($i % 2 === 0) {
            yield $i;
        }
    }
}

foreach (getEvenNumbers(10) as $n) {
    echo $n . PHP_EOL;
}
```

输出一样：

```text
2
4
6
8
10
```

但当 `$max` 非常大时，`yield` 版本更省内存。

---

## 总结

`yield` 的本质是：**让函数变成一个可迭代的生成器**。

它的价值在于：

- 不用一次性返回完整数组；
- 可以按需一个个产生数据；
- 非常节省内存；
- 能把复杂的数据读取逻辑封装成简单的 `foreach`；
- 特别适合大文件、大数据量、流式处理场景。

最简单的记法：

```php
function data() {
    yield '一个';
    yield '一个';
    yield '慢慢来';
}
```

`yield` 就是 PHP 里的“慢慢吐数据”机制。

已有0条评论

添加新评论☺

如果认为本文对您有所帮助请赞助本站

支付宝扫一扫赞助

已有0条评论

添加新评论☺