Hyperf如何实现WebSocket服务_Hyperf实现WebSocket服务方法【实时】

风杰酱_4115

风杰酱_4115

2026-04-17

744人浏览

原创

需安装hyperf/websocket-server组件、配置server_websocket服务器、创建websocketcontroller控制器并注解事件方法、可选路由绑定与中间件、最后启动服务验证连接。

hyperf如何实现websocket服务_hyperf实现websocket服务方法【实时】

如果您希望在Hyperf框架中启用实时双向通信能力,但WebSocket服务未正常启动或无法响应客户端连接,则可能是由于服务配置缺失、组件未安装或控制器未正确声明所致。以下是实现Hyperf WebSocket服务的多种方法:

一、安装WebSocket服务组件

Hyperf默认不包含WebSocket运行时支持,需显式引入官方扩展包以激活底层Swoole WebSocket能力。该步骤是所有后续配置的前提。

1、执行Composer命令安装核心依赖:composer require hyperf/websocket-server

2、确认Swoole扩展已启用且版本兼容(推荐Swoole ≥ 4.8.0)

3、检查php.ini中extension=swoole.so是否已加载,可通过php --ri swoole验证

二、配置WebSocket服务器实例

需在服务启动配置中注册一个类型为SERVER_WEBSOCKET的独立服务器,明确绑定监听地址与端口,并关联标准事件回调,确保握手、消息、断开等生命周期可被框架捕获。

1、打开config/autoload/server.php文件

2、在'servers'数组中添加以下配置块:

'name' => 'ws', 'type' => \Hyperf\Server\Server::SERVER_WEBSOCKET, 'host' => '0.0.0.0', 'port' => 9502, 'sock_type' => SWOOLE_SOCK_TCP

3、在'callbacks'中映射关键事件:

Event::ON_HAND_SHAKE => [\Hyperf\WebSocketServer\Server::class, 'onHandShake'], Event::ON_MESSAGE => [\Hyperf\WebSocketServer\Server::class, 'onMessage'], Event::ON_CLOSE => [\Hyperf\WebSocketServer\Server::class, 'onClose']

三、创建WebSocket消息处理器

通过注解驱动或接口实现方式定义控制器,使框架能在连接建立、消息到达、连接关闭时自动调用对应方法。此步骤决定业务逻辑如何响应实时事件。

1、新建类App\Controller\WebSocketController,继承\Hyperf\WebSocketServer\Annotation\WebSocketController

2、使用@OnOpen注解标记连接初始化方法,接收Request $request参数获取fd及查询参数

Hyperframes Creative
Hyperframes Creative

HyperFrames视频非动画创意指导,包括设计规范(frame.md/design.md)处理、配色、字体设计、旁白及节奏规划等。

下载

3、使用@OnMessage注解标记消息接收方法,参数为Frame $frame,从中提取$frame->data

4、使用@OnClose注解标记连接终止方法,传入int $fd用于资源清理

5、在方法内调用$this->sender->send($fd, $data)向指定客户端推送字符串数据

四、启用路由绑定与中间件(可选)

当需要对WebSocket连接路径进行语义化管理或统一鉴权时,可通过路由机制将特定URI路径映射到控制器,并插入全局中间件拦截非法请求。

1、编辑config/routes.php文件

2、调用Router::addServer('ws', function () { ... }),其中'ws'必须与server配置中的name一致

3、在闭包内注册路由:Router::get('/', 'App\Controller\WebSocketController')

4、如需中间件,在config/autoload/middlewares.php中为'ws'键添加中间件类数组

五、启动服务并验证连接

完成配置后,需重新启动服务进程以加载新服务器实例;前端可通过原生WebSocket API发起连接测试,确认握手成功及消息往返是否正常。

1、执行php bin/hyperf.php start启动服务

2、在浏览器控制台输入:const ws = new WebSocket('ws://127.0.0.1:9502')

3、监听ws.onopen事件确认连接建立

4、调用ws.send(JSON.stringify({ content: 'hello' }))发送测试消息

5、观察服务端日志输出及ws.onmessage是否收到响应

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

websocket hyperf

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

3109

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2288

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1220

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1178

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1336

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

2118

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3400

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

15395

6

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

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

2023.09.22

549

3

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WebSocket手册
WebSocket手册

共0课时 | 0人学习

Webman中文手册
Webman中文手册

共0课时 | 0人学习