easyswoole 搭建消息队列服务04 - websocket原理剖析与实践

PHP的扩展和依赖

说swoole之前，先说说鸟哥扩展的yaf，yaf是一个用C语言写的PHP标准扩展，它之所以可以直接超高的并发是因为在启动前提前编译，常驻内存，节省内存开销，已获得高性能的特点。

而swoole之所以更进一步的做到高性能，是因为它是一种特别的PHP扩展，根本的不用在于接管了php-fpm管理php运行的新模式，用自己的底层去管理php的进程，并且支持了TCP、UDP、WebSocket等网络服务，给PHP的未来提供了新的活力，swoole是一种不标准的，支持TCP、UDP、WebSocket的PHP扩展。

easyswoole就是给想学习swoole的人放低了门槛和学习成本，很感谢走在前面探索的大神s，遇到困难不要怕，因为总有人走在前面，只要你肯学习和寻找。

在后面的接触中有接触到了一个hyperf框架，也是基于swoole上开发的，等有时间在去学习和实践，拥有了composer和swoole的PHP已经发生了根本性的突破，依赖和扩展可能对刚入门的同学来说确实有难度，需要加以学习。

WebSocket 消息推送

大家都知道，Http协议非常方便快捷，但是随着时间的发展，Http也发现了一些弱点，通信只能由客户端发起。

而WebSocket协议的它的最大特点就是，服务器可以主动向客户端推送信息，客户端也可以主动向服务器发送信息，是真正的双向平等对话，属于服务器推送技术的一种。协议ws:或者wss:。

ws://127.0.0.1:9501/index/hello

使用 easyswoole 开发 websocket 之前的话

PHP作为web开发语言来说，刚刚接触控制台会显得有点不那么适应，很少有人用php实现websocket通讯，因为在PHP中，从socket的连接、建立、绑定、监听等都需要开发者自己去操作完成。

这里有几个在easyswoole里开发的坑，在这里总结一下：

1.echo，var_dump 或者直接打印的输出，会输出在控制台里，不会在请求端返回，区分响应和返回值, EasySwoole\Http\AbstractInterface\Controller。

protected function writeJson($statusCode = 200, $result = null, $msg = null)
{
    
    if (!$this->response()->isEndResponse()) {
    
        $data = Array(
            "code" => $statusCode,
            "result" => $result,
            "msg" => $msg
        );
        $this->response()->write(json_encode($data, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES));
        $this->response()->withHeader('Content-type', 'application/json;charset=utf-8');
        $this->response()->withStatus($statusCode);
        return true;
    } else {
    
        return false;
    }
}

2.代码里不用使用 die() exit() 函数，会出现swoole exit,这个错误，是因为swoole里遇见这个函数，就释放掉了当前进程。

3.习惯于开发web 应用程序的PHP程序员，不自觉的用浏览器去请求ws协议，应该去websocket的测试工具，浏览器虽然支持ws，协议有区别，不能直接请求。

4.easyswoole 提供了两个系统魔术方法 onRequest 和 onException，用于路由初始化和捕获异常处理。

protected function onRequest(?string $action): ?bool
{
    
    echo ' #### 内存大小 '.(memory_get_usage()/1024/1024).'MB ####'.PHP_EOL;
    //接收参数
    $this->params = $this->request()->getRequestParam();
    return true;
}

function onException(\Throwable $throwable): void
{
    
    $message  = $throwable->getMessage();
    $logLevel = Logger::LOG_LEVEL_ERROR;
    $category = 'Exception';
    //记录error级别日志并输出到控制台
    Logger::getInstance()->error( $message,$category);
	 //写入错误日志的回调函数
    Logger::getInstance()->onLog()->set('notify',  function ( $message,$logLevel,$category )  use ( $throwable ) {
    
        //通知告警邮件
        //SendMall::send( $message );
    } );

}

5.redis 新版本分布式锁的使用，我感觉很好，一起总结在这里。

redis 127.0.0.1:6379> SET KEY VALUE [EX seconds] [PX milliseconds] [NX|XX]

• EX seconds − 设置指定的到期时间(以秒为单位)。
• PX milliseconds - 设置指定的到期时间(以毫秒为单位)。
• NX - 仅在键不存在时设置键。
• XX - 只有在键已存在时才设置。

protected function cacheToken($token,$user_id){
    
    $redis=\EasySwoole\Pool\Manager::getInstance()->get('redis')->getObj();
    $redis->select(1);

    $auth_token = $redis->get('auth_token:'.$user_id );

    if(isset($auth_token) && !empty($auth_token)){
    
        return $auth_token;
    }
    echo 'this is token:'.$token.PHP_EOL;
    $redis->set('auth_token:'.$user_id , $token, ['NX','EX'=> $this->cacheTime ]);
}

Ws的代码实践

step1 .注册ws组件

文件位置：EasySwoole\EasySwoole\EasySwooleEvent的mainServerCreate注册

// websocket
if (CommandManager::getInstance()->getOpt('mode') === 'websocket') {
    
    $config = new \EasySwoole\Socket\Config();
    $config->setType($config::WEB_SOCKET);
    $config->setParser(WebSocketParser::class);
    $dispatcher = new Dispatcher($config);
    $config->setOnExceptionHandler(function (\Swoole\Server $server, \Throwable $throwable, string $raw, WebSocket $client, Response $response) {
    
        $response->setMessage('system error!');
        $response->setStatus($response::STATUS_RESPONSE_AND_CLOSE);
    });
    $register->set($register::onMessage, function (\Swoole\Websocket\Server $server, \Swoole\Websocket\Frame $frame) use ($dispatcher) {
    
        $dispatcher->dispatch($server, $frame->data, $frame);
    });
}

step2. 解析器才是关键的步骤

自定义文件位置，App\Parser\WebSocketParser,部分代码

public function decode($raw, $client): ?Caller
{
    
    $data = json_decode($raw, true);
    $caller = new Caller();
    $controller = !empty($data['controller']) ? $data['controller'] : 'Index';
    $action = !empty($data['action']) ? $data['action'] : 'index';
    $param = !empty($data['params']) ? $data['params'] : [];
    $controller = "App\\WebsocketController\\{
      $controller}";
    $caller->setControllerClass($controller);
    $caller->setAction($action);
    $caller->setArgs($param);
    return $caller;
}

step3. Contrller编写

function hello()
{
    
    $fd = $this->caller()->getClient()->getFd();
    echo '$fd 是客户端的链接ID'.$fd;
    $message  = 'call hello with arg:'. json_encode($this->caller()->getArgs()) ;
    $this->response()->setMessage($message);
}