Laravel-WebSockets 高级用法：Webhooks 机制详解-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00780/article/details/148507534

Laravel-WebSockets 高级用法：Webhooks 机制详解

laravel-websockets Websockets for Laravel. Done right. 项目地址: https://gitcode.com/gh_mirrors/la/laravel-websockets

什么是 Webhooks

在 Laravel-WebSockets 项目中，Webhooks 是一种强大的机制，允许开发者在 WebSocket 连接的关键生命周期节点注入自定义业务逻辑。与传统的 Pusher Webhooks 不同，Laravel-WebSockets 提供了更灵活、更贴近 Laravel 生态的实现方式。

为什么需要 Webhooks

在实际应用中，我们经常需要在 WebSocket 连接建立或关闭时执行特定操作，例如：

记录用户连接日志
初始化用户会话数据
清理断开连接后的资源
实现自定义的认证逻辑
统计在线用户数量

Webhooks 机制正是为解决这类需求而设计。

实现自定义 WebSocket 处理器

基础实现步骤

创建自定义处理器类：继承基础 WebSocketHandler

namespace App\Controllers\WebSockets;

use BeyondCode\LaravelWebSockets\WebSockets\WebSocketHandler as BaseWebSocketHandler;
use Ratchet\ConnectionInterface;

class WebSocketHandler extends BaseWebSocketHandler
{
    public function onOpen(ConnectionInterface $connection)
    {
        parent::onOpen($connection);
        
        // 连接建立时执行的业务逻辑
        // 可以通过 $connection->app 获取应用信息
        // $this->channelManager 可用于频道管理
    }

    public function onClose(ConnectionInterface $connection)
    {
        parent::onClose($connection);
        
        // 连接关闭时执行的业务逻辑
        // 同样可以访问 $connection->app 和 $this->channelManager
    }
}

修改配置文件：更新 config/websockets.php 中的处理器配置

'handlers' => [
    'websocket' => App\Controllers\WebSockets\WebSocketHandler::class,
],

重启服务：使配置生效

实际应用示例

示例1：记录用户连接信息

public function onOpen(ConnectionInterface $connection)
{
    parent::onOpen($connection);
    
    Log::info('WebSocket 连接已建立', [
        'app_id' => $connection->app->id,
        'socket_id' => $connection->socketId,
        'time' => now()->toDateTimeString()
    ]);
}

示例2：实现自定义认证

public function onOpen(ConnectionInterface $connection)
{
    // 先执行自定义认证逻辑
    if (!$this->validateCustomToken($connection)) {
        $connection->close();
        return;
    }
    
    parent::onOpen($connection);
}

高级用法

访问频道管理器

通过 $this->channelManager 可以访问频道管理器，实现更复杂的逻辑：

public function onClose(ConnectionInterface $connection)
{
    parent::onClose($connection);
    
    // 获取用户订阅的所有频道
    $subscribedChannels = $this->channelManager
        ->getConnectionChannels($connection->socketId);
    
    // 执行清理逻辑...
}

处理连接异常

可以重写 onError 方法处理连接异常：

public function onError(ConnectionInterface $connection, \Exception $e)
{
    // 记录异常日志
    Log::error('WebSocket 连接异常', [
        'error' => $e->getMessage(),
        'trace' => $e->getTraceAsString()
    ]);
    
    parent::onError($connection, $e);
}