序言
本文只是结合GatewayWorker和Workerman的官方文档和源码,深入了解执行过程。以便更深入的了解并使用
GatewayWorker基于Workerman开发的一个项目框架。Register进程负责保存Gateway进程和BusinessWorker进程的地址,建立两者的连接。Gateway进程负责维持客户端连接,并转发客户端的数据给BusinessWorker进程处理,BusinessWorker进程负责处理实际的业务逻辑(默认调用Events.php处理业务),并将结果推送给对应的客户端。Register、Gateway、BusinessWorker进程都是继承Worker类实现各自的功能,所以了解GatewayWorker框架的内部执行过程,需要优先理解Worker的内容
GatewayWorker目录结构
├── Applications // 这里是所有开发者应用项目
│ └── YourApp // 其中一个项目目录,目录名可以自定义
│ ├── Events.php // 开发者只需要关注这个文件
│ ├── start_gateway.php // gateway进程启动脚本,包括端口 号等设置
│ ├── start_businessworker.php // businessWorker进程启动 脚本
│ └── start_register.php // 注册服务启动脚本
│
├── start.php // 全局启动脚本,此脚本会依次加载Applications/项目/start_*.php启动脚本
│
└── vendor // GatewayWorker框架和Workerman框架源码目 录,此目录开发者不用关心
start.php 为启动脚本,在该脚本中,统一加载start_gateway.php start_businessworker.php start_register.php进程脚本,最后通过Worker::runAll();运行所有服务。
工作原理
1、Register、Gateway、BusinessWorker进程启动
2、Gateway、BusinessWorker进程启动后向Register服务进程发起长连接注册自己
3、Register服务收到Gateway的注册后,把所有Gateway的通讯地址保存在内存中
4、Register服务收到BusinessWorker的注册后,把内存中所有的Gateway的通讯地址发给BusinessWorker
5、BusinessWorker进程得到所有的Gateway内部通讯地址后尝试连接Gateway
6、如果运行过程中有新的Gateway服务注册到Register(一般是分布式部署加机器),则将新的Gateway内部通讯地址列表将广播给所有BusinessWorker,BusinessWorker收到后建立连接
7 、如果有Gateway下线,则Register服务会收到通知,会将对应的内部通讯地址删除,然后广播新的内部通讯地址列表给所有BusinessWorker,BusinessWorker不再连接下线的Gateway
8、至此Gateway与BusinessWorker通过Register已经建立起长连接
9、客户端的事件及数据全部由Gateway转发给BusinessWorker处理,BusinessWorker默认调用Events.php中的onConnect onMessage onClose处理业务逻辑。
10、BusinessWorker的业务逻辑入口全部在Events.php中,包括onWorkerStart进程启动事件(进程事件)、onConnect连接事件(客户端事件)、onMessage消息事件(客户端事件)、onClose连接关闭事件(客户端事件)、onWorkerStop进程退出事件(进程事件)
1 Register、Gateway、BusinessWorker进程启动
项目根目录下的start.php 为启动脚本,在该脚本中,加载start_gateway.php start_businessworker.php start_register.php进程脚本,完成各个服务的Worker初始化:
// 加载所有Applications/*/start.php,以便启动所有服务
foreach(glob(__DIR__.'/Applications/*/start*.php') as $start_file)
{
require_once $start_file;
}
最后通过Worker::runAll();运行所有服务。
// 运行所有服务
Worker::runAll();
运行所有服务,先看一遍runAll()方法的执行内容
public static function runAll()
{
// 检查运行环境
self::checkSapiEnv();
//初始化环境变量
self::init();
// 解析命令
self::parseCommand();
// 尝试以守护进程模式运行
self::daemonize();
// 初始化所有worker实例,主要是监听端口
self::initWorkers();
// 初始化所有信号处理函数
self::installSignal();
// 保存主进程pid
self::saveMasterPid();
// 展示启动界面
self::displayUI();
// 创建子进程(worker进程),然后给每个子进程绑定loop循环监听事件tcp
self::forkWorkers();
// 尝试重定向标准输入输出
self::resetStd();
// 监控所有子进程(worker进程)
self::monitorWorkers();
}
self::init()初始化环境变量中,有以下部分代码,保存$_idMap从PID映射到工作进程ID
// Init data for worker id.
self::initId();
protected static function initId()
{
foreach (self::$_workers as $worker_id => $worker) {
$new_id_map = array();
for($key = 0; $key < $worker->count; $key++) {
$new_id_map[$key] = isset(self::$_idMap[$worker_id] [$key]) ? self::$_idMap[$worker_id][$key] : 0;
}
self::$_idMap[$worker_id] = $new_id_map;
}
}
self::forkWorkers()方法通过循环self::$_workers数组,fork各自worker的count数量的进程。然后通过调用
$worker->run();
运行当前worker实例,在run方法中通过
if (!self::$globalEvent) {
$event_loop_class = self::getEventLoopName();
self::$globalEven