了解PHP yield的高级用法
开篇
刚开始接触PHP
的 yield
的时候,感觉,yield
是什么黑科技,百度一下:yield
——协程,生成器。很多文章都在讲 Iterator
,Generater
, 蛤~,这东西是 PHP 迭代器的一个补充。再翻几页,就是Go 协程
。我出于好奇点开看了下Go 协程
, 里面都是 并发
,线程
,管道通讯
这类字眼,wc,nb, 这tm才是黑科技啊,再回来看PHP
,分分钟想转 Go
。
相关学习推荐:PHP编程从入门到精通
yield 语法加入 PHP
yield
语法是在版本5.5加入PHP
的,配合迭代器使用,功能上就是 流程控制
代码,和goto
,return
类似。
以下就是官方提供的 yield 小例子,通过执行结果,我们可分析当代码执行到 yield $i
时,他会进行 return $i
, 待 echo "$value\n"
后, goto
for ($i = 1; $i <= 3; $i++) {
, 对!PHP 的 yield 就是一个能出能进的语法。在z代码中七进七出,把 $i
平平安安得送了出来。
<?phpfunction gen_one_to_three() { for ($i = 1; $i <= 7; $i++) { //注意变量$i的值在不同的yield之间是保持传递的。 yield $i; }}$generator = gen_one_to_three();foreach ($generator as $value) { echo "$value\n";}// output12...67
我们遇到了什么问题
写代码就是解决问题。我们来看看他们遇到了什么问题:php官方呢,需要言简意赅地把yield介绍给大家。一部分网友呢,需要在有限的资源内完成大文件操作。而我们的鸟哥。面对的一群对当下yield的教程停留于初级而不满意的phper,就以一个任务调度器作为例子,给大家讲了一种yield
高级用法。
php.net:生成器语法,
PHP如何读取大文件,
风雪之隅:在PHP中使用协程实现多任务调度.
提出问题,再用yield
来解答,看到以上答案,我觉得呢,这PHP协程不过如此(和Go协程
相比 )。
有句话——一个好问题比答案更重要
,目前广大网友还没有给yield提出更好,更困难的问题。
yield
这个进进出出的语法,很多举例都是再让yield做迭代器啊,或者利用低内存读取超大文本的Excel
,csv
什么的,再高级就是用它实现一个简单的任务调度器,并且这个调度器,一看代码都差不多。
我来出道题
正如一个好的问题,比答案更有价值
- 用PHP实现一个 Socket Server,他能接收请求,并返回Server的时间。
好,这是第一个问题,铺垫。 官方答案
- 在原来的代码上,我们加个需求,该Socket Server 处理请求时,依赖其他 Socket Server,还需要有 Client 功能。也就是他能接收请求,向其它Server发起请求。
这是第二个问题,也是铺垫。
- 原来的Socket Server同一时间只能服务一个客户,希望能实现一个
非阻塞I/O
Socket Server, 这个 Server 内有 Socket Client 功能,支持并发处理收到的请求,和主动发起的请求。要求不用多线程,多进程。
这个问题,还是铺垫,这几个问题很干,大家可以想一想,2,3题的答案,都放在一个脚本里了:nio_server.php
以上这段代码,我列举了一个具体的业务,就是用户请求购物车加购动作, 而购物车服务呢,又需要和 产品服务,库存服务,优惠服务 交互,来验证加购动作可行性。有同步,异步方式请求,并做对比。
后续还有很多代码,我都放gitee链接了。使用方法,见readme.md
- 最后一个问题:在PHP中,用同步写代码,程序呢异步执行?需要怎么调整代码。
提示:这个和 PHP
的 yield
语法有关。
再提示:yield
语法特征是什么,进进出出!
看着我们的代码,同步, 异步,进进出出 你想到了什么?
看到代码,同步处理模式下,这三个函数checkInventory
checkProduct
checkPromo
时,发起请求,并依次等待返回的结果,这三个函数执行后,再响应客户请求。
异步处理模式下,这三个函数发起请求完毕后,代码就跳出循环了,然后是在select()
下的一个代码分支中接收请求, 并收集结果。每次收到结果后判断是否完成,完成则响应客户端。
那么能不能这样:在异步处理的流程中,当 Server
收到 自己发起的 client
有数据响应后,代码跳到 nio_server.php 的 247行呢,这样我们的收到请求校验相关的代码就能放到这里,编码能就是同步,容易理解。不然,client
的响应处理放在 280 行以后,不通过抓包,真的很难理解,执行了第 247 行代码后,紧接着是从 280 行开始的。
诶~这里是不是有 进进出出 那种感觉了~ 代码从 247 行出去,开始监听发出 Client
响应,收到返回数据,带着数据再回到 247 行,继续进行逻辑校验,综合结果后,再响应给客户端。
用yield来解决问题
基于 yield 实现的,同步编码,"异步"I/O
的 Socket Server
就实现了。代码。
这里 “异步” 打了引号,大佬别扣这个字眼了。 该是
非阻塞I/O
不等大家的答案了,先上我的结果代码吧,代码呢都放在这个目录下了。
gitee https://gitee.com/xupaul/PHP-generator-yield-Demo/tree/master/yield-socket
运行测试代码
clone 代码到本地后,需要拉起4个 command 命令程序:
拉起3个第三方服务
## 启动一个处理耗时2s的库存服务$ php ./other_server.php 8081 inventory 2## 启动一个处理耗时4s的产品服务$ php ./other_server.php 8082 product 4## 监听8083端口,处理一个请求 耗时6s的 promo 服务$ php ./other_server.php 8083 promo 6
启动购物车服务
## 启动一个非阻塞购物车服务$ php ./async_cart_server.php ## 或者启动一个一般购物车服务$ php ./cart_server.php
发起用户请求
$ php ./user_client.php
运行结果呢如下,通过执行的时间日志,可得这三个请求是并发发起的,不是阻塞通讯。
在看我们的代码,三个函数,发起socket
请求,没有设置callback
,而是通过yield from
接收了三个socket
的返回结果。
也就是达到了,同步编码,异步执行的效果。
运行结果
非阻塞模式
client 端日志:
通过以上 起始时间
和 结束时间
,就看到这三个请求耗时总共就6s,也就按照耗时最长的promo服务的耗时来的。也就是说三个第三方请求都是并发进行的。
cart server 端日志:
而 cart 打印的日志,可以看到三个请求一并发起,并一起等待结果返回。达到非阻塞并发请求的效果。
阻塞模式
client 端日志:
以上是阻塞方式请求,可以看到耗时 12s。也就是三个服务加起来的耗时。
cart server 端日志:
cart 服务,依次阻塞方式请求第三方服务,顺序执行完毕后,共耗时12s,当然如果第一个,获第二个服务报错的话,会提前结束这个检查。会节约一点时间。
工作原理
这里就是用到了 yield
的工作特点——进进出出,在发起非阻塞socket
请求后,不是阻塞方式等待socket响应,而是使用yield
跳出当前执行生成器,等待有socket响应后,在调用生成器的send
方法回到发起socket
请求的函数内,在 yield from Async::all()
接收数据响应数据搜集完毕后,返回。
和Golang比一比
考虑到网速原因,我这就放上一个国内教程链接:Go 并发 教程
php
的协程是真协程,而Go
是披着协程外衣的轻量化线程(“协程”里,都玩上“锁”了,这就是线程)。
我个人偏爱,协程的,觉得线程的调度有一定随机性,因此需要锁机制来保证程序的正确,带来了额外开销。协程的调度(换入换出)交给了用户,保证了一段代码执行连续性(当然进程级上,还是会有换入换出的,除非是跨进程的资源访问,或者跨机器的资源访问,这时,就要用到分布式锁了,这里不展开讨论),同步编码,异步执行,只需要考虑那个哪个方法会有IO交互会协程跳出即可。
和NodeJS比划一下
Javascript 和 PHP 两个脚本语言有很多相似的地方,弱类型,动态对象,单线程,在Web领域生态丰富。不同的是,Javascript
在浏览器端一开始就是异步的(如果js发起网络请求只能同步进行,那么你的网页渲染线程会卡住),例如Ajax
,setTimeout
,setInterval
,这些都是异步+回调的方式工作。
基于V8引擎而诞生的NodeJS
,天生就是异步的,在提供高性能网络服务有很大的优势,不过它的IO编码范式
么。。。刚开始是 回调——毁掉地狱,后来有了Promise——屏幕竖起来看,以及Generator
——遇事不绝yield
一下吧,到现在的Async/Await
——语法糖?真香!
可以说JS的委员非常勤快,在异步编程范式的标准制定也做的很好(以前我尝试写NodeJS
时,几个回调就直接把我劝退了),2009年诞生的NodeJS
有点后来居上的意思。目前PHP
只是赶上了协程,期待PHP的Async/Await
语法糖的实现吧。
PHP yield 使用注意事项
一旦使用上 yield 后,就必须注意调用函数是,会得到函数结果,还是 生成器对象。PHP 不会自动帮你区别,需要你手动代码判断结果类型—— if ($re instanceof \Generator) {}
, 如果你得到的是 生成器,但不希望去手动调用 current() 去执行它,那么在生成器前 使用 yield from 交给上游(框架)来解决。
爆改 Workerman
博客写到这,就开始手痒痒了,看到Workerman框架,我在基础上二开,使其能——同步编码,异步执行。
代码已放到:PaulXu-cn/CoWorkerman.git
目前还是dev阶段,大家喜欢可以先 体验一波。
$ composer require paulxu-cn/co-workerman
一个简单的单线程 TCP Server
<?php// file: ./examples/example2/coWorkermanServer.php , 详细代码见github$worker = new CoWorker('tcp://0.0.0.0:8080');// 设置fork一个子进程$worker->count = 1;$worker->onConnect = function (CoTcpConnection $connection) { try { $conName = "{$connection->getRemoteIp()}:{$connection->getRemotePort()}"; echo PHP_EOL . "New Connection, {$conName} \n"; $re = yield from $connection->readAsync(1024); CoWorker::safeEcho('get request msg :' . $re . PHP_EOL ); yield from CoTimer::sleepAsync(1000 * 2); $connection->send(json_encode(array('productId' => 12, 're' =>true))); CoWorker::safeEcho('Response to :' . $conName . PHP_EOL . PHP_EOL); } catch (ConnectionCloseException $e) { CoWorker::safeEcho('Connection closed, ' . $e->getMessage() . PHP_EOL); }};CoWorker::runAll();
这里设置fork 一个worker
线程,处理逻辑中带有一个sleep()
2s
的操作,依然不影响他同时响应多个请求。
启动测试程序
## 启动CoWorker服务$ php ./examples/example2/coWorkermanServer.php start## 启动请求线程$ php ./examples/example2/userClientFork.php
运行结果
绿色箭头——新的请求,红色箭头——响应请求
从结果上看到,这一个worker线程,在接收新的请求同时,还在回复之前的请求,各个连接交错运行。而我们的代码呢,看样子就是同步的,没有回调。
CoWorker购物车服务
好的,这里我们做几个简单的微服务模拟实际应用,这里模拟 用户请求端
,购物车服务
,库存服务
,产品服务
。 模拟用户请求加购动作,购物车去分别请求 库存,产品 校验用户是否可以加购,并响应客户请求是否成功。
代码我就不贴了,太长了,麻烦移步 CoWorkerman/example/example5/coCartServer.php
运行命令
## 启动库存服务$ php ./examples/example5/otherServerFork.php 8081 inventory 1## 启动产品服务$ php ./examples/example5/otherServerFork.php 8082 product 2
## 启动CoWorker 购物车服务$ php ./examples/example5/coCartServer.php start
## 用户请求端$ php ./examples/example5/userClientFork.php
运行结果
黄色箭头——新的用户请求,蓝色箭头——购物车发起库存,产品检查请求,红色箭头——响应用户请求
从图中看到也是用1个线程服务多个连接,交错运行。
好的,那么PHP CoWorkerman
也能像 NodeJS
那样用 Async/Await
那样同步编码,异步运行了。
快来试试这个 CoWorkerman 吧:
$ composer require paulxu-cn/co-workerman
工作原理
先上图:
图的上部是Workerman 的工作泳道图,图下部是CoWorkerman的工作泳道图。
workerman
内的worker进程
遇到阻塞函数的处理方式时,会等待IO返回,如果这个时候,又有了新的请求,那么闲的worker会竞争到这个新的连接。
我在上图worker5中,描述了一个AsyncTCPConnection
使用情况,woker内发起了一个非阻塞请求,并注册了回调函数,然后程序继续运行到结束。当异步请求响应时,就需要通过其他方式去响应(如自己再发起一个请求告知请求方)。
在下图中CoWorkerman
,也是多个Worker竞争新的请求,当worker1收到一个新的请求,会产生一个生成器,生成器内发起异步请求,并注册响应回调,请求响应后,回到该生成器跳出(yield
)的地方,继续执行代码。
发起异步请求,并注册回调函数,这些默认工作
CoWorkerman
框架内已做了,回调函数内工作是:收到数据,并发给 发起该请求的生成器。
这例子中,通过调用 Promise:all() 发起多个请求,并监听结果返回,待所有的响应返回再继续运行生成器
在程序yield
跳出后,该worker就处于事件循环状态($event->loop()
),也就是多路监听:请求端口,第三方客户端请求响应端口。这个时候如果:
- 有新的请求来,他和其他
worker
竞争新的请求,如果竞争到了,则该worker内又产生一个新的 生成器。 - 客户端有响应,则调用回调函数
- 客户端都响应了,继续运行 生成器程序。
从1中,我们可假设,如果就一个 Worker
,那么该 Worker
可以在上一个请求未完成情况下,继续接受处理下一个请求。也就是 CoWorkerman
可以在单 Worker
下运行,并发处理多个请求。
当然,这里也有个前提,单
Worker
模式内不能运行阻塞函数,一旦阻塞,后续请求就会堵在网卡。所以,除非对自己的代码非常了解,如果用到第三方库,那么我还是建议你在多Worker
模式下运行CoWorkerman
,阻塞时,还有其他Worker
兜住新请求。
CoWorkerman 的意义
- 用同步的代码,发起异步请求,多个请求可并发,从IO串行等待,改为并行等待,减少无畏的等待时间。提高业务程序的效率同时,不降低代码可读性。
- 在一个线程内通过事件循环,尽可能处理多个请求,缓解了一个请求一个线程带来的频繁线程切换,从核心上提高运行效率。
CoWorkerman 生态位
适合处理纯Socket
请求的应用,如Workerman Gateway
,或者是 大前端
整合多个服务RPC
结果, 综合后返给前三页
这样的场景.
日志记录是每个程序最基本需求,由于写文件函数是阻塞的,建议用消息队列,或者redis队列,更或者跳过
Logstash
直接丢Elasticsearch
.
CoWorkerman有他的局限性,也有他自己位置。
总结
好~PHP 协程编码到 网络异步编码就到此结束了,如果看到本文章有很多疑惑,欢迎留言提问,如果是 yield
语法不太记得,可以先读一读这个系列前几篇文章复习一下。
如果行,请三连。CoWorkerman
谢谢!