Workerman怎么自定义协议实现自己的数据包格式

大明姑娘_2377

大明姑娘_2377

2026-08-07

554人浏览

原创

要在workerman中实现自定义数据包格式,必须绕过默认tcp裸流解析,通过编写protocol类并正确放置于protocols目录、设置命名空间为protocols,实现input(识别包边界)、decode(解析数据)、encode(序列化发送)三个核心方法,再在worker中指定协议名启用。

workerman怎么自定义协议实现自己的数据包格式

要在Workerman中实现自己的数据包格式,必须绕过默认的TCP裸流解析逻辑,让服务端能准确识别每个完整数据包的起始与结束位置,否则会因TCP粘包/拆包导致业务数据错乱、JSON解析失败或连接异常中断。

创建协议类文件并放置到正确路径

在你的项目根目录下,确保存在 Protocols 文件夹(如不存在请手动创建),然后新建一个PHP文件,例如 MyProtocol.php。

文件必须放在 Protocols/MyProtocol.php 路径下,且命名空间必须为 Protocols;若路径或命名空间错误,Workerman启动时会直接报 【Class 'Protocols\MyProtocol' not found】 致命错误,无法加载协议。

用文本编辑器打开该文件,写入标准协议类骨架:

实现input方法:决定何时算“一包收齐了”

这是最关键的一步。input方法接收原始字节流 $buffer,返回值决定Workerman是否触发decode和onMessage。

Cici
Cici

一款AI翻译工具,主要用于Cici 是你的AI聊天助手,可以用于智能对话、写作、翻译、情感支持和编程,是您寻求建议、解答和聊天的首选伙伴,适合需要提升相关任务效率的用户。

下载

方法一:用换行符 \n 作为包边界(适合纯文本/JSON场景)
在类中添加 static function input($buffer) {
  $pos = strpos($buffer, "\n");
  if ($pos === false) return 0;
  return $pos + 1;
}

方法二:用前4字节表示包体长度(兼容C#/Java客户端)
先检查缓冲区是否至少有4字节:
if (strlen($buffer) 再用 unpack('Nlen', $buffer) 提取大端序整数长度 len;
若 len ≤ 0 或 strlen($buffer) 否则返回 4 + len —— 这个值必须严格等于实际截取长度,否则 decode 会收到错位数据。

⚠️ 注意:input 返回 0 表示继续等待,返回正整数表示立即截取对应长度交给 decode,返回 false 会直接断开该客户端连接。

实现decode方法:把原始字节转成PHP可用数据

当 input 返回正值后,Workerman会把对应长度的字节传给 decode 方法。

如果 input 用的是 \n 分隔,decode 就要移除末尾换行并 JSON 解码:
return json_decode(trim($buffer, "\n"), true);

如果 input 用的是长度前缀,decode 就要跳过前4字节再处理:
$body = substr($buffer, 4);
return json_decode($body, true) ?: [];

这一步不能抛出异常,否则 onMessage 不会被调用;若解码失败,建议返回空数组或 null,由业务逻辑判断。

实现encode方法:把PHP数据转成网络可传格式

当调用 $connection->send($data) 时,Workerman自动将 $data 传入 encode 方法处理后再发出去。

对应 \n 协议:
return json_encode($data, JSON_UNESCAPED_UNICODE) . "\n";

对应长度前缀协议:
$json = json_encode($data, JSON_UNESCAPED_UNICODE);
$len = strlen($json);
return pack('N', $len) . $json;

注意:encode 输出必须与 input 的解析规则严格匹配,否则客户端永远收不到完整包。

在Worker中启用自定义协议

第一步:引入 Workerman 自动加载器
require_once __DIR__ . '/vendor/workerman/workerman/Autoloader.php';

第二步:实例化 Worker 并指定协议名
$worker = new Worker('MyProtocol://0.0.0.0:2346');

第三步:设置 onMessage 回调
$worker->onMessage = function($connection, $data) {
  var_dump($data); // 此处 $data 已是 decode 后的数组,非原始字符串
  $connection->send(['status' => 'ok']);
};

第四步:启动服务
Worker::runAll();

相关文章

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

10744

6

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

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

2023.10.11

6281

5

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

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

2023.10.11

2135

5

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

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

2023.10.23

3968

4

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

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

2023.10.23

4674

6

html怎么上传
html怎么上传

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

2023.11.03

3671

9

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

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

2023.11.09

5257

8

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

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

2023.11.13

4102

8

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

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

2023.11.27

12042

4

热门下载

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

精品课程

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

共0课时 | 0人学习

Workerman官方手册
Workerman官方手册

共0课时 | 0人学习

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

共0课时 | 0人学习