PHP下的生成器嘗試一：初識PHP下的生成器

生成器類

# http://php.net/manual/zh/class.generator.php
Generator implements Iterator {
    /* Methods */
    //獲取迭代器當前值
    public mixed current ( void )
    //獲取迭代器當前值
    public mixed getReturn ( void )
    //返回當前產生的鍵
    public mixed key ( void )
    //生成器從上一次yield處繼續執行
    public void next ( void )
    //重置迭代器
    public void rewind ( void )
    //向生成器中傳入一個值
    public mixed send ( mixed $value )
    //向生成器中拋入一個異常
    public mixed throw ( Throwable $exception )
    //檢查迭代器是否被關閉
    public bool valid ( void )
    //迭代器序列化時執行的方法
    public void __wakeup ( void )
}

生成生成器

嘗試實例化類

$gen = new Generator();

# 我們發現不能直接手動實例化
# output
PHP Fatal error:  Uncaught Error: The "Generator" class is reserved for internal use and cannot be manually instantiated in /web/www/sxx_admin3/src/cache/test/amphp/gen3.php:8

嘗試function方式

function gen($max)
{
    for ($i=0; $i<$max; $i++) {
        yield $i;
    }
}

$gen = gen(5);

# success
# 成功，我們只需要在普通函數方法裏yield即可成了生成器

理解php的生成器

其實各語言都有生成器，比如python，go等

生成器迭代foreach

被代碼將演示valid, getReturn

function gen($max)
{
    for ($i=0; $i<$max; $i++) {
        yield $i;
    }
    
    return $max;
}

$gen = gen(5);

foreach ($gen as $val) {
     var_dump($val);
}

//如果已經迭代完成，獲取返回值
// php7 支持
// valid 判斷當前迭代器是否迭代完成
// getReturn 返回迭代器的返回值
if (version_compare(PHP_VERSION, '7.0.0') >= 0 && !$gen->valid()) {
    var_dump($gen->getReturn());
}

帶key值的生成器迭代foreach

迭代器返回值可以帶key和value，類似

function gen($max)
{
    for ($i=0; $i<$max; $i++) {
        yield $i => $i+1;
    }
    
    return $max;
}

$gen = gen(5);

//var_dump($gen->key());
//var_dump($gen->current());

foreach ($gen as $key=>$val) {
     var_dump($key . "=>" . $val);
}

# output
string(4) "0=>1"
string(4) "1=>2"
string(4) "2=>3"
string(4) "3=>4"
string(4) "4=>5"

生成器迭代手動迭代

本代碼將演示rewind, next, send方法

function gen($max)
{
    for ($i=0; $i<$max; $i++) {
        // 此處的(yield $i)在php7以後版本可省略
        $res = (yield $i);
        var_dump($res);
    }

    return $max;
}

$gen = gen(10);

// 可不調用，隱式調用
// 如果迭代開始後不能再rewind（即使用了next或send後）
$gen->rewind();

// 打印獲取到當前生成器的值
var_dump("1::" . $gen->current()); //output: string(4) "1::0"

// 下面2句代碼執行，將返回錯誤
// $gen->next();
// $gen->rewind();

//繼續執行，知道遇到下一個yield
$gen->next();
var_dump("2::" . $gen->current()); //output: string(4) "2::1"
$gen->next();
var_dump("3::" . $gen->current()); //output: string(4) "3::2"

// send傳null值等同於調用next（本方法嘗試來自python的迭代器，成功）
$gen->send(null);
var_dump("4::" . $gen->current()); //output: string(4) "4::3"

// send傳值會也會繼續執行
$gen->send(100);
var_dump("5::" . $gen->current()); //output: string(4) "5::4"


//如果已經迭代完成，獲取返回值
// php7 支持
if (version_compare(PHP_VERSION, '7.0.0') >= 0 && !$gen->valid()) {
    var_dump($gen->getReturn());
}

# output:
string(4) "1::0"
NULL
string(4) "2::1"
NULL
string(4) "3::2"
NULL
string(4) "4::3"
int(100)
string(4) "5::4"

# 我們先不去理會gen裏var_dump輸出的NULL或int(100)
# 我們先去理解每次next後current可以獲取到當前yield的值即可

嘗試理解send輸出

function gen($max)
{
    for ($i=0; $i<$max; $i++) {
        $res = (yield $i);
        var_dump($res);
    }

    return $max;
}

$gen = gen(10);

var_dump("1::" . $gen->current());

$gen->send(222);
var_dump("2::" . $gen->current());

$gen->send(333);
var_dump("3::" . $gen->current());

$gen->send(null);
var_dump("4::" . $gen->current());


# output：
string(4) "1::0"
int(222)
string(4) "2::1"
int(333)
string(4) "3::2"
int(444)
string(4) "4::3"

# send和next
# next() => current = yield值
# send(val) $rs = yield 表達式執行 = val; //send這樣理解即可
# 在當前某個yield處時send，當前yield表達式處返回，如果沒有變量接收，那麼繼續下一個yield處返回
$rs = (yield  somethind_to_do(...) );
 ^           |-------------------|
 |                  yield值
 |    |----------------------------|
 |               yield 表達式
yield表達式結果


# 執行順序流程類似
$res = (yield 1);   // <- var_dump("1::" . $gen->current()); 第一步到yield返回

var_dump($res);     // <- $gen->send(222); 第二步send：222後，繼續往下走$res=222 然後var_dump($res), 然後到了yield 2
$res = (yield 2);   // <- var_dump("2::" . $gen->current());  打印當前的值2

var_dump($res);     // <- $gen->send(333); 第三步send：333後，繼續往下走$res=333 然後var_dump($res), 然後到了yield 3
$res = (yield 3);   // <- var_dump("3::" . $gen->current());

var_dump($res);     // <- $gen->send(null); 第二步send：null後，繼續往下走$res=null 然後var_dump($res), 然後到了yield 4
$res = (yield 4);   // <- var_dump("4::" . $gen->current());

總結

初識我們只需要先理解next和send即可
next->讓我們可以主動自動執行迭代器
send->可以讓我們的迭代器實現雙向通信，改變執行體流程順序
後續我們會介紹使用場景和Co自動執行體等