Swoole Server事件回调

案例

服务器

$ vim server.php

<?php

//创建服务器对象
$host = "0.0.0.0";//服务器主机地址，0.0.0.0表示所有客户端都能连接。
$port = 9000;//监听端口
$mode = SWOOLE_PROCESS;//服务器运行模式，默认多进程
$sock_type = SWOOLE_SOCK_TCP;//服务器套接字类型，默认TCP
$server = new swoole_server($host, $port, $mode, $sock_type);

//设置服务器运行时参数
$config = [];
$config["worker_num"] = 4;//设置启动的Worker进程数量
$config["daemon"] = false;//设置守护进程化
$server->set($config);

//注册事件回调函数
//Master进程 监听启动事件
$server->on("Start", function(swoole_server $server){
    try{
        $master_pid = $server->master_pid;//获取Master主进程的PID
        $manager_pid = $server->manager_pid;//获取Manager管理进程的PID
        echo "[start] master {$master_pid} manager {$manager_pid}".PHP_EOL;
    }catch(Exception $e){
        echo "[start] exception";
    }
});
//Worker进程 监听连接进入事件
$server->on("Connect", function(swoole_server $server, $fd, $reactor_id){
    $worker_pid = $server->worker_pid;
    echo "[connect] worker {$worker_pid} reactor {$reactor_id} client {$fd}: connect".PHP_EOL;
});
//Worker进程 监听数据接收事件
$server->on("Receive", function(swoole_server $server, $fd, $reactor_id, $data){
    $worker_pid = $server->worker_pid;
    echo "[receive] worker {$worker_pid} reactor {$reactor_id} client {$fd}: {$data}".PHP_EOL;
    //向客户端发送消息
    $message = "welcome";
    $server->send($fd, $message);
});
//Worker进程 监听连接关闭事件
$server->on("Close", function(swoole_server $server, $fd, $reactor_id){
    echo "[close] reactor {$reactor_id} client {$fd}: close".PHP_EOL;
});

//启动服务器
$server->start();

客户端

$ vim client.php

<?php
$client = new swoole_client(SWOOLE_SOCK_TCP, SWOOLE_SOCK_ASYNC);
$client->on("connect", function(swoole_client $client){
    $client->send("GET / HTTP/1.1");
});
$client->on("receive", function(swoole_client $client, $data){
    echo "receive: {$data}".PHP_EOL;
    $client->send(str_repeat("x", 10));
    sleep(1);
});
$client->on("error", function(swoole_client $client){
    echo "error".PHP_EOL;
});
$client->on("close", function(swoole_client $client){
    echo "close".PHP_EOL;
});

$host = "127.0.0.1";
$port = 9000;
$client->connect($host, $port);

运行服务器

$ php server.php

运行客户端

$ php client.php

观察服务器

$ php server.php
[start] master 493 manager 494
[connect] worker 496 reactor 0 client 1: connect
[receive] worker 496 reactor 0 client 1: GET / HTTP/1.1
[receive] worker 496 reactor 0 client 1: xxxxxxxxxx
[receive] worker 496 reactor 0 client 1: xxxxxxxxxx
[receive] worker 496 reactor 0 client 1: xxxxxxxxxx
[receive] worker 496 reactor 0 client 1: xxxxxxxxxx
[receive] worker 496 reactor 0 client 1: xxxxxxxxxx
[receive] worker 496 reactor 0 client 1: xxxxxxxxxx
[receive] worker 496 reactor 0 client 1: xxxxxxxxxx
[receive] worker 496 reactor 0 client 1: xxxxxxxxxx
[receive] worker 496 reactor 0 client 1: xxxxxxxxxx
[receive] worker 496 reactor 0 client 1: xxxxxxxxxx
[close] reactor 0 client 1: close

观察客户端

$ php client.php
receive: welcome
receive: welcome
receive: welcome
receive: welcome
receive: welcome
receive: welcome
receive: welcome
receive: welcome
receive: welcome
receive: welcome
^C

事件执行

• 所有事件回调均在$server->start之后发生
• 服务器关闭程序终止时最后一次事件是onShutdown
• 服务器启动成功后，onStart、onManagerStart、onWorkerStart会在不同的进程内并发执行
• onReceive、onConnect、onClose、onTimer事件在Worker进程中各自触发
• Worker进程与Task进程启动时会调用onWorkerStart事件，结束时会调用onWorkerStop事件
• onTask事件仅仅在Task进程中发生
• onFinish事件仅仅在Worker进程中发生
• onStart、onManagerStart、onWorkerStart三个事件的执行顺序是不确定的
• UDP协议下只有onReceive事件没有onConnect和onClose事件
• 如果没有设置onPacket回调函数，收到UDP数据包默认会回调onReceive事件。
• onOpen事件回调是可选的，当WebSocket客户端与服务器建立连接并完成握手后会回调此函数

使用注意

• 执行sleep以及其它休眠函数会导致整个进程阻塞
• exit和die会导致Worker进程退出
• 通过register_shutdown_function来捕获错误，在进程异常退出时可做一些请求工作。
• 如果需要抛出异常必须在回调函数中进行try...catch捕获异常，否则会导致工作进程退出。
• Swoole不支持set_exception_handler必须使用try...catch方式处理 异常
• Worker进程不得公用同一个Redis或MySQL等网络服务客户端，Redis或MySQL创建连接的相关代码可以放到onWorkerStart回调函数中。原因是如果公用一个连接，返回的结果无法保证被哪个进程处理。持有链接的进程理论上都可以对连接进行读写，这样数据就会发生错乱。
• 不能使用类的属性来保存客户端的连接信息，以为一个Worker进程中可以处理多个客户端连接，导致类属性错误错乱，而使用常量则可以。

---

onFinish

当Worker工作进程投递的任务在task_worker中完成时，Task进程会通过swoole_server->finish()方法将任务处理结果发送给Worker进程。

原型

void onFinish(swoole_server $serv, int $task_id, string $data)

参数

参数：int $task_id 任务编号
参数：string $data 任务处理的内容结果

注意

• Task进程的onTask事件中没有调用finish方法或return结果时Worker进程是不会触发onFinish回调的。
• 执行onFinish逻辑的Worker工作进程与下发Task任务的Worker进程属于同一个进程

---

onClose

TCP客户端连接关闭后，在Worker工作进程中回调onClose函数。

原型

void onClose(swoole_server $server, int $fd, int $reactor_id)

参数

参数1：swoole_server $server 表示swoole_server服务器对象
参数2：int $fd 表示客户端连接的文件描述符
参数3：int $reactor_id 表示来自哪一个Reactor线程

注意

• onClose回调函数如果发生致命错误，将会导致连接泄漏，可通过netstat命令查看到大量CLOSE_WAIT状态的TCP连接。
• 无论由客户端发起的close还是服务器主动调用$server->close()关闭连接，都会触发onClose事件，因此只要连接关闭就一定会回调onClose函数。
• swoole1.7.7+版本后onClose中依然调用connection_info方法获取连接信息，在onClose回调函数执行完毕后才会调用close关闭TCP连接。
• 回调onClose时表示客户端连接已经关闭，所以无需执行$server->close($fd)，如果执行了则会抛出PHP错误告警。
• swoole1.9.7版本修改了$reactor_id参数，当服务器主动关闭连接时，底层会是何止