Workerman 5.2.3如何编写自定义协议类

落敏君_3464

落敏君_3464

2026-10-23

189人浏览

原创

workerman 5.2.3 自定义协议类需在protocols命名空间下实现public static input、decode、encode方法;input判断包边界,decode/encode负责二进制与php数据双向转换,worker实例化时用"类名://地址:端口"启用。

workerman 5.2.3如何编写自定义协议类

Workerman 5.2.3 编写自定义协议类,核心是实现一个含 input、decode、encode 三个静态方法的 PHP 类。它不依赖接口继承,而是靠命名空间和方法签名被框架自动识别。只要类放在 Protocols 命名空间下,且方法声明正确,Workerman 就会在 TCP 连接中自动调用它们处理粘包、解包与封包。

协议类基础结构与位置要求

协议类必须满足以下硬性条件:

  • 文件路径建议为 Protocols/YourProtocol.php(如项目根目录下的 app/Protocols/JsonNL.php)
  • 命名空间必须是 Protocols(不能是 App\Protocols 或其他,除非你手动注册 autoload)
  • 类名任意,但三个方法必须全部为 public static,且参数/返回值类型与框架预期一致
  • 不需要 implements 任何接口,Workerman 通过反射检查方法存在性

input 方法:精准判断数据包边界

这是解决 TCP 粘包/拆包的关键。它接收原始字节流 $buffer,只做一件事:告诉 Workerman「当前缓冲区里有没有一个完整包?如果有,长度是多少?」

  • 返回 正整数 → 表示发现完整包,长度即返回值,Workerman 会截取该长度交给 decode
  • 返回 0 → 表示数据不足,继续收包,不触发后续流程
  • 返回 false 或 -1 → 主动断开当前连接(用于协议校验失败场景)

常见实现方式:

Viggle AI
Viggle AI

Viggle AI是一款把图片角色按参考动作生成动画视频的 AI 动作生成工具。

下载
  • 换行分隔:$pos = strpos($buffer, "\n"); return $pos === false ? 0 : $pos + 1;
  • 固定包头+长度字段(如前4字节为 body 长度):if (strlen($buffer) = 4 + $len ? 4 + $len : 0;

decode 与 encode:业务数据与二进制流的双向转换

decode 在 input 返回有效长度后被调用,参数是已截取的完整原始数据;encode 在调用 $connection->send($data) 时被调用,参数是 PHP 变量(如数组或字符串)。

  • decode($buffer):把二进制数据转成 PHP 可用结构。例如 return json_decode(trim($buffer, "\n"), true);
  • encode($data):把 PHP 数据转成网络可传输格式。例如 return json_encode($data, JSON_UNESCAPED_UNICODE) . "\n";
  • 二者需严格对应——encode 加的换行,decode 就得去掉;encode 用 big-endian 打包长度,decode 就得用相同方式解析

在 Worker 中启用协议类

创建 Worker 实例时,直接把协议类名作为传输层协议传入即可,格式为 "协议类名://地址:端口":

$worker = new Worker("JsonNL://0.0.0.1:8000");

注意:不是 "Protocols\JsonNL://...",Workerman 会自动在 Protocols 命名空间下查找类。启动后,所有连接都会走你定义的 input/decode/encode 流程,$data 直接以解码后的结果传入 onMessage 回调。

相关文章

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

11264

6

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

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

2023.10.11

6521

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

4128

4

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

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

2023.10.23

4854

6

html怎么上传
html怎么上传

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

2023.11.03

3811

9

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

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

2023.11.09

5477

8

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

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

2023.11.13

4282

8

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

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

2023.11.27

12222

4

热门下载

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

精品课程

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

共0课时 | 0人学习

Workerman官方手册
Workerman官方手册

共0课时 | 0人学习

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

共0课时 | 0人学习