Workerman 4.0.20 自定义协议解析全解析

云婷姑娘_5730

云婷姑娘_5730

2026-08-10

746人浏览

原创

必须实现协议解析逻辑处理tcp粘包拆包,需在protocols/myproto.php中声明namespace protocols;,input方法返回包长或0,decode解析数据,encode序列化,worker构造时传入完整fqcn。

workerman 4.0.20 自定义协议解析全解析

要在 Workerman 4.0.20 中让服务端正确识别并处理客户端发来的私有数据格式,必须实现一套能应对 TCP 粘包、拆包、边界判定和结构转换的协议解析逻辑,不能仅靠 onMessage 回调里手动 substr 或 json_decode 应付。

创建协议类文件并声明命名空间

在项目根目录下新建 Protocols/MyProto.php 文件(路径必须是 Protocols/xxx.php,否则 Workerman 找不到),开头写入标准命名空间:namespace Protocols;

这个命名空间是硬性约定,Workerman 会按此路径自动加载协议类;如果写成 AppProtocols 或漏掉 Protocols,框架完全不会调用你的 input/decode/encode 方法。

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

input 方法决定 Workerman 何时截取缓冲区中的一段完整数据交给 decode。它只接收一个参数 $buffer,返回值必须是整数:

方法一:换行符分隔(适用于 JSON 文本协议)
直接用 strpos($buffer, " ") 查找第一个换行位置;若没找到就返回 0,让 Workerman 继续攒数据;若找到,返回 【$pos + 1】 —— 多加的 1 是为了把换行符本身包含进包长,否则 decode 时会残留 " " 导致 json_decode 失败。

方法二:固定包头 + 动态体长(推荐用于二进制协议)
先检查 strlen($buffer) (假设包头为 4 字节长度 + 1 字节类型);不足则返回 0;足够则用 <code>unpack('Nlen/Ctype', substr($buffer, 0, 5)) 解出真实 body 长度;此时需返回 【5 + $len】,即包头长度加包体长度,一步到位告诉 Workerman 截多少字节。

注意:返回负数(如 -1)会强制断开该连接,调试阶段慎用;返回 false 会导致连接立即关闭且无日志提示,极难排查。

实现 decode 方法:将原始字节转为业务可用数据

当 input 返回的长度被满足后,Workerman 会把对应长度的原始字节传给 decode。这一步必须做干净的数据清洗和结构转换:

Multi-Brain Protocol
Multi-Brain Protocol

一款AI工具,主要用于在主代理响应前,并行运行Kimi K2.5和GPT 5.3 Codex,注入双方观点以增强认知多样性,适合需要提升相关任务效率的用户。

下载

若 input 用的是换行分隔,decode 就该用 trim($buffer) 去掉首尾空白和换行,再 json_decode($buffer, true) 转数组;不 trim 直接 json_decode 会因末尾 " " 报错。

若 input 用的是二进制包头,decode 就该用 substr($buffer, 5) 切掉包头,剩下纯 body 交给业务逻辑;切错位置(比如写成 substr($buffer, 4))会导致 body 缺 1 字节或混入类型字段,后续解析全乱。

实现 encode 方法:确保发送数据可被客户端准确还原

encode 是 decode 的逆过程,唯一目标是让客户端能用相同规则还原数据。它接收业务层传来的任意 PHP 变量(数组、字符串、数字等),必须返回 string 类型的二进制流:

第一步:对输入做类型校验,if (!is_array($data) && !is_string($data)) { $data = (string)$data; },避免 json_encode 处理 null 或 resource 出错。

第二步:若协议约定为 JSON + 换行,直接 return json_encode($data, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES) . " "; —— 【JSON_UNESCAPED_UNICODE 必须加】,否则中文变成 uXXXX,客户端解析失败。

第三步:若协议为二进制,先 pack 包头:$body = json_encode($data); $header = pack('Nc', strlen($body), 0x03); return $header . $body;,顺序不能颠倒,否则客户端 unpack 时长度字段读错。

在 Worker 中启用自定义协议

① 确保协议类文件已放在 Protocols/MyProto.php 路径下,且类名与文件名一致(如 class MyProto);
② 创建 Worker 实例时,协议名写成完整类名前缀:`new Worker('tcp://0.0.0.0:8000', ['protocol' => ProtocolsMyProto::class]);`
③ 不要写成 `'protocol' => 'MyProto'` 或 `'protocol' => 'Protocols\MyProto'`,Workerman 4.0.20 严格要求传递 【类的完整 FQCN(带命名空间的类名)】,字符串形式会被静默忽略,降级为默认 text 协议。

相关文章

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

8924

6

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

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

2023.10.11

5441

5

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

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

2023.10.11

1995

5

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

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

2023.10.23

3368

4

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

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

2023.10.23

4034

6

html怎么上传
html怎么上传

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

2023.11.03

3171

9

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

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

2023.11.09

4477

8

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

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

2023.11.13

3482

8

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

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

2023.11.27

11562

4

热门下载

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

精品课程

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

共0课时 | 0人学习

Workerman官方手册
Workerman官方手册

共0课时 | 0人学习

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

共0课时 | 0人学习