0

0

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

雪夜

雪夜

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

|

645人浏览过

|

来源于php中文网

原创

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

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

Workerman 自定义协议必须实现 inputencode 吗?

不是必须,但绝大多数自定义场景下,这两个方法缺一不可。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 里调用 substrmb_substr 截取数据——这是 decode 的事

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

encode 的输入是 onMessage 的返回值(或 send() 的参数),输出必须是 stringdecode 的输入是 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,且 inputencode 必须声明为 public,签名也变了:input(string $buffer): ?intencode(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 invalidencode must return string 这类提示
实际跑起来最常出问题的地方,是 input 返回了不确定值(比如有时 0,有时 false),或者 encode 对 null 值没做兜底。这些不会报错,但会让连接看起来“时好时坏”,查起来特别费时间。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

457

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

547

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

335

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

82

2025.09.10

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

1030

2023.08.02

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

254

2023.09.22

java中null的用法
java中null的用法

在Java中,null表示一个引用类型的变量不指向任何对象。可以将null赋值给任何引用类型的变量,包括类、接口、数组、字符串等。想了解更多null的相关内容,可以阅读本专题下面的文章。

1089

2024.03.01

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

760

2023.08.03

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

76

2026.03.11

热门下载

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

精品课程

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号