Workerman 5.2.3自定义协议如何返回响应数据

胖宇大大_6565

胖宇大大_6565

2026-10-23

110人浏览

原创

workerman自定义协议不直接返回响应,而是由onmessage业务逻辑调用$connection->send()触发协议encode方法编码后发送;协议只需实现input、decode、encode三个静态方法,专注编解码。

workerman 5.2.3自定义协议如何返回响应数据

Workerman 5.2.3 中自定义协议本身不直接“返回响应”,而是通过协议的 encode 方法将业务数据转换为可发送的字节流,再由连接对象($connection->send())发出。响应数据的生成和传递,完全由你的业务逻辑(如 onMessage 回调)控制,协议只负责编解码。

协议类只需专注三件事:input、decode、encode

你写的协议类(例如 MyProtocol)必须提供三个静态方法:

  • input($buffer):判断当前接收缓冲区是否凑够一个完整包。返回包长(>0)、0(继续等)、或 false/-1(断连)。
  • decode($buffer):对已截取的完整包做解析,返回业务层能直接用的数据(比如数组、对象)。
  • encode($data):把业务层要发出去的 $data(比如 ['code'=>0, 'msg'=>'ok'])转成二进制格式(如 JSON + 换行、或带包头的二进制流)。

响应数据由 onMessage 决定,不是协议决定

当客户端发来数据,Workerman 自动完成:
收包 → 调 input → 截包 → 调 decode → 得到 $data → 触发 onMessage($connection, $data)。
此时,你要在 onMessage 里处理业务,并调用 $connection->send() 发送响应:

  • 传入的参数是原始业务数据($data 是 decode 返回的结果);
  • $connection->send($responseData) 会自动调用你协议的 encode 方法;
  • 最终发给客户端的是 encode($responseData) 的返回值。

常见 encode 实现示例(JSON+换行)

假设你协议按换行分包,encode 就是序列化加换行:

英博云AI算力
英博云AI算力

英博云AI算力是一款AI工具,英博数科推出的GPU智算服务云平台。

下载
namespace Workerman\Protocols;
class JsonNL {
  public static function encode($buffer) {
    return json_encode($buffer, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES) . "\n";
  }
}

那么你在 onMessage 里这样写就能发响应:

$connection->send(['status' => 'success', 'data' => ['id' => 123]]);

Workerman 会自动调用 JsonNL::encode(...),把数组变成 {"status":"success","data":{"id":123}}\n 发出去。

注意:不要在 encode 里做业务逻辑或异步操作

encode 必须是纯函数:输入确定,输出确定,无副作用、无 IO、不 await、不 sleep。所有数据库查询、HTTP 请求、鉴权校验等,都应在 onMessage 或更下层业务方法中完成,然后把结果传给 send()。

相关文章

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

11304

6

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

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

2023.10.11

6541

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

4148

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

5497

8

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

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

2023.11.13

4302

8

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

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

2023.11.27

12242

4

热门下载

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

精品课程

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

共0课时 | 0人学习

Workerman官方手册
Workerman官方手册

共0课时 | 0人学习

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

共0课时 | 0人学习