PHP中的性能优化利器:生成器 yield 理解

如果是做Python或者其他语言的小伙伴,对于生成器应该不陌生。但很多PHP开发者都不知道有生成器这个功能,但是,生成器功能的确非常有用。人家 yield 这个东西是从PHP 5.5就开始引入了,官方名称叫做生成器。你要说为什么5.5年代的东西,现在才拿出来。我还想问你哟,PHP 5.3就有了的 namespace 为毛到最近这几年才开始正式投产。

优点

如果直接讲概念的话,估计你听完还是一头雾水,所以我们先来说说优点,也许能勾起你的兴趣。那么生成器有哪些优点呢?如下:

  • 生成器会对PHP应用的性能有非常大的影响

  • PHP代码运行时节省大量的内存

  • 比较适合计算大量的数据

那么,这些神奇的功能究竟是如何做到的?我们先来举个例子。

概念引入

首先,放下生成器概念的包袱,来看一个简单的PHP函数:

function createRange($number)
{
    $data = [];
    
    for($i = 0; $i < $number; $i++)
    {
        $data[] = time();
    }
    
    return $data;
}

这是一个非常 常见的PHP函数,我们在处理一些数组的时候经常会使用。这里的代码也非常简单:

①、我们创建一个函数。

②、函数内包含一个 for 循环,我们循环的把当前时间放到$data数组里面。

③、for循环执行完毕,把 $data 返回出去。


你以为这就完了?醒醒吧!我们继续。我们再写一个函数,把这个函数的返回值循环打印出来:

$result = createRange(10); // 这里调用上面我们创建的函数

foreach($result as $value)
{
    sleep(1);//这里停顿1秒,我们后续有用
	
    echo $value.'<br />';
}

我们在浏览器里面看一下运行结果:

s1.png

这里非常完美,没有任何问题。(当然 sleep(1) 效果你们看不出来)

思考一个问题

我们注意到,在调用函数 createRange 的时候给 $number 的传值是10,一个很小的数字。假设,现在传递一个值10000000(1000万)。

那么,在函数 createRange 里面,for循环就需要执行1000万次。且有1000万个值被放到 $data 里面,而$data数组在是被放在内存内。所以,在调用函数时候会占用大量内存。

这里,生成器就可以大显身手了。

创建生成器

我们直接修改代码,你们注意观察:

function createRange($number)
{
    for( $i = 0; $i < $number; $i++)
    {
        yield time();
    }
}

看下这段和刚刚很像的代码,我们删除了数组 $data ,而且也没有返回任何内容,而是在 time() 之前使用了一个关键字 yield

使用生成器

我们再运行一下第二段代码:

$result = createRange(10); // 这里调用上面我们创建的函数

foreach($result as $value)
{
    sleep(1);
	
    echo $value.'<br />';
}

s2.png

我们奇迹般的发现了,输出的值和第一次没有使用生成器的不一样。这里的值(时间戳)中间间隔了1秒。

这里的间隔一秒其实就是 sleep(1) 造成的后果。但是为什么第一次没有间隔?那是因为:

  • 未使用生成器时: createRange 函数内的 for 循环结果被很快放到 $data 中,并且立即返回。所以, foreach 循环的是一个固定的数组。

  • 使用生成器时: createRange 的值不是一次性快速生成,而是依赖于 foreach 循环。 foreach 循环一次, for 执行一次。

到这里,你应该对生成器有点儿头绪。

深入理解生成器

代码剖析

下面我们来对于刚刚的代码进行剖析。

function createRange($number)
{
    for( $i = 0; $i < $number; $i++)
    {
        yield time();
    }
}

$result = createRange(10); // 这里调用上面我们创建的函数

foreach($result as $value)
{
    sleep(1);
    
    echo $value.'<br />';
}

我们来还原一下代码执行过程:

①、首先调用 createRange 函数,传入参数10,但是 for 值执行了一次然后停止了,并且告诉 foreach 第一次循环可以用的值。

②、foreach 开始对 $result 循环,进来首先 sleep(1) ,然后开始使用 for 给的一个值执行输出。

③、foreach 准备第二次循环,开始第二次循环之前,它向 for 循环又请求了一次。

④、for 循环于是又执行了一次,将生成的时间戳告诉 foreach。

⑤、foreach 拿到第二个值,并且输出。由于 foreach 中 sleep(1) ,所以, for 循环延迟了1秒生成当前时间。


所以,整个代码执行中,始终只有一个记录值参与循环,内存中也只有一条信息。

无论开始传入的 $number 有多大,由于并不会立即生成所有结果集,所以内存始终是一条循环的值。

概念理解

到这里,你应该已经大概理解什么是生成器了。下面我们来说下生成器原理。

首先明确一个概念:生成器 yield 关键字不是返回值,他的专业术语叫产出值,只是生成一个值。


解释1:

那么代码中 foreach 循环的是什么?其实是PHP在使用生成器的时候,会返回一个 Generator 类的对象。 foreach 可以对该对象进行迭代,每一次迭代,PHP会通过 Generator 实例计算出下一次需要迭代的值。这样 foreach 就知道下一次需要迭代的值了。

而且,在运行中 for 循环执行后,会立即停止。等待 foreach 下次循环时候再次和  for  索要下次的值的时候,循环才会再执行一次,然后立即再次停止。直到不满足条件不执行结束。


解释2:

其实我们可以看到createRange这个函数跟普通函数不一样的地方,就是普通函数往往都是使用return来返回结果,而这个中则是 yield。其次是普通函数中return只能返回一次,这个yield能返回好多次。


yield 返回的是一个叫做Generator(中文名就是生成器)的类的对象,而这个生成器是实现了Iterator接口(至于Iterator接口,你们去PHP手册上搜索吧)。所以,既然实现了Iterator接口(也正是因为如此,这个东西可以使用foreach进行迭代,明白了吧?)


上面2种解释 说的其实是一个意思。。两个解释你总能看懂其中一个意思吧?

实际开发应用

很多PHP开发者不了解生成器,其实主要是不了解应用领域。那么,生成器在实际开发中有哪些应用?

读取超大文件

PHP开发很多时候都要读取大文件,比如csv文件、text文件,或者一些日志文件。这些文件如果很大,比如5个G。这时,直接一次性把所有的内容读取到内存中计算并不现实!


这里生成器就可以派上用场啦。简单看个例子:读取text文件

s3.png

创建一个text文本文档,并在其中输入几行文字,进行示范读取。

function readTxt()
{
    $handle = fopen("./test.txt", 'rb');
    
    while(feof($handle)===false) 
    {
        yield fgets($handle);
    }
    
    fclose($handle);
}

foreach(readTxt() as $key => $value) 
{
    echo $value.'<br />';
}

s4.png

通过上图的输出结果我们可以看出代码完全正常。

但是,背后的代码执行规则却一点儿也不一样。使用生成器读取文件,第一次读取了第1行,第二次读取了第2行,以此类推,每次被加载到内存中的文字只有一行,大大的减小了内存的使用。

这样,即使读取上G的文本也不用担心,完全可以像读取很小文件一样编写代码。


总结:

yield 的特性,包含以下几点:

1、yield只能用于函数(方法)内部,在非函数(方法)内部运用会抛出错误。

2、如果函数(方法)包含了yield关键字的,那么函数(方法)执行后的返回值永远都是一个Generator对象。

3、如果函数(方法)内部同时包含yield和return 该函数(方法)的返回值依然是Generator对象,但是在生成Generator对象时,return语句后的代码被忽略。

4、Generator类实现了Iterator接口。

5、可以通过返回的Generator对象内部的方法,获取到函数(方法)内部yield后面表达式的值。

6、可以通过Generator的send方法给yield 关键字赋一个值。

7、一旦返回的Generator对象被遍历完成,便不能调用它的rewind方法来重置。

8、Generator对象不能被clone关键字克隆。


yield生成器和普通函数有哪些异同:

1、生成器中必须包含 yield 关键字(用来生成结果),而且可以是多次出现,普通函数(方法)中向外部返回结果只能使用 return,且函数(方法)执行完毕。

2、一个生成器不可以通过 return 返回值,这样做会产生一个编译错误 PHP Fatal error: Generators cannot return values using "return"(注意:这个在 PHP7 下面不会出错,但是会终止生成器继续执行,即调 valid () 方法会返回 false。)


yield 关键字:

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


这是一个典型的 yield 表达式:$data = yield $key => $value;,该表达式包括两部分:

注意:PHP5 需要加上括号 $data = (yield $key => $value);,否则会产生一个编译错误,PHP7 就不用关心这个了

其一,是 yield 后面的表达式,这个可以是单个值也可以是键值对,与 array 中的一个元素对应,这部分表达式是返回给上层调用的,也就是上层可以通过 current 方法接收到值或者在执行 send 方法的返回值。


另外一块就是 yield 关键字本身,个人把他理解成一个接收器,会收到 send 方法传入的值,这个值就是整个 yield 表达式当前的值,可以被左边的变量接收。


这么说可能有一些抽象,还是上图吧:

233.png




PS:一些大公司经常有这种类似的面试题,问你php如何实现读取大文件中的内容,并且节省内存,性能也不低呢??嗯,这时候你拿出yield 对着面试官就是一顿怼!同理,php如何处理大数据量,同样可以用yield!




可参考以下链接:

https://www.cnblogs.com/zuochuang/p/8176868.html

https://segmentfault.com/a/1190000018457194

https://www.cnblogs.com/lynxcat/p/7954456.html

https://learnku.com/articles/7622/a-brief-discussion-on-php-generator



人生中只有没做过的事 会让我们遗憾    --->克莉丝汀·汉娜【萤火虫小巷】


声明:禁止任何非法用途使用,凡因违规使用而引起的任何法律纠纷,本站概不负责。

扫码支持
扫码打赏,你说多少就多少

打开支付宝扫一扫,即可进行扫码打赏哦

精彩评论

全部回复12人评论7,777人参与