《Hack与HHVM权威指南》——1.5.5 迭代生成器类型

本节书摘来自华章出版社《Hack与HHVM权威指南》一书中的第1章，第1.5.5节，作者 Owen Yamauchi，更多章节内容可以访问“华章计算机”公众号查看。

1.5.5 迭代生成器类型

对迭代生成器添加一个返回类型标注，这里有三种接口类型可以使用，它们分别是： Iterator、KeyedIterator和Generator。这三种类型都是通用的。在开始介绍第2章的内容之前，我们不会一一赘述，这里仅仅做一些简单的介绍。
当你不期待迭代在生成器上调用send()方法时，你可以使用前两种写法。当你只想yield一个值的时候，那么请使用Iterator作为返回类型，当你还同时想yield到一个键的时候，你可以使用KeyedIterator作为返回类型。

  yield 1;
  yield 2;
}
function yields_key_and_value(): KeyedIterator<int, string> {
  yield 1 => 'one';
  yield 2 => 'two';
}

返回类型标注Iterator意味着迭代生成器正在yield的值是int类型，并且没有键。类型标注KeyedIterator意味着迭代生成器yield的键是int类型，而值是string类型的。这些定义和我们已知的数组类型非常接近。例如：array意味着一个数组它的key是个整型，而它的value是个字符串类型。
如果你将在这个迭代生成器上面调用send()方法，请使用Generator标注：

function has_send_called(): Generator<int, string, User> {
  // 空的yield操作，用于得到第一个用户
  $user = yield 0 => '';
  // $user的类型是?User
  while ($user !== null) {
    $id = $user->getID();
    $name = $user->getName();
    $user = yield $id => $name;
  }
}
function main(array<User> $users): void {
  $generator = has_send_called();
  $generator->next();
  foreach ($users as $user) {
    $generator->send($user);
    var_dump($generator->key());
    var_dump($generator->current());
  }
}

返回的类型标注Generator意味着迭代生成器生成操作得到的值是整型的，而值是字符串类型，它期待类型是User的值传递给它的send()方法。
值得注意的是：从yield得到的结果值并不是User类型，而是?User类型。这是因为对于迭代生成器的调用者来说，它可能只是调用next()方法而不调用send()方法。这就可能使从yield得到的响应值是null。所以在调用它上面的方法前，必须检查对应的值是否为null。详情请见1.7.1节的内容。