讲师中心 微信公众号
AI工具推荐 视频效率加速

Workerman怎么自定义协议_实现input和encode方法详解【详解】

浅涛君_8387

浅涛君_8387

发布时间:2026-03-12 22:37:10

|

685人浏览过

|

来源于php中文网

原创

不是必须,但绝大多数自定义场景下input和encode缺一不可;input用于判断数据包完整性以解决粘包,encode用于序列化返回值确保客户端可解析。

workerman怎么自定义协议_实现input和encode方法详解【详解】

Workerman 自定义协议必须实现 input 和 encode 吗?

不是必须,但绝大多数自定义场景下,这两个方法缺一不可。Workerman 的协议解析流程是:收到原始数据 → 调用 input 判断是否收齐一帧 → 收齐后调用 decode(如果存在)→ 处理业务逻辑 → 返回值交给 encode 序列化发送。如果你跳过 input,TCP 粘包问题会直接导致 onMessage 收到半包或乱包;不实现 encode,返回值会被强制转成字符串(比如数组变 Array),客户端根本没法解析。

input 方法怎么写才不丢包、不卡死?

input 的唯一职责是:告诉 Workerman “当前缓冲区里有没有一个完整的数据单元”。它不能做解析,不能修改缓冲区,不能抛异常,返回值只能是 0(没收到完整包)、正整数(包长度)、false(连接应关闭)。常见错误是返回负数或非数字,会导致 Worker 进程静默退出。

  • 定长协议:直接返回固定长度,比如 return 16;
  • 带包头的变长协议(如前 4 字节是 body 长度):先检查缓冲区是否 ≥ 4,再读出长度 $len = unpack('N', $buffer)[1],最后判断 strlen($buffer) >= 4 + $len,满足则返回 4 + $len,否则返回 0
  • 行协议(如 HTTP、Redis):用 strpos($buffer, "\r\n") 找分隔符,找到就返回位置 + 2,找不到返回 0
  • 绝对不要在 input 里调用 substr 或 mb_substr 截取数据——这是 decode 的事

encode 方法和 decode 怎么配对才不出错?

encode 的输入是 onMessage 的返回值(或 send() 的参数),输出必须是 string;decode 的输入是 input 切出来的完整包,输出应该是业务能直接用的结构(如数组、对象)。两者类型要严格镜像:如果 decode 返回 ['cmd' => 'login', 'data' => [...]],那 encode 就该接受同样结构并吐出二进制或 JSON 字符串。

  • JSON 协议:decode 用 json_decode($buffer, true),encode 用 json_encode($data, JSON_UNESCAPED_UNICODE)
  • 二进制协议:decode 用 unpack 拆字段,encode 用 pack 组包,注意字节序(N 大端,V 小端)和字段顺序必须完全一致
  • 别在 encode 里加换行或空格——除非协议明确要求,否则容易被客户端当成脏数据
  • 如果 encode 返回非 string(比如 null、array),Workerman 会静默转成空字符串,对方收不到任何东西

Workerman 7+ 的协议类写法和老版本有啥关键差异?

Workerman 7 开始强制要求协议类继承 Workerman\Protocols\ProtocolInterface,且 input 和 encode 必须声明为 public,签名也变了:input(string $buffer): ?int、encode(mixed $data): string。老版本允许返回 false 表示断连,新版本得抛 Workerman\Connection\ConnectionException。

  • 旧写法 public function input($buffer) { return false; } 在 v7+ 会触发致命错误
  • 新协议类里,decode 不再是可选方法,如果没定义,Workerman 会把原始 buffer 当作字符串传给 onMessage
  • 路径上,v7+ 的协议类建议放在 app/Protocols/YourProtocol.php,自动加载更稳定,别再扔在 vendor 里硬改
  • 调试时看 Worker::$logFile,重点搜 Protocol input returned invalid 或 encode must return string 这类提示
实际跑起来最常出问题的地方,是 input 返回了不确定值(比如有时 0,有时 false),或者 encode 对 null 值没做兜底。这些不会报错,但会让连接看起来“时好时坏”,查起来特别费时间。

热门AI工具

更多
超级麦吉

一款通过数字员工协作完成调研、数据分析与文档制作的AI办公平台。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

创客贴AI

创客贴AI是一款AI图像与设计工具,AI辅助的智能在线设计工具。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

相关专题

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

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

11624

2023.09.01

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

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

6701

2023.10.11

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

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

2175

2023.10.11

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

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

4248

2023.10.23

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

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

4954

2023.10.23

html怎么上传
html怎么上传

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

3891

2023.11.03

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

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

5617

2023.11.09

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

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

4402

2023.11.13

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

20

2026.10.28

热门下载

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

精品课程

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

共0课时 | 0人学习

Workerman官方手册
Workerman官方手册

共0课时 | 0人学习

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

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn