发布于 由admin

Swoole Server事件回调函数：onStart, onWorkerStart等

好的，各位观众老爷，大家好！我是你们的老朋友，人称“代码诗人”的程序猿李白。今天，咱们不吟诗作对，来聊聊PHP界的超跑——Swoole Server的那些让人又爱又恨的事件回调函数。

Swoole，这玩意儿，就像武侠小说里的绝世神功，一旦练成，你的PHP程序就能瞬间拥有超能力，并发能力直接飙升，性能提升那是杠杠的！但是，想要驾驭这股强大的力量，就得先搞清楚Swoole Server的那些事件回调函数，它们就像超跑的各种按钮和仪表盘，你不熟悉它们，轻则熄火，重则翻车啊！

今天，咱们就以“讲座+解说”的模式，把Swoole Server的onStart、onWorkerStart等这些重要回调函数，揉碎了掰开了，用最通俗易懂的语言，加上一点点幽默的佐料，让大家彻底搞明白！

一、Swoole Server：PHP的超跑引擎

首先，咱们得简单了解一下Swoole Server是个什么玩意儿。简单来说，Swoole是一个PHP的扩展，它能让你的PHP程序摆脱传统CGI模式的束缚，像Node.js一样，拥有常驻内存的能力，从而实现高性能的并发处理。

你可以把传统的PHP-FPM比作一辆普通家用车，每次请求都要启动、运行、关闭，费时费力。而Swoole Server就像一辆超跑，启动一次，引擎就一直轰鸣着，随时准备响应请求，速度自然快得多！

二、事件回调函数：超跑的仪表盘和按钮

Swoole Server的事件回调函数，就像超跑的仪表盘和按钮，它们负责监控服务器的各种状态，并在特定事件发生时，执行你预先定义的代码。这些回调函数，是你控制Swoole Server的核心手段。

想象一下，如果你不知道油表在哪里，怎么知道什么时候该加油？如果你不知道启动按钮在哪里，怎么启动超跑呢？所以，掌握这些回调函数，至关重要！

三、重点回调函数逐个击破

接下来，咱们就来重点介绍几个最重要的回调函数，并用生动的例子来解释它们的作用：

  1. onStart：服务器启动时的大合唱

    • 作用： 这个回调函数，在Swoole Server启动时，主进程（Master Process）被创建后立即执行。它只会被执行一次！就像乐队指挥上台，宣布演出正式开始！
    • 用途：
      • 设置进程名称： 让你的进程在系统监控工具中更容易被识别。就像给你的超跑贴个炫酷的车牌号！
      • 初始化全局资源： 比如加载配置文件、连接数据库等。就像为你的超跑加满油，准备好导航！
      • 监听端口： 虽然监听端口也可以在new SwooleServer()时设置，但有时你可能需要在onStart里动态修改。
    • 注意事项：
      • onStart在主进程中执行，不要在这里执行任何和worker进程相关的操作，否则会出错！
      • 避免在这里执行耗时操作，否则会阻塞主进程，影响服务器启动速度。

    示例代码：

    <?php
$server = new SwooleServer("0.0.0.0", 9501);

$server->on('Start', function (SwooleServer $server) {
    // 设置主进程名称
    swoole_set_process_name("swoole_master_process");
    echo "Swoole server started at " . date("Y-m-d H:i:s") . "n";
    // 初始化一些全局资源，例如数据库连接
    // $GLOBALS['db'] = new PDO('mysql:host=localhost;dbname=test', 'root', 'password');
});

$server->on('Connect', function (SwooleServer $server, int $fd) {
    echo "Client: Connect.n";
});

$server->on('Receive', function (SwooleServer $server, int $fd, int $from_id, string $data) {
    echo "Received data: " . $data . "n";
    $server->send($fd, 'Swoole: ' . $data);
    $server->close($fd);
});

$server->on('Close', function (SwooleServer $server, int $fd) {
    echo "Client: Close.n";
});

$server->start();
?>

  2. onWorkerStart：工作进程的启动仪式

    • 作用： 这个回调函数在每一个Worker进程启动时执行。Worker进程是真正处理客户端请求的进程。就像超跑里的每个发动机缸，都在各自启动，准备提供动力！
    • 用途：
      • 加载Worker进程需要的资源： 比如重新连接数据库、加载缓存等。因为每个Worker进程都是独立的，所以需要在每个进程中单独加载资源。
      • 设置Worker进程的名称： 方便区分不同的Worker进程。
      • 初始化一些Worker进程独有的变量或对象。
    • 注意事项：
      • onWorkerStart会被执行多次，每次启动一个Worker进程都会执行一次。
      • 不要在这里执行任何和主进程相关的操作。
      • 如果你的程序使用了require/include加载了某些文件，并且这些文件在Worker进程启动后被修改了，那么需要调用clearstatcache()函数来清除文件状态缓存，确保Worker进程加载的是最新的文件。

    示例代码：

    <?php
$server = new SwooleServer("0.0.0.0", 9501);

$server->on('Start', function (SwooleServer $server) {
    swoole_set_process_name("swoole_master_process");
    echo "Swoole server started at " . date("Y-m-d H:i:s") . "n";
});

$server->on('WorkerStart', function (SwooleServer $server, int $worker_id) {
    swoole_set_process_name("swoole_worker_process_" . $worker_id);
    echo "Worker process {$worker_id} started.n";
    // 重新连接数据库，避免多个worker进程共享同一个连接
    // $GLOBALS['db'] = new PDO('mysql:host=localhost;dbname=test', 'root', 'password');
});

$server->on('Connect', function (SwooleServer $server, int $fd) {
    echo "Client: Connect.n";
});

$server->on('Receive', function (SwooleServer $server, int $fd, int $from_id, string $data) {
    echo "Received data: " . $data . "n";
    $server->send($fd, 'Swoole: ' . $data);
    $server->close($fd);
});

$server->on('Close', function (SwooleServer $server, int $fd) {
    echo "Client: Close.n";
});

$server->start();
?>

  3. onConnect：客户端连接时的握手礼

    • 作用： 当有新的客户端连接到服务器时，这个回调函数会被执行。就像超跑的迎宾灯亮起，欢迎新乘客的到来！
    • 用途：
      • 记录客户端连接信息： 比如客户端的IP地址、端口号等。
      • 进行一些权限验证： 判断客户端是否有权连接服务器。
      • 发送欢迎信息： 给客户端发送一条欢迎消息。
    • 注意事项：
      • onConnect回调函数执行时，连接还没有建立完成，所以不要在这里发送大量数据，以免阻塞连接建立过程。

    示例代码：

    <?php
$server = new SwooleServer("0.0.0.0", 9501);

$server->on('Start', function (SwooleServer $server) {
    swoole_set_process_name("swoole_master_process");
    echo "Swoole server started at " . date("Y-m-d H:i:s") . "n";
});

$server->on('WorkerStart', function (SwooleServer $server, int $worker_id) {
    swoole_set_process_name("swoole_worker_process_" . $worker_id);
    echo "Worker process {$worker_id} started.n";
});

$server->on('Connect', function (SwooleServer $server, int $fd) {
    echo "Client {$fd}: Connect from " . $server->getClientInfo($fd)['remote_ip'] . ":" . $server->getClientInfo($fd)['remote_port'] . ".n";
    // $server->send($fd, "Welcome to Swoole Server!n"); // 可以发送欢迎信息
});

$server->on('Receive', function (SwooleServer $server, int $fd, int $from_id, string $data) {
    echo "Received data: " . $data . "n";
    $server->send($fd, 'Swoole: ' . $data);
    $server->close($fd);
});

$server->on('Close', function (SwooleServer $server, int $fd) {
    echo "Client: Close.n";
});

$server->start();
?>

  4. onReceive：接收数据的核心引擎

    • 作用： 当服务器接收到客户端发送的数据时，这个回调函数会被执行。就像超跑的油门踏板，你踩下去，引擎就会轰鸣，车辆就会加速！
    • 用途：
      • 处理客户端发送的数据： 这是最核心的功能，你可以根据客户端发送的数据，执行相应的业务逻辑。
      • 发送响应数据： 将处理结果发送回客户端。
      • 关闭连接： 如果不需要继续和客户端通信，可以关闭连接。
    • 注意事项：
      • onReceive回调函数是处理客户端请求的核心，务必保证其高效稳定。
      • 要注意处理数据包的完整性，防止出现半包问题。
      • 可以使用$server->send()方法向客户端发送数据，使用$server->close()方法关闭连接。

    示例代码：

    <?php
$server = new SwooleServer("0.0.0.0", 9501);

$server->on('Start', function (SwooleServer $server) {
    swoole_set_process_name("swoole_master_process");
    echo "Swoole server started at " . date("Y-m-d H:i:s") . "n";
});

$server->on('WorkerStart', function (SwooleServer $server, int $worker_id) {
    swoole_set_process_name("swoole_worker_process_" . $worker_id);
    echo "Worker process {$worker_id} started.n";
});

$server->on('Connect', function (SwooleServer $server, int $fd) {
    echo "Client {$fd}: Connect from " . $server->getClientInfo($fd)['remote_ip'] . ":" . $server->getClientInfo($fd)['remote_port'] . ".n";
});

$server->on('Receive', function (SwooleServer $server, int $fd, int $from_id, string $data) {
    echo "Received data from client {$fd}: " . $data . "n";
    // 模拟处理数据
    $response = "Server received: " . $data . ", processing...n";
    // 发送响应数据
    $server->send($fd, $response);
    // 关闭连接
    $server->close($fd);
});

$server->on('Close', function (SwooleServer $server, int $fd) {
    echo "Client: Close.n";
});

$server->start();
?>

  5. onClose：客户端断开时的挥手告别

    • 作用： 当客户端断开连接时，这个回调函数会被执行。就像超跑的尾灯熄灭，乘客下车，车辆准备迎接下一位乘客！
    • 用途：
      • 清理客户端连接资源： 比如释放连接占用的内存、关闭数据库连接等。
      • 记录客户端断开信息： 比如断开时间、断开原因等。
    • 注意事项：
      • onClose回调函数执行时，连接已经断开，所以不要再尝试向客户端发送数据，否则会出错。

    示例代码：

    <?php
$server = new SwooleServer("0.0.0.0", 9501);

$server->on('Start', function (SwooleServer $server) {
    swoole_set_process_name("swoole_master_process");
    echo "Swoole server started at " . date("Y-m-d H:i:s") . "n";
});

$server->on('WorkerStart', function (SwooleServer $server, int $worker_id) {
    swoole_set_process_name("swoole_worker_process_" . $worker_id);
    echo "Worker process {$worker_id} started.n";
});

$server->on('Connect', function (SwooleServer $server, int $fd) {
    echo "Client {$fd}: Connect from " . $server->getClientInfo($fd)['remote_ip'] . ":" . $server->getClientInfo($fd)['remote_port'] . ".n";
});

$server->on('Receive', function (SwooleServer $server, int $fd, int $from_id, string $data) {
    echo "Received data from client {$fd}: " . $data . "n";
    $response = "Server received: " . $data . ", processing...n";
    $server->send($fd, $response);
    $server->close($fd);
});

$server->on('Close', function (SwooleServer $server, int $fd) {
    echo "Client {$fd}: Close.n";
    // 清理客户端连接资源，例如关闭数据库连接
    // if (isset($GLOBALS['db_connections'][$fd])) {
    //     $GLOBALS['db_connections'][$fd] = null;
    //     unset($GLOBALS['db_connections'][$fd]);
    // }
});

$server->start();
?>

  6. onShutdown：服务器停止时的谢幕

    • 作用： 当Swoole Server停止时，这个回调函数会被执行。就像演出结束，乐队谢幕，灯光熄灭！
    • 用途：
      • 清理服务器全局资源： 比如关闭数据库连接、释放缓存等。
      • 记录服务器停止信息： 比如停止时间、停止原因等。
    • 注意事项：
      • onShutdown回调函数只会被执行一次，在主进程中执行。
      • 避免在这里执行耗时操作，否则会阻塞服务器停止过程。

    示例代码：

    <?php
$server = new SwooleServer("0.0.0.0", 9501);

$server->on('Start', function (SwooleServer $server) {
    swoole_set_process_name("swoole_master_process");
    echo "Swoole server started at " . date("Y-m-d H:i:s") . "n";
});

$server->on('WorkerStart', function (SwooleServer $server, int $worker_id) {
    swoole_set_process_name("swoole_worker_process_" . $worker_id);
    echo "Worker process {$worker_id} started.n";
});

$server->on('Connect', function (SwooleServer $server, int $fd) {
    echo "Client {$fd}: Connect from " . $server->getClientInfo($fd)['remote_ip'] . ":" . $server->getClientInfo($fd)['remote_port'] . ".n";
});

$server->on('Receive', function (SwooleServer $server, int $fd, int $from_id, string $data) {
    echo "Received data from client {$fd}: " . $data . "n";
    $response = "Server received: " . $data . ", processing...n";
    $server->send($fd, $response);
    $server->close($fd);
});

$server->on('Close', function (SwooleServer $server, int $fd) {
    echo "Client {$fd}: Close.n";
});

$server->on('Shutdown', function (SwooleServer $server) {
    echo "Swoole server shutdown at " . date("Y-m-d H:i:s") . "n";
    // 清理全局资源，例如关闭数据库连接
    // if (isset($GLOBALS['db'])) {
    //     $GLOBALS['db'] = null;
    // }
});

$server->start();
?>

  7. onWorkerStop：工作进程停止时的告别

    • 作用： 当Worker进程停止时，这个回调函数会被执行。就像超跑的某个发动机缸停止工作，需要进行检修！
    • 用途：
      • 清理Worker进程资源： 比如关闭数据库连接、释放缓存等。
      • 记录Worker进程停止信息： 比如停止时间、停止原因等。
    • 注意事项：
      • onWorkerStop回调函数会被执行多次，每次停止一个Worker进程都会执行一次。
      • 避免在这里执行耗时操作，否则会阻塞Worker进程停止过程.

    示例代码：

    <?php
$server = new SwooleServer("0.0.0.0", 9501);

$server->on('Start', function (SwooleServer $server) {
    swoole_set_process_name("swoole_master_process");
    echo "Swoole server started at " . date("Y-m-d H:i:s") . "n";
});

$server->on('WorkerStart', function (SwooleServer $server, int $worker_id) {
    swoole_set_process_name("swoole_worker_process_" . $worker_id);
    echo "Worker process {$worker_id} started.n";
});

$server->on('Connect', function (SwooleServer $server, int $fd) {
    echo "Client {$fd}: Connect from " . $server->getClientInfo($fd)['remote_ip'] . ":" . $server->getClientInfo($fd)['remote_port'] . ".n";
});

$server->on('Receive', function (SwooleServer $server, int $fd, int $from_id, string $data) {
    echo "Received data from client {$fd}: " . $data . "n";
    $response = "Server received: " . $data . ", processing...n";
    $server->send($fd, $response);
    $server->close($fd);
});

$server->on('Close', function (SwooleServer $server, int $fd) {
    echo "Client {$fd}: Close.n";
});

$server->on('WorkerStop', function (SwooleServer $server, int $worker_id) {
    echo "Worker process {$worker_id} stopped.n";
    // 清理Worker进程资源，例如关闭数据库连接
    // if (isset($GLOBALS['db_connections'][$worker_id])) {
    //     $GLOBALS['db_connections'][$worker_id] = null;
    //     unset($GLOBALS['db_connections'][$worker_id]);
    // }
});

$server->on('Shutdown', function (SwooleServer $server) {
    echo "Swoole server shutdown at " . date("Y-m-d H:i:s") . "n";
});

$server->start();
?>

四、其他重要的回调函数

除了上面介绍的几个最重要的回调函数之外，Swoole Server还提供了很多其他的回调函数，用于处理各种不同的事件。例如：

  • onTask： 用于处理异步任务。
  • onFinish： 当异步任务完成时执行。
  • onPipeMessage： 用于进程间通信。
  • onWorkerError： 当Worker进程发生错误时执行。
  • onManagerStart： 当管理进程启动时执行。
  • onManagerStop： 当管理进程停止时执行。

这些回调函数，就像超跑的各种辅助系统，可以帮助你更好地控制和管理Swoole Server。

五、总结：掌握回调函数，驾驭Swoole超跑

各位观众老爷，经过今天的讲解，相信大家对Swoole Server的事件回调函数已经有了一个比较清晰的认识。

回调函数 作用 执行时机 执行进程 主要用途
onStart 服务器启动时执行 主进程启动后立即执行 主进程 设置进程名称、初始化全局资源、监听端口
onWorkerStart Worker进程启动时执行 每个Worker进程启动时执行 Worker进程 加载Worker进程需要的资源、设置Worker进程名称、初始化Worker进程独有的变量或对象
onConnect 客户端连接时执行 有新的客户端连接到服务器时 Worker进程 记录客户端连接信息、进行权限验证、发送欢迎信息
onReceive 接收到客户端数据时执行 服务器接收到客户端发送的数据时 Worker进程 处理客户端发送的数据、发送响应数据、关闭连接
onClose 客户端断开连接时执行 客户端断开连接时 Worker进程 清理客户端连接资源、记录客户端断开信息
onShutdown 服务器停止时执行 Swoole Server停止时 主进程 清理服务器全局资源、记录服务器停止信息
onWorkerStop Worker进程停止时执行 Worker进程停止时 Worker进程 清理Worker进程资源、记录Worker进程停止信息
onTask 处理异步任务 调用$server->task()方法时 Task进程 执行耗时操作、执行不需要立即返回结果的操作
onFinish 异步任务完成时执行 Task进程完成任务后 Worker进程 获取异步任务的结果、进行后续处理

记住，这些回调函数，就像超跑的仪表盘和按钮，只有熟悉它们，才能真正驾驭Swoole这辆性能怪兽，让你的PHP程序跑得更快、更稳、更远！

希望今天的讲解对大家有所帮助。如果大家还有什么疑问，欢迎在评论区留言，我会尽力解答。下次再见！ 🚗💨

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注