经验首页 前端设计 程序设计 Java相关 移动开发 数据库/运维 软件/图像 大数据/云计算 其他经验
当前位置：技术经验 » 程序设计 » PHP » 查看文章
【workerman】uniapp+thinkPHP5使用GatewayWorker实现实时通讯
来源：cnblogs　　作者：我恨bug　　时间：2024/7/11 11:15:48　　对本文有异议

前言

之前公司需要一个内部的通讯软件，就叫我做一个。通讯软件嘛，就离不开通讯了，然后我就想到了长连接。这里本人用的是GatewayWorker框架。

什么是GatewayWorker框架？

GatewayWorker是基于Workerman开发的一套TCP长连接的应用框架，实现了单发、群发、广播等接口，内置了mysql类库，GatewayWorker分为Gateway进程和Worker进程，支持分布式部署，能够支持大量的连接数。

GatewayWorker的工作原理

image

  1. 1、启动所有进程（GatewayWorker、business、register）
  3. 2、GatewayWorker和business进程启动后向register请求注册
  5. 3、register服务收到注册请求后，把所有Gateway的通讯地址保存在内存中同时把内存中所有的Gateway的通讯地址发给business
  7. 4、business进程得到所有的Gateway内部通讯地址后进行连接GatewayWorker
  9. 5、如果有新的GatewayWorker服务进行register，则将新的Gateway内部通讯地址列表将广播给所有buiness并建立连接
  11. 6、如果有GatewayWorker下线，则Register服务会收到通知，会将该GatewayWorker内部通讯地址删除，然后广播新的内部通讯地址列表给所有business
  13. 7、此时GatewayWorker与buiness已经建立起长连接
  15. 8、客户端的事件及接受的数据全部由GatewayWorker转发给business进行处理。

目录结构

  1. ├── Applications // 项目应用目录
  2. │   └── YourAppGateway  // 建立一个存放workman的目录，名字随意
  3. │       ├── Events.php // 处理主逻辑业务的文件，管理onConnect onMessage onClose 等方法
  4. │       ├── start_gateway.php // gateway进程启动脚本、配置服务注册地址、端口号、进程数等参数
  5. │       ├── start_businessworker.php // 用户进程的启动脚本
  6. │       └── start_register.php // 注册服务的启动脚本
  7. │
  8. ├── start.php // 全局启动脚本，此脚本会依次加载Applications/YourAppGateway/start*.php对所有脚本进行启动
  9. │
  10. └── vendor    // GatewayWorker框架和Workerman框架源码目录

GatewayWorker实现

以宝塔为例

1.安装composer

登录SSH终端,使用以下命令下载Composer的安装脚本：

  1. php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"

运行下面的命令来安装Composer：

  1. php composer-setup.php --install-dir=/usr/local/bin --filename=composer

检查composer版本

  1. composer -v //检查composer版本

2.安装workerman

在项目根目录打开宝塔终端，输入以下命令安装workman

  1. composer require topthink/think-worker

3.安装GatewayWorker

在项目根目录打开宝塔终端，输入以下命令安装GatewayWorker

  1. composer require workerman/gateway-worker

4.实现代码

可以选择官方提供的demo 链接：http://www.workerman.net/download/GatewayWorker.zip

或者使用我根据demo改编而来的

先在项目应用目录(一般是Applications)下新建一个文件存储以下四个进程文件

start_gateway.php

  1. <?php 
  2. use \Workerman\Worker;
  3. use \Workerman\WebServer;
  4. use \GatewayWorker\Gateway;
  5. use \GatewayWorker\BusinessWorker;
  6. use \Workerman\Autoloader;
  8. // 自动加载类
  9. require_once __DIR__ . '/../../vendor/autoload.php';
  11. // gateway 进程，这里使用Text协议，可以用telnet测试
  12. $gateway = new Gateway("websocket://0.0.0.0:8283");
  13. // gateway名称，status方便查看
  14. $gateway->name = 'YourAppGateway';
  15. // gateway进程数
  16. $gateway->count = 200;
  17. // 本机ip，分布式部署时使用内网ip
  18. $gateway->lanIp = '127.0.0.1';
  19. // 内部通讯起始端口，假如$gateway->count=4，起始端口为4000
  20. // 则一般会使用4000 4001 4002 4003 4个端口作为内部通讯端口 
  21. $gateway->startPort = 2900;
  22. // 服务注册地址、端口
  23. $gateway->registerAddress = '127.0.0.1:1237';
  25. // 心跳间隔
  26. //$gateway->pingInterval = 10;
  27. // 心跳数据
  28. //$gateway->pingData = '{"type":"ping"}';
  30. /* 
  31. // 当客户端连接上来时，设置连接的onWebSocketConnect，即在websocket握手时的回调
  32. $gateway->onConnect = function($connection)
  33. {
  34.     $connection->onWebSocketConnect = function($connection , $http_header)
  35.     {
  36.         // 可以在这里判断连接来源是否合法，不合法就关掉连接
  37.         // $_SERVER['HTTP_ORIGIN']标识来自哪个站点的页面发起的websocket链接
  38.         if($_SERVER['HTTP_ORIGIN'] != 'http://kedou.workerman.net')
  39.         {
  40.             $connection->close();
  41.         }
  42.         // onWebSocketConnect 里面$_GET $_SERVER是可用的
  43.         // var_dump($_GET, $_SERVER);
  44.     };
  45. }; 
  46. */
  48. // 如果不是在根目录启动，则运行runAll方法
  49. if(!defined('GLOBAL_START'))
  50. {
  51.     Worker::runAll();
  52. }

start_businessworker.php

  1. <?php 
  2. use Workerman\Worker;
  3. use Workerman\WebServer;
  4. use GatewayWorker\Gateway;
  5. use GatewayWorker\BusinessWorker;
  6. use Workerman\Autoloader;
  8. // 自动加载类
  9. require_once __DIR__ . '/../../vendor/autoload.php';
  11. // bussinessWorker 进程
  12. $worker = new BusinessWorker();
  13. // worker名称
  14. $worker->name = 'YourAppBusinessWorker';
  15. // bussinessWorker进程数量
  16. $worker->count = 200;
  17. // 服务注册地址、端口
  18. $worker->registerAddress = '127.0.0.1:1237';
  20. // 如果不是在根目录启动，则运行runAll方法
  21. if(!defined('GLOBAL_START'))
  22. {
  23.     Worker::runAll();
  24. }

start_register.php

  1. <?php 
  2. use \Workerman\Worker;
  3. use \GatewayWorker\Register;
  5. // 自动加载类
  6. require_once __DIR__ . '/../../vendor/autoload.php';
  8. // register 必须是text协议 1237为端口
  9. $register = new Register('text://0.0.0.0:1237');
  11. // 如果不是在根目录启动，则运行runAll方法
  12. if(!defined('GLOBAL_START'))
  13. {
  14.     Worker::runAll();
  15. }

Events.php

  1. <?php
  3. use \GatewayWorker\Lib\Gateway;
  5. /**
  6.  * 主逻辑
  7.  * 主要是处理 onConnect onMessage onClose 三个方法
  8.  */
  9. class Events
  10. {
  11.     /**
  12.      * 当客户端连接时触发
  13.      * 
  14.      * @param int $client_id 连接id
  15.      */
  16.     public static function onConnect($client_id)
  17.     {
  18.         echo "【新的客户端链接】：client_id：".$client_id.PHP_EOL;
  19.         // 向当前client_id发送数据 
  20.         Gateway::sendToClient($client_id, "");
  21.         
  22.         // 向所有人发送
  23.         $data=[
  24.             'client_id'=>$client_id,
  25.             'message'=>'欢迎'.$client_id.'登录！',
  26.             'data'=>[]
  27.         ];
  28.         Gateway::sendToAll(json_encode($data));
  29.         // Gateway::sendToAll("$client_id login\r\n");
  30.     }
  31.     
  32.    /**
  33.     * 当客户端发来消息时触发
  34.     * @param int $client_id 连接id
  35.     * @param mixed $message 具体消息
  36.     */
  37.    public static function onMessage($client_id, $message){
  38.        
  39.        $data=[
  40.             'client_id'=>$client_id,
  41.             'message'=>$client_id.'说：'.$result['message'],
  42.             'data'=>$message
  43.         ];
  44.         Gateway::sendToAll(json_encode($data));
  45.         // 向所有人发送 
  46.         // Gateway::sendToAll("$client_id said $message\r\n");
  47.    }
  48.    
  49.    /**
  50.     * 当用户断开连接时触发
  51.     * @param int $client_id 连接id
  52.     */
  53.    public static function onClose($client_id)
  54.    {
  55.        // 向所有人发送 
  56.     //   GateWay::sendToAll("$client_id 退出了！\r\n");
  57.    }
  58. }

随后在项目的根目录下新建一个启动文件

start_all_workman.php

  1. <?php
  3. ini_set('display_errors', 'on');
  4. use Workerman\Worker;
  6. if(strpos(strtolower(PHP_OS), 'win') === 0)
  7. {
  8.     exit("start.php not support windows, please use start_for_win.bat\n");
  9. }
  11. // 检查扩展
  12. if(!extension_loaded('pcntl'))
  13. {
  14.     exit("Please install pcntl extension. See http://doc3.workerman.net/appendices/install-extension.html\n");
  15. }
  17. if(!extension_loaded('posix'))
  18. {
  19.     exit("Please install posix extension. See http://doc3.workerman.net/appendices/install-extension.html\n");
  20. }
  22. // 标记是全局启动
  23. define('GLOBAL_START', 1);
  25. require_once __DIR__ . '/vendor/autoload.php';
  27. // 加载所有Applications/*/start.php，以便启动所有服务
  28. foreach(glob(__DIR__.'/application/此处请改成你自己命名存放workman的目录名/start*.php') as $start_file)
  29. {
  30.     require_once $start_file;
  31. }
  32. // 运行所有服务
  33. Worker::runAll();

注意开启端口后记得去放行端口！！！除了宝塔放行以外，你的服务器(阿里云/腾讯云等等)也记得要去放行！！！

启动workman

在项目根目录下打开终端，输入php start_all_workman.php start -d ,开启守护进程，如果出现一下页面即成功开启

image

如想关闭workman进程则输入php start_all_workman.php stop 进行关闭

GatewayWorker使用

如果你的网站使用的是Https协议的话，WebSocket必须使用wss协议
但是wss协议不支持IP:端口的形式，而是只能写域名+url
所以为了解决使用https协议而WebSocket不能连接的问题，可以使用Nginx进行反向代理
在网站配置文件的server下加入以下代码

  1. location /connectWorkman(名字随你取，别跟其他反向代理重名就行)
  2.   {
  3.     proxy_pass http://127.0.0.1:8283;
  4.     proxy_http_version 1.1;
  5.     proxy_set_header Upgrade $http_upgrade;
  6.     proxy_set_header Connection "Upgrade";
  7.     proxy_set_header X-Real-IP $remote_addr;
  8.    }

前端使用(uniapp)

  1. init() {
  2. 	SocketTask = uni.connectSocket({
  3. 		url: 'wss://chat.gdpaimaihui.com/auction', //正式
  4. 		header: {
  5. 			'content-type': 'application/json'
  6. 		},
  7. 		success: function(res) {
  8. 			console.log('WebSocket连接创建', res);
  9. 		},
  10. 		fail: function(err) {
  11. 			uni.showToast({
  12. 				title: '网络异常！',
  13. 				icon: 'none'
  14. 			});
  15. 			console.log(err);
  16. 		}
  17. 	});
  19. 	//websocket监听事件
  20. 	SocketTask.onOpen((res) => {
  21. 		socketOpen = true
  22. 		canReconnect = true
  23. 		console.log('监听 WebSocket 连接打开事件。', res);
  24. 		//websocket连接后可以启动个定时器，每隔一段时间进行心跳一次，以防心跳停止断开连接
  25. 		this.timer = setInterval(() => {
  26. 			SocketTask.send({
  27. 				data: '心跳',
  28. 				success() {
  29. 					// console.log('发送心跳成功');
  30. 				}
  31. 			})
  32. 		}, 2000)
  33. 	});
  34. 	SocketTask.onError((onError) => {
  35. 		console.log('监听 WebSocket 错误。错误信息', onError);
  36. 		socketOpen = false;
  37. 		if (canReconnect) {
  38. 			this.reconnect()
  39. 			canReconnect = false
  40. 		}
  41. 	});
  43. 	SocketTask.onMessage((res) => {
  44. 		console.log('监听WebSocket接受到服务器的消息事件。服务器返回的消息', res);
  45. 	});
  46. },
  48. //重新连接
  49. reconnect() {
  50. 	if (!socketOpen) {
  51. 		let count = 0;
  52. 		reconnectInterval = setInterval(() => {
  53. 			console.log("正在尝试重连")
  54. 			uni.showToast({
  55. 				title: '正在尝试重连',
  56. 				icon: 'none'
  57. 			})
  58. 			this.init();
  59. 			count++
  60. 			console.log();
  61. 			//重连一定次数后就不再重连
  62. 			if (count >= reconnectTimes) {
  63. 				clearInterval(reconnectInterval)
  64. 				uni.showToast({
  65. 					title: '网络异常或服务器错误',
  66. 					icon: 'none'
  67. 				})
  68. 			}
  69. 		}, reconnectDelay)
  70. 	}
  71. }

上述为之前给公司做内部通讯软件时个人整理内容，水平有限，如有错误之处，望各位园友不吝赐教！如果觉得不错，请点击推荐和关注！谢谢~??????? [鲜花][鲜花][鲜花]

原文链接：https://www.cnblogs.com/nothavebug/p/18286356

 友情链接：直通硅谷 　点职佳 　北美留学生论坛

PHP热门文章

  • 收藏了8年的PHP优秀资源，都给你整理好了
  • php对微信支付回调处理的方法（合集）
  • 聊聊TCP连接耗时的那些事儿
  • php如何比较两个浮点数是否相等详解
  • PHP实现PDO操作mysql存储过程示例
  • 富文本编辑器新增导入word功能，自动转为html，可直接显示图片
  • curl put方式上传文件
  • thinkphp3.2模块名如何不区分大小写?
  • php去掉字符串的最后一个字符
  • WebSocket 长连接 及超时问题解决

    • PHP推荐文章

  • 【workerman】uniapp+thinkPHP5使用GatewayWorker实现实时通讯
  • PHP转Go系列 | ThinkPHP与Gin框架之API接口签名设计实践
  • MagicArray:像php一样，让Go业务代码不再卷！
  • 2023年的PHP项目部署笔记。什么？还有人用PHP？
  • [CTF/Web] PHP 反序列化学习笔记
  • PHP的序列化和反序列化入门
  • 详解PHP实现HTTP服务器过程
  • 高效率开发Web安全扫描器之路（一）
  • PHP实现微信扫码登录功能的两种方式总结
  • PHP内存溢出的解决方法详解

    • 本站QQ群：前端 618073944 | Java 606181507 | Python 626812652 | C/C++ 612253063 | 微信 634508462 | 苹果 692586424 | C#/.net 182808419 | PHP 305140648 | 运维 608723728

    W3xue 的所有内容仅供测试，对任何法律问题及风险不承担任何责任。通过使用本站内容随之而来的风险与本站无关。
    关于我们  |  意见建议  |  捐助我们  |  报错有奖  |  广告合作、友情链接（目前9元/月）请联系QQ：27243702 沸活量
    皖ICP备17017327号-2　皖公网安备34020702000426号