首頁 > 文章 > 後端開發 > PHP中生成器和協程是如何實現的

PHP中生成器和協程是如何實現的

不言原創: 2018-07-21 13:11:001305瀏覽

這篇文章跟大家分享的是關於PHP中生成器和協程是如何實現的，內容很不錯，有需要的朋友可以參考一下，希望可以幫助到大家。

先說一些廢話

PHP 5.5 以來，新的諸多特性又一次令PHP 煥發新的光彩，雖然在本文寫的時候已是PHP 7 alpha 2 發布後的一段時間，但此時國內依舊是php 5.3 的天下。不過我認為新的特性遲早會因為舊的版本的逐漸消失而變得越發重要，尤其是PHP 7 的正式版出來後，因此本文的目的就是為了在這之前，幫助一些PHPer 了解一些他們從沒有了解的東西。所以打算將以本篇作為部落格 PHP 知識補全系列文章的開頭。

其實在寫本文之前，我對生成器以及基於此特性延伸出來的php 的協程實現並沒有比較直觀的了解，主要是我個人水平並不是很高，屬於典型的剛入了門的PHPer。所以在看了前段時間鳥哥（laruence）部落格中對協程的講解（參考連結：《PHP中使用協同程序實現合作多任務》）後，在我個人對本篇的理解上，針對那些比較難以理解的概念（包括我個人在理解這個概念的時候的難點），以一個更為通俗的方式去講明白。當然由於本人也是剛去學習這個概念，所以有些不得當的地方在所難免，希望大神看見了請不吝賜教。

一切從Iterator 和Generator 開始

#為便於新入門開發者理解，本文一半篇幅是講述迭代器介面（ Iterator）和Generator 類別的，對此已經理解的話，可以直接跳過。

迭代和迭代器

在理解本文大多數概念之前，有必要知道迭代和迭代器。事實上，迭代大家都知道是什麼，可是我不知道（真的，在此之前對這個概念沒有系統了解）。迭代是指反覆執行一個過程，每執行一次叫做一次迭代。實際上我們經常做這種事情，例如：

<?php
$mapping = [
  &#39;red&#39;  => &#39;#FF0000&#39;,
  &#39;green&#39; => &#39;#00FF00&#39;,
  &#39;blue&#39; => &#39;#0000FF&#39;
];
foreach ($mapping as $key => $value) {
  printf("key: %d - value: %s\n", $key, $value);
}

我們可以看到透過 foreach 對數組遍歷並迭代輸出其內容。在這一環節中，我們需要關注的重點是陣列。雖然我們迭代的過程是 foreach 語句中的程式碼區塊，但實際上陣列 $mapping 在每一次迭代中發生了變化，表示陣列內部也存在著一次迭代。如果我們把數組看做一個對象，foreach 實際上在每一次迭代過程都會調用該對象的一個方法，讓數組在自己內部進行一次變動（迭代），隨後通過另一個方法取出當前數組對象的鍵和值。這樣一個可透過外部遍歷其內部資料的對象就是一個迭代器對象，其遵循的統一的存取介面就是迭代器介面（Iterator）。

PHP 提供了一個統一的迭代器介面。關於迭代器 PHP 官方文件有更詳細的描述，建議去了解。

interface Iterator extends Traversable
{
  /**
   * 获取当前内部标量指向的元素的数据
   */
  public mixed current ( void )
  /**
   * 获取当前标量
   */
  public scalar key ( void )
  /**
   * 移动到下一个标量
   */
  public void next ( void )
  /**
   * 重置标量
   */
  public void rewind ( void )
  /**
   * 检查当前标量是否有效
   */
  public boolean valid ( void )
}

我們來給一個實例，去實作一個簡單的迭代器：

class Xrange implements Iterator
{
  protected $start;
  protected $limit;
  protected $step;
  protected $i;
  public function __construct($start, $limit, $step = 0)
  {
    $this->start = $start;
    $this->limit = $limit;
    $this->step = $step;
  }
  public function rewind()
  {
    $this->i = $this->start;
  }
  public function next()
  {
    $this->i += $this->step;
  }
  public function current()
  {
    return $this->i;
  }
  public function key()
  {
    return $this->i + 1;
  }
  public function valid()
  {
    return $this->i <= $this->limit;
  }
}

透過foreach 遍歷來看看這個迭代器的效果：

foreach (new Xrange(0, 10, 2) as $key => $value) {
  printf("%d %d\n", $key, $value);
}

輸出：

1 0
3 2
5 4
7 6
9 8
11 10

至此我們看到了一個迭代器的實作。有些人在了解這項特性會很激動的將其應用在實際專案中，但有些人則疑惑這有什麼卵用呢？迭代器只是將一個普通對象變成了一個可被遍歷的對象，這在有些時候，如一個對象StudentsContact，這個對像是用於處理學生聯繫方式的，通過addStudent 方法註冊學生，通過getAllStudent 獲取全部註冊的學生聯絡方式數組。我們以往遍歷是透過StudentsContact::getAllStudent() 取得一個數組然後遍歷該數組，但是現在有了迭代器，只要這個類繼承這個接口，就可以直接遍歷該對象獲取學生數組，並且可以在獲取之前在類的內部就對輸出的資料做好處理。

當然用處遠不止這麼點，但這裡就不過多糾結。有一個在此基礎上更強大的東西，生成器。

產生器，Generator

雖然迭代器只需繼承介面即可實現，但依舊很麻煩，我們畢竟需要定義一個類別並實作該介面所有方法，這十分繁瑣。在一些情境下我們需要更簡潔的辦法。生成器提供了一種更容易的方法來實現簡單的物件迭代，相比較定義類別實作 Iterator 介面的方式，效能開銷和複雜性大大降低。

PHP 官方文件這樣說的：

生成器允许你在 foreach 代码块中写代码来迭代一组数据而不需要在内存中创建一个数组, 那会使你的内存达到上限，或者会占据可观的处理时间。相反，你可以写一个生成器函数，就像一个普通的自定义函数一样, 和普通函数只返回一次不同的是, 生成器可以根据需要 yield 多次，以便生成需要迭代的值。

一个简单的例子就是使用生成器来重新实现 range() 函数。标准的 range() 函数需要在内存中生成一个数组包含每一个在它范围内的值，然后返回该数组, 结果就是会产生多个很大的数组。比如，调用 range(0, 1000000) 将导致内存占用超过 100 MB。

做为一种替代方法, 我们可以实现一个 xrange() 生成器, 只需要足够的内存来创建 Iterator 对象并在内部跟踪生成器的当前状态，这样只需要不到1K字节的内存。

官方文档给了上文对应的例子，我们在此简化了一下：

function xrange($start, $limit, $step = 1) {
  for ($i = $start; $i <= $limit; $i += $step) {
    yield $i + 1 => $i; // 关键字 yield 表明这是一个 generator
  }
}
// 我们可以这样调用
foreach (xrange(0, 10, 2) as $key => $value) {
  printf("%d %d\n", $key, $value);
}

可能你已经发现了，这个例子的输出和我们前面在说迭代器的时候那个例子结果一样。实际上生成器生成的正是一个迭代器对象实例，该迭代器对象继承了 Iterator 接口，同时也包含了生成器对象自有的接口，具体可以参考 Generator 类的定义。

当一个生成器被调用的时候，它返回一个可以被遍历的对象.当你遍历这个对象的时候(例如通过一个foreach循环)，PHP 将会在每次需要值的时候调用生成器函数，并在产生一个值之后保存生成器的状态，这样它就可以在需要产生下一个值的时候恢复调用状态。

一旦不再需要产生更多的值，生成器函数可以简单退出，而调用生成器的代码还可以继续执行，就像一个数组已经被遍历完了。

我们需要注意的关键是 yield，这是生成器的关键。我们通过上面例子，可以看得出，yield 会将当前一个值传递给 foreach，换句话说，foreach 每一次迭代过程都会从 yield 处取一个值，直到整个遍历过程不再存在 yield 为止的时候，遍历结束。

我们也可以发现，yield 和 return 都会返回值，但区别在于一个 return 是返回既定结果，一次返回完毕就不再返回新的结果，而 yield 是不断产出直到无法产出为止。

实际上存在 yield 的函数返回值返回的是一个 Generator 对象（这个对象不能手动通过 new 实例化），该对象实现了 Iterator 接口。那么 Generator 自身有什么独特之处？继续看：

yield

字面上解释，yield 代表着让位、让行。正是这个让行使得通过 yield 实现协程变得可能。

生成器函数的核心是 yield 关键字。它最简单的调用形式看起来像一个 return 申明，不同之处在于普通 return 会返回值并终止函数的执行，而 yield 会返回一个值给循环调用此生成器的代码并且只是暂停执行生成器函数。

yield 和 return 的区别，前者是暂停当前过程的执行并返回值，而后者是中断当前过程并返回值。暂停当前过程，意味着将处理权转交由上一级继续进行，直至上一级再次调用被暂停的过程，该过程则会从上一次暂停的位置继续执行。这像是什么呢？如果读者在读本篇文章之前已经在鸟哥的文章中粗略看过，应该知道这很像是一个操作系统的进程调度管理，多个进程在一个 CPU 核心上执行，在系统调度下每一个进程执行一段指令就被暂停，切换到下一个进程，这样看起来就像是同时在执行多个任务。

但仅仅是如此还远远不够，yield 更重要的特性是除了可以返回一个值以外，还能够接收一个值！

function printer()
{
  while (true) {
    printf("receive: %s\n", yield);
  }
}
$printer = printer();
$printer->send(&#39;hello&#39;);
$printer->send(&#39;world&#39;);

上述例子输出内容为：

receive: hello
receive: world

参考 PHP 官方中文文档：生成器对象我们可以得知 Generator 对象除了实现 Iterator 接口中的必要方法以外，还有一个 send 方法，这个方法就是向 yield 语句处传递一个值，同时从 yied 语句处继续执行，直至再次遇到 yield 后控制权回到外部。

我们通过之前也了解了一个问题，yield 可以在其位置中断并返回一个值，那么能不能同时进行接收和返回呢？当然，这可是实现协程的根本。我们对上述代码做出修改：

<?php
function printer()
{
  $i = 0;
  while (true) {
    printf("receive: %s\n", (yield ++$i));
  }
}
$printer = printer();
printf("%d\n", $printer->current());
$printer->send(&#39;hello&#39;);
printf("%d\n", $printer->current());
$printer->send(&#39;world&#39;);
printf("%d\n", $printer->current());

输出内容如下：

1
receive: hello
2
receive: world
3

current 方法是迭代器（ Iterator ）接口必要的方法，foreach 语句每一次迭代都会通过其获取当前值，而后调用迭代器的 next 方法。我们为了使程序不会无限执行，手动调用 current 方法获取值。

上述例子已经足以表示 yield 在那一个位置作为双向传输的工具，已具备实现协程的条件。

协程

这一部分我不打算长篇大论，本文开头已经给出了鸟哥博客中更为完善的文章，本文的目的是出于补充对 Generator 的细节。

我们要知道，对于单核处理器，多任务的执行原理是让每一个任务执行一段时间，然后中断、让另一个任务执行然后在中断后执行下一个，如此反复。由于其执行切换速度很快，让外部认为多个任务实际上是 “并行” 的。

鸟哥那篇文章这么说道：

多任务协作这个术语中的 “协作” 很好的说明了如何进行这种切换的：它要求当前正在运行的任务自动把控制传回给调度器，这样就可以运行其他任务了。这与 “抢占” 多任务相反, 抢占多任务是这样的：调度器可以中断运行了一段时间的任务, 不管它喜欢还是不喜欢。协作多任务在 Windows 的早期版本 (windows95) 和 Mac OS 中有使用, 不过它们后来都切换到使用抢先多任务了。理由相当明确：如果你依靠程序自动交出控制的话，那么一些恶意的程序将很容易占用整个CPU，不与其他任务共享。

我们结合之前的例子，可以发现，yield 作为可以让一段任务自身中断，然后回到外部继续执行。利用这个特性可以实现多任务调度的功能，配合 yield 的双向通讯功能，以实现任务和调度器之间进行通信。

这样的功能对于读写和操作 Stream 资源时尤为重要，我们可以极大的提高程序对于并发流资源的处理能力，比如实现 tcp server。

总结

PHP 自 5.4 到如今愈发稳定的 PHP 7，可以看到许多的新特性令这门语言愈发强大和完善，逐渐从纯粹的 Web 语言变得有着更为广泛的适用面，作为一枚 PHPer 的确不应当止步不前，我们依然有很多的东西需要不断学习和加强。

虽然 “PHP 是世界上最好的语言” 这句话只是个调侃，但不可否认 PHP 即使不是最好，但也在努力变好的事实，对吧？

PHP中生成器和協程是如何實現的

相關文章