PHP Generator 怎样读取 return 返回值

我第一次在 PHP Generator 里同时使用 yield 和 return 时，最容易混淆的是：循环拿到的是逐项产出的值，而 return 放在生成器结束位置的最终结果，不能在 foreach 的变量里自动出现。正确做法是保存 Generator 对象，先让它完成迭代，再调用 getReturn()。

官方地址：https://www.php.net/manual/en/generator.getreturn.php

一句话记忆：yield 给循环过程，return 给生成器结束状态；只有生成器执行完后，才用 $generator->getReturn() 读取最终值。

先分清 yield 和 return 各自负责什么

PHP 函数中只要出现 yield，调用它就会得到一个 Generator 对象。每次恢复执行时，yield 把一个值交给调用方并暂停；执行走到末尾或遇到 return 后，生成器才算结束。PHP 手册把这两类值分开：foreach 读取 yielded value，getReturn() 读取生成器返回值。

因此不要把最后一次 yield 当成最终汇总，也不要期待 foreach ($generator as $value) 能拿到 return。它们属于两个不同的输出通道。

保存 Generator，让它真正迭代到结束

读取最终返回值的关键不是把函数改成普通函数，而是保留同一个 Generator 实例。下面这个例子逐个产出文件名，同时在循环结束时返回处理统计。

 $processed];
}

$generator = scanNames(['alice', 'bob']);

foreach ($generator as $name) {
    // 当前循环只处理 yield 出来的字符串。
    echo $name, PHP_EOL;
}

// foreach 结束后，生成器已经返回，才能读取最终统计。
$summary = $generator->getReturn();
print_r($summary);
?>

这个例子的思路是“过程值先消费，汇总值后读取”。如果只写成 foreach (scanNames($names) as $name)，循环结束后没有变量指向那个 Generator，也就没有方便的对象可以调用 getReturn()。

用 getReturn() 读取最后的 return 值

Generator::getReturn() 没有参数，返回生成器结束时的最终值，类型是 mixed。它既可以读取标量，也可以读取数组或对象，取决于生成器里的 return 表达式。

 2, 'last' => 20];
}

$generator = collectIds();
$yielded = [];

foreach ($generator as $id) {
    // 先保存过程中的 yielded value。
    $yielded[] = $id;
}

$returned = $generator->getReturn();

var_dump($yielded);  // [10, 20]
var_dump($returned); // ['count' => 2, 'last' => 20]
?>

对我来说，这个分离很适合“边处理边输出、结束后给摘要”的场景：调用方不必等待全部数据才能消费单项结果，但仍能在最后拿到总数、校验摘要或处理状态。

为什么不能在遍历前调用 getReturn()

Generator 是惰性的。调用 collectIds() 只创建对象，不代表函数体已经运行完。此时生成器可能尚未开始，也可能停在某个 yield 上，最终 return 还没有发生。

getReturn(), PHP_EOL;
?>

如果在 foreach 之前直接调用，PHP 会抛出“尚未返回，无法获取返回值”的异常。工程上不需要手动猜测是否结束：最简单、最不容易出错的边界就是把 getReturn() 放在完整遍历之后。

没有显式 return 时，最终值怎么处理

生成器可以只包含 yield 而没有带值的 return。当它自然执行完后，getReturn() 仍然应当放在遍历之后；没有显式返回内容时，最终结果可按 null 处理。

getReturn();
var_dump($result); // NULL
?>

这里要区分两件事：null 是生成器已结束但没有最终数据的结果；“无法获取返回值”则表示调用时机太早。前者是业务语义，后者是生命周期错误。

yield from 怎样把子生成器的 return 传上来

当一个生成器委托给另一个生成器时，yield from 表达式本身可以得到子生成器的返回值。外层生成器再用 return yield from ...，就能把这个最终值继续交给外层调用方。

 2];
}

function parentGenerator(): Generator
{
    // 外层继续产出子生成器的值，并接住它的最终 return。
    return yield from child();
}

$generator = parentGenerator();
foreach ($generator as $row) {
    echo $row, PHP_EOL;
}

print_r($generator->getReturn()); // ['rows' => 2]
?>

这个用法适合把读取、解析、聚合拆成多个生成器。子生成器只负责自己的数据和汇总，外层保持同一条迭代通道；但仍要等外层遍历结束后调用 getReturn()。

我会怎样选择这种写法

如果调用方只关心逐条数据，单纯 yield 就够了；如果还需要总条数、统计摘要或最后状态，才值得设计一个明确的 return。我通常会把返回值做成有名字的数组或小型值对象，避免让读者猜一个裸整数代表什么。

常见问题

getReturn() 能不能替代 foreach 读取 yield？

不能。它只负责最终 return 值，不会返回中途所有 yield 的集合。需要收集过程值时，仍应在遍历中保存，或使用适合的迭代器工具。

只调用 valid() 能不能拿到 return？

valid() 用于判断当前是否还有可迭代值，但工程上仍应让迭代器正常推进到结束，再调用 getReturn()。不要在第一次暂停时把它当作完成信号。

Generator 抛出异常后还能读取 return 吗？

不能把异常路径当作正常完成路径。若生成器因异常终止，调用方应先按异常流程处理；只有正常结束后，getReturn() 才有明确的最终返回语义。

总结

PHP Generator 的关键是把“过程输出”和“结束结果”分开：yield 供循环逐项消费，return 留下最终值。保存 Generator，先完整遍历，再调用 getReturn()，就能稳定取得最终统计；嵌套场景使用 yield from 继续传递子生成器的返回值。