layman/laravel-websocket

websocket

v2.1.0 2025-11-04 03:26 UTC

Requires

• php: ^8.0
• ext-swoole: 4.8.*
• predis/predis: *

Requires (Dev)

• swoole/ide-helper: ^4.8

MIT

• layman

README

Laravel websocket 分布式服务扩展包。

⏳ 安装准备

1. PHP版本 >= ^8.0
2. swoole版本 >= 4.8.*
3. predis/predis版本 *
4. redis版本 *
5. mysql >= 5.7

📦 安装

composer require layman/laravel-websocket

⚙️ 发布配置

php artisan vendor:publish --provider="Layman\LaravelWebsocket\WebsocketServiceProvider" --tag=websocket-config
php artisan vendor:publish --tag=websocket-views

🛠️ 启动命令

php artisan websocket:start

📋 二进制消息协议数据格式

字段名	字段是否必传	数据类型	说明
type	是	int	消息类型： 1：文本 2：图片 3：文件 4：视屏 5：控制消息 6：音频 7：表情/动画 8：消息确认 9：其他 101：ping 102：pong
uuid	是	string	消息唯一编号
datetime	是	int	消息时间戳
index	是	int	分片索引
count	是	int	分片总数
peer	是	array	发送者&接收者&群编号&通知类型
└─sender	是	int/string	发送者
└─receiver	是	int/string/array/null	接收者(只有notice_type=3 为系统消息才可为数组个格式)
└─group_code	是	int/string/null	群编号
└─notice_type	是	int	通知类型： 1：私聊 2：群聊-暂不支持 3：系统 4：广播
└─files	是	array	文件参数
payload	是	string	消息内容

🚀 使用

// 测试
Illuminate\Support\Facades\Route::get('/websocket', function () {
    return view('websocket');
});

// 消息订阅
$client = new Predis\Client();
$client->publish('order_subscribe', Layman\LaravelWebsocket\Cores\Utils::pack(
    1,
    Str::uuid(),
    time(),
    1,
    1,
    [
        'sender' => 'server',
        'receiver' => 'x123',
        'group_code' => null,
        'notice_type' => 1,
        'files' => [],
    ],
    json_encode([
        'order_code' => 'xxx123',
        'message' => '您有新的订单！',
    ])
));

// auth认证
class Authenticate implements Layman\LaravelWebsocket\Interfaces\AuthenticateInterface
{
    
}

免责声明

• 扩展包作者不对本工具的安全性、完整性、可靠性、有效性、正确性或适用性做任何明示或暗示的保证，也不对本扩展包的使用造成的任何直接或间接的损失、责任、索赔、要求或诉讼承担任何责任。
• 扩展包作者保留随时修改、更新、删除权利，无需事先通知或承担任何义务。
• 使用者在下载、安装、运行或使用本扩展包时，即表示已阅读并同意本免责声明。如有异议，请立即停止使用本扩展包，并删除所有相关文件。

🙌 支持与贡献

欢迎提 Issue 或 PR 来改进此包。你的每一个建议和贡献，都是我们前进的动力！

如果你觉得 Laravel-Websocket 有帮助，别忘了点个 ⭐ Star 哦！