add readme

Author: xiaochengfu

README.md

@@ -1,11 +1,91 @@
 # websocket-Swoole php框架扩展
 
-扩展内容主要包括:
+> ## 扩展说明
 
-二.websocket通信
-本扩展以websocket为基础服务,所以可以处理websocket的请求,多客户端连接通信,通过自定义命令来实时处理业务
+基于swoole开发的websocket实时推送、主动推送、长连接扩展，应用于php的各类框架，如thinkphp,yii2,laravel等
 
-三.基于websocket的实时推送
-服务端有消息变更时,通过向客户端推送消息,来达到消息的同步和实时反馈``
+> ## 如何使用
 
+## 安装
+
+```php
+composer require xiaochengfu/swoole-websocket
+```
+
+## 配置
+
+1.将params_swoole.php.default配置文件放到你框架配置文件夹下
+推荐放到config下：
+```sh
+laravel、thinkphp5/6放到config目录下
+
+yii2放到common/config目录下
+
+```
+2.修改配置文件
+
+如何修改，配置文件中有具体说明
+
+## 启动
+
+根据每个框架的自定义命令，设置对应的指令即可，以启动为例
+
+```php
+$setting = config('params.swoole');//框架获取配置的方法，各有不同
+
+$swoole = new SwooleService($setting);
+$swoole->serviceStart();
+```
+扩展支持
+
+a.启动服务 serviceStart
+
+b.查看服务状态 serviceStats
+
+c.查看进程列表 serviceList
+
+d.停止服务 serviceStop
+
+## 场景测试
+
+1.连接socket
+
+访问`http://www.websocket-test.com`，输入ip:9512，进行连接测试
+
+2.测试推送
+
+推送通过http请求触发，在你要触发推送的action中，添加
+```php
+$swoole = new \xiaochengfu\swoole\Swoole(config('params.swoole'));
+$swoole->pushMsg(1,['hello','world']);
+
+//注意pushMsg($fd,$data)
+//fd 这里可用刚连接的客户端1
+//data 类型为数组
+
+```
+正确的话，你将在刚连接的浏览器客户端中接收到推送消息
+
+3. 测试实时消息通信
+
+这里采用callback回调的方式，可灵活的嵌入逻辑，只需要把`SwooleCallback.php`
+文件放到vendor外的任何地方，通过修改命名空间来访问，这里仅把SwooleCallback.php文件当作测试回调文件!
+
+客户端发送消息格式如下：
+```json
+{"data":{"namespace":"xiaochengfu\\swoole\\SwooleCallback","function":"test","params":{"a":1}}}
+```
+---敲黑板---
+
+a.发送的消息必须为字符串
+
+b.格式说明
+
+`namespace` 为回调文件的名字空间
+
+`function` 为回调文件内的方法，必须为静态方法
+
+`params` 为方法的参数
+
+正确的话，socket客户端将立即收到服务端返回的消息
 

params_swoole.php.default.php

@@ -5,25 +5,25 @@
  */
 return [
     'swoole' => [
-        'host' => 'ip',        //服务启动IP
-        'port' => '9512',            //服务启动端口
-        'swoole_http' => 'ip:9512',//推送触发连接地址
+        'host' => '127.0.0.1',        //服务启动IP,本地不要写localhost
+        'port' => 9512,            //服务启动端口
+        'swoole_http' => '127.0.0.1:9512',//推送触发连接地址
         'process_name' => 'swooleWebSocket',        //服务进程名
-        'open_tcp_nodelay' => '1',                //启用open_tcp_nodelay
+        'open_websocket_close_frame' => true,    //开启后，可在WebSocketServer中的onMessage回调中接收到客户端或服务端发送的关闭帧
+        'open_tcp_nodelay' => 1,                //启用open_tcp_nodelay
         'daemonize' => false,                //守护进程化
-        'heartbeat_idle_time' => 180,               //客户端向服务端请求的间隔时间
-        'heartbeat_check_interval' => 120,          //服务端向客户端发送心跳包的间隔时间，两参数要配合使用
-        'dispatch_mode' =>3,                        //抢占模式
-        'reactor_num' => 2,
-        'worker_num' => '5',                //work进程数目
-        'task_worker_num' => '5',                //task进程的数量
-        'task_max_request' => '10000',            //work进程最大处理的请求数
-        'max_connection' => '10000',
-//        'client_timeout'   => '20',
-        'pidfile' => Env::get('runtime_path') . 'swoole/yii2-swoole.pid',//
-        'log_dir' => Env::get('runtime_path') . 'swoole',
-        'task_tmpdir' => Env::get('runtime_path') . 'swoole',
-        'log_file' => Env::get('runtime_path') . 'swoole/swoole.log',
+        'heartbeat_idle_time' => 70,               //连接最大的空闲时间 （如果最后一个心跳包的时间与当前时间之差超过这个值，则认为该连接失效,建议 heartbeat_idle_time 为 heartbeat_check_interval 的两倍多一点）
+        'heartbeat_check_interval' => 30,          //服务端向客户端发送心跳包的间隔时间，两参数要配合使用
+        'dispatch_mode' => 4,                        //抢占模式
+        'reactor_num' => 4,               //master进程创建的线程,mac中通过htop查看不到reactor线程
+        'worker_num' => 8,                //work进程数目，cpu核数的1-4倍
+        'task_worker_num' => 1,                //task进程的数量
+        'task_max_request' => 10000,            //work进程最大处理的请求数
+        'max_connection' => 10000,              //服务器程序，最大允许的连接数
+        'pidfile' => \think\facade\Env::get('runtime_path') . 'swoole/swoole.pid',//
+        'log_dir' => \think\facade\Env::get('runtime_path') . 'swoole',
+        'task_tmpdir' => \think\facade\Env::get('runtime_path') . 'swoole',
+        'log_file' => \think\facade\Env::get('runtime_path') . 'swoole/swoole.log',
         'log_size' => 204800000,       //运行时日志 单个文件大小
     ],
 ];

src/SwooleCallback.php

@@ -0,0 +1,25 @@
+<?php
+/**
+ * Name: SwooleCallback.php.
+ * Author: hp <xcf-hp@foxmail.com>
+ * Date: 2019-12-03 18:15
+ * Description: SwooleCallback.php.
+ */
+
+namespace xiaochengfu\swoole;
+
+
+class SwooleCallback
+{
+    /**
+     * Description:  实时推送回调测试
+     * Author: hp <xcf-hp@foxmail.com>
+     * @param $server
+     * @param $fid
+     * @param $data
+     */
+    public static function test($server,$fid,$data){
+         //实时回应
+         $server->push($fid,json_encode($data));
+    }
+}