thinkphp5.0整合phpsocketio完整攻略(绕坑)
PHPSocket.IO是基于workerman开发的php版本的socket.IO服务。可用于服务器消息的推送、聊天室、客服系统的开发
使用环境: thinkphp5.0
项目需求
前端下单,后台接受,并立即做出提示。例如:美团外卖,客户端下单成功后,商家端就会立即有接单语音提示。
开发环境
- thinkphp5.0
- phpsocketio
(由于需要启动socket服务,所以需在能够满足shell的环境下使用)
socketio 优势
这里只是我的观点,毕竟没有怎么深入研究socketio,所以只是浅显的一点总结:
- 减小服务器IO负载
- 长连接比ajax轮询靠谱
- 服务稳定,支持动态
初略的看了一下,内存占用很小,而且只有1个进程,根据官方报道来说1个进程也能容纳1W人次的高并发,所以,对于我的项目来说,已经绰绰有余
官方文档
https://github.com/walkor/phpsocket.io
开始开发
安装 phpsocketio
首先cd到thinkphp的项目根目录。使用以下命令
composer require workerman/phpsocket.io
( 这里composer不做解释,如果有什么问题,度娘一下,应该能够解决 )
安装好以后,vendor文件夹下面应该就有一个workerman的文件夹,如果存在,就恭喜你,已经安装完毕了
服务入口文件
回到项目根目录,新建server.php,开始编辑
#!/usr/bin/env php <?php define('APP_PATH', __DIR__ . '/application/'); define('BIND_MODULE','socketio/Server/index'); // 加载框架引导文件 require __DIR__ . '/thinkphp/start.php';
这里只要写好就OK。后续的所有东西,可以忽略他的存在
创建服务控制器
上一步的server.php文件里面,模块绑定到了'socketio/Server/index',这里就需要我们手动创建了。为了能理解,我用目录展示
├─application 应用目录 │ ├─socketio 新创建目录 │ │ ├─controller │ │ │ ├─Server.php 启动文件
Server.php
入口文件只是绑定到了这个控制器,所以这个是整个socketio的核心。
<?php /* * (c) U.E Dream Development Studio * * Author: 李益达 - Ekey.Lee <[email protected]> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace app\socketio\controller; require_once VENDOR_PATH . "workerman/phpsocket.io/src/autoload.php"; use PHPSocketIO\SocketIO; use Workerman\Worker; class Server { public function index() { $io = new SocketIO(8080);//socket的端口 $io->on('workerStart', function () use ($io) { $inner_http_worker = new Worker('http://0.0.0.0:5880');//这里IP不用改变,用的内网通讯,端口不能与socket端口想通 $inner_http_worker->onMessage = function ($http_connection, $data) use ($io) { $io->emit('new_msg', '44444');//这里写了固定数据,请根据自己项目需求去做调整,不懂这里的可以看看官方文档,很清楚 $http_connection->send('ok'); }; $inner_http_worker->listen(); }); // 当有客户端连接时 $io->on('connection', function ($socket) use ($io) { // 定义chat message事件回调函数 $socket->on('chat message', function ($msg) use ($io) { // 触发所有客户端定义的chat message from server事件 $io->emit('chat message from server', $msg); }); }); Worker::runAll(); } }
创建API 触发socketio
同样你可以在socketio下面新建一个API控制器,这里仅供测试
public function api() { // 推送的url地址,使用自己的服务器地址 $push_api_url = "http://0.0.0.0:5880";//这里同样不需要更改IP。只是端口一定需要和server.php onworker的一样 $post_data = array( "type" => "publish", "content" => "这个是推送的测试数据", ); $ch = curl_init (); curl_setopt ( $ch, CURLOPT_URL, $push_api_url ); curl_setopt ( $ch, CURLOPT_POST, 1 ); curl_setopt ( $ch, CURLOPT_HEADER, 0 ); curl_setopt ( $ch, CURLOPT_RETURNTRANSFER, 1 ); curl_setopt ( $ch, CURLOPT_POSTFIELDS, $post_data ); curl_setopt ($ch, CURLOPT_HTTPHEADER, array("Expect:")); $return = curl_exec ( $ch ); curl_close ( $ch ); var_export($return); }
现在有了server服务端,API触发端,接下来就需要显示出来了,就是我们的前端
前端
现在要写的就是,商家端收到的提示。之前写的server服务端提供phpsocketio监控与socket服务,API提供事件触发,也就是有人下单后的触发,下单作为事件去触发服务器socket,让他回应到前端
代码开始前请注意:这里的端口和域名比较的绕
<script src='//cdn.bootcss.com/socket.io/1.3.7/socket.io.js'></script> <script> // 连接服务端 var socket = io('http://xxxx.com:8080');//这里请填写你的域名,外网,端口为socket端口 // 后端推送来消息时 socket.on('new_msg', function (msg) {//这里的new_msg请一定要注意,官方文档都写的是content,但是后端发送的自定义是new_msg,后端定义成new_msg,前端却接受content的字段。所以是接受不了的 swal({ title: "包厢点餐提醒", text: "哆啦a梦包厢有新订单" }) //console.log("收到消息:" + msg); }); </script>
以上有两个我之前出问题的地方
- 端口与域名:域名是外网的域名,当然是需要和你的socket服务在同一个IP下面,即:你的socket部署在114.114.114.114的IP下面。这个域名就必须是在114.114.114.114的IP下面。端口则是后端服务里面new SocketIO的端口了。
- socket.on()文档里面都是socket.on('content',function(msg){....}),但是可以看我们Server.php里面$io->emit('new_msg', '');这里自定义的事件明明叫做new_msg,但是却被写成了content,可能是本人眼拙,没有看清楚,但是也提醒一下,这里确实要注意回调事件名
部署完毕开始运行
现在所有的文件就算是部署好了,进入服务器管理,打开shell。cd到项目根目录。然后执行php server.php start
php server.php start 启动
php server.php stop 停止
php server.php restart 重启
php server.php status 当前服务状态
总结
这次只作为工作总结,因为时间紧迫我也没有好好去研究socketio的更多东西,可能有些地方有纰漏,但是我100%保证这是本人亲自测试,所提到的坑点,都是我一步一步踩过去的。如果有说错的欢迎指教 ^_^