webman-coroutine是一个webman开发框架生态下的协程基建支撑插件，主要实现以下功能：
- 支持workerman 4.x的swow协程驱动能力，兼容workerman 5.x版本自带的swow协程驱动；
- 支持workerman 4.x的swoole协程驱动能力，兼容workerman 5.x版本自带的swoole协程驱动；
- 实现coroutine web server，用于实现具备协程能力的web框架基建
- 支持自定义协程实现，如基于revolt等
- workerman 4.x/5.x驱动下的webman框架无法完整使用swoole的协程能力，所以使用CoroutineWebServer来替代webman自带的webServer
- workerman 4.x下还未有官方支持的swow协程驱动，本插件提供SwowEvent事件驱动支撑workerman 4.x下的协程能力
- 由于配置event-loop等操作相较于普通开发会存在一定的心智负担，所以本插件提供了
event_loop()函数，用于根据当前环境自动选择合适的事件驱动
- 安装插件包
composer require workbunny/webman-coroutineTips: 目前在开发阶段，体验请使用dev-main分支
- 配置说明
- enable : (true/false), 是否启用协程webServer
- port : (int), 协程webServer默认端口
- channel_size : (int), 协程webServer默认每个stream的channel容量
- 使用
./vendor/bin/swow-builder安装swow拓展，注意请关闭swoole环境 - 修改
config/server.php中'event_loop' => \Workbunny\WebmanCoroutine\event_loop()，event_loop()函数会根据当前环境自行判断当前的workerman版本，自动选择合适的事件驱动- 当开启swow拓展时，workerman 4.x下使用SwowEvent事件驱动
- 当开启swow拓展时，workerman 5.x下使用workerman自带的Swow事件驱动
- 当未开启swow时，使用workerman自带的Event事件驱动
- 使用
php -d extension=swow webman start启动 - webman自带的webServer协程化，可以关闭启动的CoroutineWebServer
Tips：CoroutineWebServer可以在config/plugin/workbunny/webman-coroutine/app.php中通过enable=false关闭启动
- 使用
pecl install swoole安装稳定版swoole拓展 - 建议不要将swoole加入php.ini配置文件
- 修改
config/server.php中'event_loop' => \Workbunny\WebmanCoroutine\event_loop()，event_loop()函数会根据当前环境自行判断当前的workerman版本，自动选择合适的事件驱动- 当开启swoole拓展时，workerman 4.x下使用SwooleEvent事件驱动
- 当开启swoole拓展时，workerman 5.x下使用workerman自带的Swoole事件驱动
- 当未开启swoole时，使用workerman自带的Event事件驱动
- 使用
php -d extension=swoole webman start启动 - 通过
config/plugin/workbunny/webman-coroutine/process.php启动的CoroutineWebServer可以用于协程环境开发，原服务还是BIO模式
- 使用
composer require cclilshy/p-ripple-drive安装ripple驱动插件 - 修改
config/server.php配置'event_loop' => \Workbunny\WebmanCoroutine\event_loop()自动判断，请勿开启swow、swoole，'event_loop' => \Workbunny\WebmanCoroutine\Factory::RIPPLE_FIBER手动指定
- 使用
php webman start启动
Tips：该环境协程依赖php-fiber，并没有自动hook系统的阻塞函数，但支持所有支持php-fiber的插件
- 实现
Workbunny\WebmanCoroutine\Handlers\HandlerInterface接口，实现自定义协程处理逻辑 - 通过
Workbunny\WebmanCoroutine\Factory::register(HandlerInterface $handler)注册你的协程处理器 - 修改
config/server.php中'event_loop' => {你的事件循环类} - 启动CoroutineWebServer，接受处理协程请求
Tips：\Workbunny\WebmanCoroutine\event_loop()自动判断加载顺序按\Workbunny\WebmanCoroutine\Factory::$_handlers的顺序执行available()择先
Tips：因为eventLoopClass与HandlerClass是一一对应的，所以建议不管是否存在相同的事件循环或者相同的处理器都需要继承后重命名
webman-coroutine提供了用于让自己的自定义服务/进程协程化的基础工具
Tips：考虑到webman框架默认不会启用注解代理，所以这里没有使用注解代理来处理协程化代理
- 假设我们已经存在一个自定义服务类，如
MyProcess.php
namespace process;
class MyProcess {
public function onWorkerStart() {
// 具体业务逻辑
}
// ...
}- 在webman/workerman环境中，
onWorkerStart()是一个worker进程所必不可少的方法， 假设我们想要将它协程化，在不改动MyProcess的情况下，只需要新建一个MyCoroutineProcess.php
namespace process;
use Workbunny\WebmanCoroutine\CoroutineWorkerInterface;
use Workbunny\WebmanCoroutine\CoroutineWorkerMethods;
class MyCoroutineProcess extends MyProcess implements CoroutineWorkerInterface {
// 引入协程代理方法
use CoroutineWorkerMethods;
}-
此时的
MyCoroutineProcess将拥有协程化的onWorkerStart() -
将新建的
MyCoroutineProcess添加到webman的自定义进程配置config/process.php中启动即可
- 假设我们已经存在一个自定义服务类，如
MyServer.php
namespace process;
class MyServer {
public function onMessage($connection, $data) {
// 具体业务逻辑
}
// ...
}- 在webman/workerman环境中，
onMessage()是一个具备监听能力的进程所必不可少的方法， 假设我们想要将它协程化，在不改动MyServer的情况下，只需要新建一个MyCoroutineServer.php
namespace process;
use Workbunny\WebmanCoroutine\CoroutineServerInterface;
use Workbunny\WebmanCoroutine\CoroutineServerMethods;
class MyCoroutineServer extends MyServer implements CoroutineServerInterface {
// 引入协程代理方法
use CoroutineServerMethods;
}-
此时的
MyCoroutineServer将拥有协程化的onMessage() -
将新建的
MyCoroutineServer添加到webman的自定义进程配置config/process.php中启动即可