easyswoole框架之websocket服务的简单使用

本篇博文相关环境版本如下：

OS系统：CentOS Linux release 7.7

php版本：PHP 7.2.24

swoole版本：4.4.14

easyswoole版本：3.3.4

easyswoole框架的介绍及安装

......忽略N多字，可自行移步至官网了解。

我这里整合的目录结构如下：

①、修改项目根目录下配置文件dev.php，修改SERVER_TYPE为:EASYSWOOLE_WEB_SOCKET_SERVER，示例dev.php文件内容如下：

<?php

return [
    'SERVER_NAME' => "EasySwoole",
    'MAIN_SERVER' => [
        'LISTEN_ADDRESS' => '0.0.0.0',
        'PORT' => 9501,
        'SERVER_TYPE' => EASYSWOOLE_WEB_SOCKET_SERVER, //默认为：EASYSWOOLE_WEB_SERVER，可选为 EASYSWOOLE_SERVER  EASYSWOOLE_WEB_SERVER EASYSWOOLE_WEB_SOCKET_SERVER,EASYSWOOLE_REDIS_SERVER
        'SOCK_TYPE' => SWOOLE_TCP,
        'RUN_MODEL' => SWOOLE_PROCESS,
        'SETTING' => [
            'worker_num' => 8,
            'reload_async' => true,
            'max_wait_time'=>3
        ],
        'TASK'=>[
            'workerNum'=>4,
            'maxRunningNum'=>128,
            'timeout'=>15
        ]
    ],
    'TEMP_DIR' => null,
    'LOG_DIR' => null
];

②、创建自定义的websocket消息解析类（这里我们只处理并解析json格式类型的数据），创建App/WebSocket/WebSocketParser.php文件。WebSocketParser.php文件中的内容如下：

<?php

namespace App\WebSocket;

use EasySwoole\Socket\AbstractInterface\ParserInterface;
use EasySwoole\Socket\Client\WebSocket;
use EasySwoole\Socket\Bean\Caller;
use EasySwoole\Socket\Bean\Response;

/**
 * Class WebSocketParser
 *
 * 此类是自定义的 websocket 消息解析器
 * 此处使用的设计是使用 json string 作为消息格式
 * 当客户端消息到达服务端时，会调用 decode 方法进行消息解析
 * 会将 websocket 消息 转成具体的 Class -> Action 调用 并且将参数注入
 *
 * @package App\WebSocket
 */
class WebSocketParser implements ParserInterface
{
    /**
     * decode
     * @param  string         $raw    客户端原始消息
     * @param  WebSocket      $client WebSocket Client 对象
     * @return Caller         Socket  调用对象
     */
    public function decode($raw, $client) : Caller
    {
        // 解析 客户端原始消息
        $data = json_decode($raw, true);

        if (!is_array($data))
        {
            echo "decode message error! \n";
            return null;
        }

        // new 调用者对象
        $caller = new Caller();

        /**
         * 设置被调用的类 这里会将ws消息中的 class 参数解析为具体想访问的控制器
         * 如果更喜欢 event 方式 可以自定义 event 和具体的类的 map 即可
         * 注 目前 easyswoole 3.0.4 版本及以下 不支持直接传递 class string 可以通过这种方式
         */
        $class = '\\App\\WebSocket\\'. ucfirst($data['class'] ?? 'Index');

        $caller->setControllerClass($class);

        // 设置被调用的方法
        $caller->setAction($data['action'] ?? 'index');

        // 检查是否存在args
        if (!empty($data['params']))
        {
            //params无法解析为array时 返回 params => string 格式
            $args = is_array($data['params']) ? $data['params'] : ['params' => $data['params']];
        }

        // 设置被调用的Args
        $caller->setArgs($args ?? []);

        return $caller;
    }

    /**
     * 下面中的 : ? string 这里的 ? 表示返回值可以是null类型 而不是必须只能返回string类型
     * encode
     * @param  Response     $response Socket    Response 对象
     * @param  WebSocket    $client   WebSocket Client   对象
     * @return string       发送给客户端的消息
     */
    public function encode(Response $response, $client) : ? string
    {
        /**
         * 这里返回响应给客户端的信息
         * 这里应当只做统一的encode操作 具体的状态等应当由 Controller处理
         */
        return $response->getMessage();
    }
}

③、创建websocket相关的处理事件类，如：通过websocket协议连接上服务之后需要验证是否是一个合法连接（触发握手事件）、以及客户端和服务端之间的连接被关闭了（触发连接关闭事件）等。创建App/WebSocket/WebSocketEvent.php文件。WebSocketEvent.php文件中的内容如下（注：这一步骤不是非必须的，自己看情况决定是否执行这一步骤）：

<?php

namespace App\WebSocket;

/**
 * Class WebSocketEvent
 *
 * 此类是 WebSocet 中一些非强制的自定义事件处理
 *
 * @package App\WebSocket
 */
class WebSocketEvent
{
    /**
     * 握手事件
     *
     * @param \swoole_http_request  $request
     * @param \swoole_http_response $response
     * @return bool
     */
    public function onHandShake(\swoole_http_request $request, \swoole_http_response $response)
    {
        /** 此处自定义握手规则 返回 false 时中止握手 */
        if (!$this->customHandShake($request, $response)) {
            $response->end();
            return false;
        }
        /** 此处是  RFC规范中的WebSocket握手验证过程 必须执行 否则无法正确握手 */
        if ($this->secWebsocketAccept($request, $response)) {
            $response->end();
            return true;
        }
        $response->end();
        return false;
    }
    /**
     * 自定义握手事件
     *
     * @param \swoole_http_request  $request
     * @param \swoole_http_response $response
     * @return bool
     */
    protected function customHandShake(\swoole_http_request $request, \swoole_http_response $response): bool
    {
        /**
         * 这里可以通过 http request 获取到相应的数据
         * 进行自定义验证后即可
         * (注) 浏览器中 JavaScript 并不支持自定义握手请求头 只能选择别的方式 如get参数
         */
        $headers = $request->header;
        $cookie = $request->cookie;
        // if (如果不满足我某些自定义的需求条件，返回false，握手失败) {
        //    return false;
        // }
        return true;
    }
    /**
     * 关闭事件
     *
     * @param \swoole_server $server
     * @param int            $fd
     * @param int            $reactorId
     */
    public function onClose(\swoole_server $server, int $fd, int $reactorId)
    {
        /** @var array $info */
        $info = $server->getClientInfo($fd);

        print_r($info);

        /**
         * 判断此fd 是否是一个有效的 websocket 连接
         * 参见 https://wiki.swoole.com/wiki/page/490.html
         */
        if ($info && $info['websocket_status'] === WEBSOCKET_STATUS_FRAME) 
		{
            /**
             * 判断连接是否是 server 主动关闭
             * 参见 https://wiki.swoole.com/wiki/page/p-event/onClose.html
             */
            if ($reactorId < 0) {
                echo "server close \n";
            }
        }
    }
    /**
     * RFC规范中的WebSocket握手验证过程
     * 以下内容必须强制使用
     *
     * @param \swoole_http_request  $request
     * @param \swoole_http_response $response
     * @return bool
     */
    protected function secWebsocketAccept(\swoole_http_request $request, \swoole_http_response $response): bool
    {
        // ws rfc 规范中约定的验证过程
        if (!isset($request->header['sec-websocket-key'])) 
		{
            // 需要 Sec-WebSocket-Key 如果没有拒绝握手
            var_dump('shake fai1 3');
            return false;
        }
		
        if (0 === preg_match('#^[+/0-9A-Za-z]{21}[AQgw]==$#', $request->header['sec-websocket-key'])
            || 16 !== strlen(base64_decode($request->header['sec-websocket-key']))
        ) {
            //不接受握手
            //var_dump('shake fai1 4');
            return false;
        }
        
		$key = base64_encode(sha1($request->header['sec-websocket-key'] . '258EAFA5-E914-47DA-95CA-C5AB0DC85B11', true));
        
		$headers = array(
            'Upgrade'               => 'websocket',
            'Connection'            => 'Upgrade',
            'Sec-WebSocket-Accept'  => $key,
            'Sec-WebSocket-Version' => '13',
            'KeepAlive'             => 'off',
        );
		
        if (isset($request->header['sec-websocket-protocol'])) 
		{
            $headers['Sec-WebSocket-Protocol'] = $request->header['sec-websocket-protocol'];
        }
		
        // 发送验证后的header
        foreach ($headers as $key => $val) 
		{
            $response->header($key, $val);
        }
		
        // 接受握手 还需要101状态码以切换状态
        $response->status(101);
		
        //var_dump('shake success at fd :' . $request->fd);
		
        return true;
    }
}

④、注册服务，这里是指注册你上面实现的自定义的websocket消息解析类。在根目录下EasySwooleEvent.php文件mainServerCreate方法下加入以下代码，我这里已经加过了，就不重复添加了。我这里的EasySwooleEvent.php文件中的内容如下：

<?php

namespace EasySwoole\EasySwoole;


use EasySwoole\EasySwoole\Swoole\EventRegister;
use EasySwoole\EasySwoole\AbstractInterface\Event;
use EasySwoole\Http\Request;
use EasySwoole\Http\Response;
use EasySwoole\Socket\Dispatcher;
use App\WebSocket\WebSocketParser;
use App\WebSocket\WebSocketEvent;

class EasySwooleEvent implements Event
{

    public static function initialize()
    {
        // TODO: Implement initialize() method.
        date_default_timezone_set('Asia/Shanghai');
    }

    public static function mainServerCreate(EventRegister $register) : void
    {
        // TODO: Implement mainServerCreate() method.

        /**
         * **************** websocket控制器 **********************
         */

        //创建一个 Dispatcher 配置
        $conf = new \EasySwoole\Socket\Config();

        //设置Dispatcher为WebSocket 模式
        $conf->setType(\EasySwoole\Socket\Config::WEB_SOCKET);

        //设置解析器对象
        $conf->setParser(new WebSocketParser());

        //创建Dispatcher对象并注入config对象
        $dispatch = new Dispatcher($conf);

        //给server注册相关事件在WebSocket模式下onMessage事件必须注册 并且交给Dispatcher对象处理
        $register->set(EventRegister::onMessage, function (\swoole_websocket_server $server, \swoole_websocket_frame $frame) use ($dispatch) {

            $dispatch->dispatch($server, $frame->data, $frame);

        });

        //自定义握手事件
        $websocketEvent = new WebSocketEvent();

        //自定义关闭事件
        $register->set(EventRegister::onClose, function (\swoole_server $server, int $fd, int $reactorId) use ($websocketEvent) {
            $websocketEvent->onClose($server, $fd, $reactorId);
        });

    }

    public static function onRequest(Request $request, Response $response): bool
    {
        // TODO: Implement onRequest() method.
        return true;
    }

    public static function afterRequest(Request $request, Response $response): void
    {
        // TODO: Implement afterAction() method.
    }
}

⑤、创建WebSocket的控制器，WebSocket控制器必须继承EasySwoole\Socket\AbstractInterface\Controller。创建App/WebSocket/Index.php文件，Index.php文件中的内容如下：

<?php

namespace App\WebSocket;

use EasySwoole\EasySwoole\ServerManager;
use EasySwoole\EasySwoole\Task\TaskManager;
use EasySwoole\Socket\AbstractInterface\Controller;


/**
 * Class Index
 *
 * 此类是默认的 websocket 消息解析后访问的 控制器
 *
 * @package App\WebSocket
 */
class Index extends Controller
{
    public function hello()
    {
        $this->response()->setMessage('call hello with arg:'. json_encode($this->caller()->getArgs()));
    }

    public function who()
    {
        $this->response()->setMessage('your fd is '. $this->caller()->getClient()->getFd());
    }

    public function index()
    {
        //$this->response()->setMessage('你的fd是：'. $this->caller()->getClient()->getFd());

        //print_r($this->caller());

        //echo PHP_EOL;

        //print_r($this->caller()->getArgs());

        print_r($this->caller()->getArgs()); //获取参数

        echo PHP_EOL;

        //print_r(ServerManager::getInstance()->getSwooleServer());
    }

    public function delay()
    {
        $this->response()->setMessage('this is delay action');
        $client = $this->caller()->getClient();

        // 异步推送, 这里直接 use fd也是可以的
        TaskManager::getInstance()->async(function () use ($client){

            $server = ServerManager::getInstance()->getSwooleServer();

            $i = 0;

            while ($i < 5)
            {
                sleep(1);
                $server->push($client->getFd(),'push in http at '. date('H:i:s'));
                $i++;
            }

        });
    }

    /*
   * HTTP触发向某个客户端单独推送消息
   * @example http://ip:9501/WebSocketTest/push?fd=2
   */
    public function push()
    {
        $fd = $this->request()->getRequestParam('fd');

        if(is_numeric($fd))
        {
            /** @var \swoole_websocket_server $server */
            $server = ServerManager::getInstance()->getSwooleServer();
            $info   = $server->getClientInfo($fd);

            if($info && $info['websocket_status'] == WEBSOCKET_STATUS_FRAME)
            {
                $server->push($fd, 'http push to fd ' . $fd . ' at ' . date('H:i:s'));
            }
            else
            {
                $this->response()->write("fd {$fd} is not exist or closed");
            }
        }
        else
        {
            $this->response()->write("fd {$fd} is invalid");
        }
    }

    /**
     * 使用HTTP触发广播给所有的WS客户端
     *
     * @example http://ip:9501/WebSocketTest/broadcast
     */
    public function broadcast()
    {
        /** @var \swoole_websocket_server $server */
        $server = ServerManager::getInstance()->getSwooleServer();
        $start = 0;

        // 此处直接遍历所有FD进行消息投递
        // 生产环境请自行使用Redis记录当前在线的WebSocket客户端FD
        while(true)
        {
            $conn_list = $server->connection_list($start, 10);

            if(empty($conn_list))
            {
                break;
            }

            $start = end($conn_list);

            foreach ($conn_list as $fd)
            {
                $info = $server->getClientInfo($fd);

                /** 判断此fd 是否是一个有效的 websocket 连接 */
                if($info && $info['websocket_status'] == WEBSOCKET_STATUS_FRAME)
                {
                    $server->push($fd, 'http broadcast fd ' . $fd . ' at ' . date('H:i:s'));
                }
            }
        }
    }
}

测试websocket服务

首先在根目录运行以下命令，开启easyswoole服务

php easyswoole start

如果没有错误此时已经启动了easyswoole服务。示例截图如下：

easyswoole官方提供了一个在线测试websocket的工具，地址：http://www.easyswoole.com/wstool.html

1、在打开的页面中输入websocket服务地址：ws://ip:9501 然后点击开启连接

2、连接成功后，在需要发送到服务端的内容这个文本框，输入我们通过websocket协议要发送到服务端的json格式的字符串类型的数据，示例：{"class":"Index","action":"index","params":{"name":"wzyl"}} 注：这里的class表示服务端要到哪一个controller去处理（这里是表示要到Index这个控制器去处理），这里的action表示服务端要到controller下的哪一个方法去处理相关逻辑（这里是表示要到Index这个控制器下的index方法去处理相关业务逻辑）。如果客户端不传class和action的话，那class和action默认的就是Index,index

3、看服务端是否成功接收到了客户端传输的json数据，示例截图如下：

通过上图可知，服务端成功接收到了客户端传输的数据。至此。。搞定。。只是一个使用示例，可以根据自己的业务场景修改为适合自己的。可以和相关app（Android、IOS等任何客户端）合作，开发一个QQ或者微信。。万一颠覆了呢。。。。或者给自己公司开发一个即时通讯软件用于自己的产品等。

easyswoole框架的websocket的大概处理流程

1、easyswoole服务启动（启动的时候会注册相关服务等操作）

2、client连接上服务端

3、client发送json数据到服务端（client根据情况选择是否指定class和action）--->服务端通过自己创建的消息解析类（即本文中的：App/WebSocket/WebSocketParser.php文件）解析client发送的数据，并指定哪一个controller和action来处理接下来的相关业务逻辑，如果client发送的数据中包含class和action 则服务端的消息解析类会调用对应的controller和action处理接下来的业务，如果client发送的数据中不指定class和action，则服务端的消息解析类会默认调用Index控制器中的index方法

4、服务端调用相关控制器中的相关方法处理业务逻辑

5、业务逻辑处理完毕，服务端发送（响应）数据给client