如何在Workerman 5.2.3注册自定义通信协议

小磊君_7734

小磊君_7734

2026-10-22

540人浏览

原创

在 workerman 5.2.3 中注册自定义通信协议需实现 protocolinterface 接口,提供 input、decode、encode 三个静态方法,并通过 worker 的 protocol 属性传入类名字符串,workerman 启动时自动加载调用。

如何在workerman 5.2.3注册自定义通信协议

在 Workerman 5.2.3 中注册自定义通信协议,核心是实现一个符合 `WorkermanProtocolsProtocolInterface` 的类,并在创建 `Worker` 实例时通过 `protocol` 属性指定该协议类的完整类名(字符串形式)。

不需要手动注册或全局声明,Workerman 在启动时会自动根据 `protocol` 配置加载并调用你实现的三个关键静态方法:`input`、`decode`、`encode`。整个过程轻量、无侵入,完全基于约定而非配置中心或服务发现。

协议类必须实现的三个静态方法

你的自定义协议类(例如 AppProtocolsMyBinaryProtocol)需包含以下静态方法:

飞桨PaddlePaddle
飞桨PaddlePaddle

飞桨PaddlePaddle是百度推出的开源深度学习平台。

下载
  • input(string $buffer): int|false 判断缓冲区数据是否构成完整包。返回 0 表示数据不足,需继续等待;返回正整数表示当前可解析的包长度;返回 false 会立即关闭连接。
  • decode(string $buffer): mixed 对已截取的完整数据包进行解包,返回应用层可用的数据(如数组、对象等)。若解析失败,建议抛出异常或返回 null,由 onMessage 统一处理。
  • encode(mixed $data): string 将 PHP 变量(如 ['type'=>'ping','seq'=>1])序列化为二进制流(如 pack('N', 12) . json_encode(...)),确保客户端能按相同规则还原。

在 Worker 中启用该协议

创建 Worker 实例时,直接通过 protocol 属性传入协议类的完整命名空间字符串:

use WorkermanWorker;
require_once __DIR__ . '/vendor/autoload.php';

$worker = new Worker('tcp://0.0.0.0:7777');
$worker->protocol = 'App\Protocols\MyBinaryProtocol'; // 注意双反斜杠转义

$worker->onMessage = function($connection, $data) {
    // $data 已是 decode 后的结果,直接使用
    var_dump($data);
    $connection->send(['status' => 'ok', 'received' => $data]);
};

Worker::runAll();

协议类的典型结构示例

以“4字节包头+JSON体”为例,协议类可这样组织:

namespace AppProtocols;

class MyBinaryProtocol
{
    public static function input(string $buffer): int
    {
        if (strlen($buffer) 

<h3>注意事项与常见问题</h3>
  • 类文件需能被自动加载(推荐 Composer PSR-4 规范);
  • 所有方法必须为 static,且参数/返回值类型严格匹配接口要求;
  • 不要在 encode/decode 中做耗时操作(如 DB 查询、远程请求),否则阻塞事件循环;
  • 如果协议用于 WebSocket 场景,请注意:Workerman 的 websocket:// 协议底层已封装帧处理,自定义协议仅适用于 tcp:// 或 udp://;
  • 调试时可在 input 中打印 strlen($buffer) 和 bin2hex($buffer) 辅助分析粘包/拆包行为。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2023.09.01

11184

6

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

6501

5

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

2155

5

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

2023.10.23

4108

4

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

2023.10.23

4834

6

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.03

3791

9

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.09

5437

8

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.13

4262

8

sprintf函数用法详解
sprintf函数用法详解

sprintf函数的用法:1、格式化字符串;2、指定输出宽度和精度;3、返回值。更多关于sprintf函数用法详解的内容,大家可以阅读下面的文章。

2023.11.27

12202

4

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Webman中文手册
Webman中文手册

共0课时 | 0人学习

Workerman官方手册
Workerman官方手册

共0课时 | 0人学习

ThinkPHP5.1完全开发手册
ThinkPHP5.1完全开发手册

共0课时 | 0人学习