Socket

安装

composer require easyswoole/socket

独立使用

此组件可脱离主框架使用，方便开发者自行创建服务进行调度，属于socket事件调度器。

  1. use EasySwoole\Socket\AbstractInterface\Controller;
  2. use EasySwoole\Socket\AbstractInterface\ParserInterface;
  3. use EasySwoole\Socket\Bean\Response;
  4. use EasySwoole\Socket\Bean\Caller;
  6. class C extends Controller{
  8.     private $hit = 0;
  9.     protected $hitTime = 0;
  11.     function __construct()
  12.     {
  13.         var_dump('controller create  '.spl_object_hash($this));
  14.         parent::__construct();
  15.     }
  17.     protected function onRequest(?string $actionName): bool
  18.     {
  20.         $this->hit++;
  21.         $this->hitTime = time();
  22.         return true;
  23.     }
  25.     function test()
  26.     {
  27.         var_dump($this->hit,$this->hitTime);
  28. //        co::sleep(10);
  29.         $this->response()->setMessage('time:'.time());
  30.     }
  32.     protected function gc()
  33.     {
  34.         parent::gc(); // TODO: Change the autogenerated stub
  35.         var_dump('controller has ben gc');
  36.     }
  37. }
  39. class Parser implements ParserInterface{
  41.     public function decode($raw, $client): ?Caller
  42.     {
  43.         // TODO: Implement decode() method.
  44.         $ret =  new Caller();
  45.         $ret->setControllerClass(C::class);
  46.         $ret->setAction('test');
  47.         return $ret;
  48.     }
  50.     /*
  51.      * 如果这里返回null，则不给客户端任何数据
  52.      */
  53.     public function encode(Response $response, $client): ?string
  54.     {
  55.         // TODO: Implement encode() method.
  56.         return $response->__toString();
  57.     }
  59. }
  61. $server = new \Swoole\Server("127.0.0.1", 9501);
  62. $server->set([
  63.     'worker_num'=>1
  64. ]);
  66. $conf = new \EasySwoole\Socket\Config();
  67. $conf->setType($conf::TCP);
  68. $conf->setParser(new Parser());
  69. $conf->setMaxPoolNum(2);
  70. $conf->setOnExceptionHandler(function (\swoole_server $server,\Throwable $throwable,string $raw,$client,Response $response){
  71.     $response->setStatus('error');
  72.     $response->setStatus($response::STATUS_RESPONSE_AND_CLOSE);
  73. });
  75. $dispatch = new \EasySwoole\Socket\Dispatcher($conf);
  76. $server->on('receive', function ($server, $fd, $reactor_id, $data)use($dispatch) {
  77.     $dispatch->dispatch($server,$data,$fd,$reactor_id);
  78. });
  79. $server->on('close', function ($server, $fd) {
  80.     echo "connection close: {$fd}\n";
  81. });
  82. $server->start();

框架内使用

具体demo

Tcp

控制器

  1. <?php
  3. namespace App\TcpController;
  5. use EasySwoole\Socket\AbstractInterface\Controller;
  7. class Index extends Controller
  8. {
  9.     public function index()
  10.     {
  11.         $this->response()->setMessage('this is index');
  12.     }
  13. }

解析器

  1. <?php
  3. namespace App\Parser;
  5. use EasySwoole\Socket\AbstractInterface\ParserInterface;
  6. use EasySwoole\Socket\Bean\Caller;
  7. use EasySwoole\Socket\Bean\Response;
  9. class TcpParser implements ParserInterface
  10. {
  11.     public function decode($raw, $client): ?Caller
  12.     {
  13.         $data = substr($raw, '4');
  14.         $data = json_decode($data, true);
  15.         $caller = new Caller();
  16.         $controller = !empty($data['controller']) ? $data['controller'] : 'Index';
  17.         $action = !empty($data['action']) ? $data['action'] : 'index';
  18.         $param = !empty($data['param']) ? $data['param'] : [];
  19.         $controller = "App\\TcpController\\{$controller}";
  20.         $caller->setControllerClass($controller);
  21.         $caller->setAction($action);
  22.         $caller->setArgs($param);
  23.         return $caller;
  24.     }
  26.     public function encode(Response $response, $client): ?string
  27.     {
  28.         return pack('N', strlen($response->getMessage())) . $response->getMessage();
  29.     }
  30. }

注册

mainServerCreate

  1. $config = new \EasySwoole\Socket\Config();
  2. $config->setType($config::TCP);
  3. $config->setParser(TcpParser::class);
  4. $dispatcher = new \EasySwoole\Socket\Dispatcher($config);
  5. $config->setOnExceptionHandler(function (\Swoole\Server $server, \Throwable $throwable, string $raw, \EasySwoole\Socket\Client\Tcp $client, \EasySwoole\Socket\Bean\Response $response) {
  6.     $response->setMessage('system error!');
  7.     $response->setStatus($response::STATUS_RESPONSE_AND_CLOSE);
  8. });
  9. $register->set($register::onReceive, function (\Swoole\Server $server, int $fd, int $reactorId, string $data) use ($dispatcher) {
  10.     $dispatcher->dispatch($server, $data, $fd, $reactorId);
  11. });

Udp

控制器

  1. <?php
  3. namespace App\UdpController;
  5. use EasySwoole\Socket\AbstractInterface\Controller;
  7. class Index extends Controller
  8. {
  9.     public function index()
  10.     {
  11.         $this->response()->setMessage('this is index');
  12.     }
  13. }

解析器

  1. <?php
  3. namespace App\Parser;
  5. use EasySwoole\Socket\AbstractInterface\ParserInterface;
  6. use EasySwoole\Socket\Bean\Caller;
  7. use EasySwoole\Socket\Bean\Response;
  9. class UdpParser implements ParserInterface
  10. {
  11.     public function decode($raw, $client): ?Caller
  12.     {
  13.         $data = json_decode($raw, true);
  14.         $caller = new Caller();
  15.         $controller = !empty($data['controller']) ? $data['controller'] : 'Index';
  16.         $action = !empty($data['action']) ? $data['action'] : 'index';
  17.         $param = !empty($data['param']) ? $data['param'] : [];
  18.         $controller = "App\\UdpController\\{$controller}";
  19.         $caller->setControllerClass($controller);
  20.         $caller->setAction($action);
  21.         $caller->setArgs($param);
  22.         return $caller;
  23.     }
  25.     public function encode(Response $response, $client): ?string
  26.     {
  27.         return json_encode($response->getMessage());
  28.     }
  29. }

注册

mainServerCreate

  1. $config = new \EasySwoole\Socket\Config();
  2. $config->setType($config::UDP);
  3. $config->setParser(UdpParser::class);
  4. $dispatcher = new \EasySwoole\Socket\Dispatcher($config);
  5. $config->setOnExceptionHandler(function (\Swoole\Server $server, \Throwable $throwable, string $raw, \EasySwoole\Socket\Client\Udp $client, \EasySwoole\Socket\Bean\Response $response) {
  6.     $response->setMessage('system error!');
  7.     $response->setStatus($response::STATUS_RESPONSE_AND_CLOSE);
  8. });
  9. $server = \EasySwoole\EasySwoole\ServerManager::getInstance()->getSwooleServer();
  10. $udpServer = $server->addListener('0.0.0.0', '9511', SWOOLE_UDP);
  11. $udpServer->on($register::onPacket, function (\Swoole\Server $server, string $data, array $clientInfo) use ($dispatcher) {
  12.     $dispatcher->dispatch($server, $data, $clientInfo['server_socket'], $clientInfo['address'], $clientInfo['port']);
  13. });

Websocket

控制器

  1. <?php
  3. namespace App\WebSocketController;
  5. use EasySwoole\Socket\AbstractInterface\Controller;
  7. class Index extends Controller
  8. {
  9.     public function index()
  10.     {
  11.         $this->response()->setMessage('this is index');
  12.     }
  13. }

解析器

  1. <?php
  3. namespace App\Parser;
  5. use EasySwoole\Socket\AbstractInterface\ParserInterface;
  6. use EasySwoole\Socket\Bean\Caller;
  7. use EasySwoole\Socket\Bean\Response;
  9. class WebSocketParser implements ParserInterface
  10. {
  11.     public function decode($raw, $client): ?Caller
  12.     {
  13.         $data = json_decode($raw, true);
  14.         $caller = new Caller();
  15.         $controller = !empty($data['controller']) ? $data['controller'] : 'Index';
  16.         $action = !empty($data['action']) ? $data['action'] : 'index';
  17.         $param = !empty($data['param']) ? $data['param'] : [];
  18.         $controller = "App\\WebSocketController\\{$controller}";
  19.         $caller->setControllerClass($controller);
  20.         $caller->setAction($action);
  21.         $caller->setArgs($param);
  22.         return $caller;
  23.     }
  25.     public function encode(Response $response, $client): ?string
  26.     {
  27.         return json_encode($response->getMessage());
  28.     }
  29. }

自定义握手

  1. <?php
  3. namespace App;
  5. class WebSocketEvent
  6. {
  7.     /**
  8.      * @param \Swoole\Http\Request $request
  9.      * @param \Swoole\Http\Response $response
  10.      * @return bool
  11.      */
  12.     public function onHandShake(\Swoole\Http\Request $request, \Swoole\Http\Response $response)
  13.     {
  14.         /** 此处自定义握手规则 返回 false 时中止握手 */
  15.         if (!$this->customHandShake($request, $response)) {
  16.             $response->end();
  17.             return false;
  18.         }
  20.         /** 此处是  RFC规范中的WebSocket握手验证过程 必须执行 否则无法正确握手 */
  21.         if ($this->secWebsocketAccept($request, $response)) {
  22.             $response->end();
  23.             return true;
  24.         }
  26.         $response->end();
  27.         return false;
  28.     }
  30.     /**
  31.      * @param \Swoole\Http\Request $request
  32.      * @param \Swoole\Http\Response $response
  33.      * @return bool
  34.      */
  35.     protected function customHandShake(\Swoole\Http\Request $request, \Swoole\Http\Response $response): bool
  36.     {
  37.         /**
  38.          * 这里可以通过 http request 获取到相应的数据
  39.          * 进行自定义验证后即可
  40.          * (注) 浏览器中 JavaScript 并不支持自定义握手请求头 只能选择别的方式 如get参数
  41.          */
  42.         $headers = $request->header;
  43.         $cookie = $request->cookie;
  45.         // if (如果不满足我某些自定义的需求条件，返回false，握手失败) {
  46.         //    return false;
  47.         // }
  48.         return true;
  49.     }
  51.     /**
  52.      * RFC规范中的WebSocket握手验证过程
  53.      * 以下内容必须强制使用
  54.      *
  55.      * @param \Swoole\Http\Request $request
  56.      * @param \Swoole\Http\Response $response
  57.      * @return bool
  58.      */
  59.     protected function secWebsocketAccept(\Swoole\Http\Request $request, \Swoole\Http\Response $response): bool
  60.     {
  61.         // ws rfc 规范中约定的验证过程
  62.         if (!isset($request->header['sec-websocket-key'])) {
  63.             // 需要 Sec-WebSocket-Key 如果没有拒绝握手
  64.             var_dump('shake fai1 3');
  65.             return false;
  66.         }
  67.         if (0 === preg_match('#^[+/0-9A-Za-z]{21}[AQgw]==$#', $request->header['sec-websocket-key'])
  68.             || 16 !== strlen(base64_decode($request->header['sec-websocket-key']))
  69.         ) {
  70.             //不接受握手
  71.             var_dump('shake fai1 4');
  72.             return false;
  73.         }
  75.         $key = base64_encode(sha1($request->header['sec-websocket-key'] . '258EAFA5-E914-47DA-95CA-C5AB0DC85B11', true));
  76.         $headers = array(
  77.             'Upgrade' => 'websocket',
  78.             'Connection' => 'Upgrade',
  79.             'Sec-WebSocket-Accept' => $key,
  80.             'Sec-WebSocket-Version' => '13',
  81.             'KeepAlive' => 'off',
  82.         );
  84.         if (isset($request->header['sec-websocket-protocol'])) {
  85.             $headers['Sec-WebSocket-Protocol'] = $request->header['sec-websocket-protocol'];
  86.         }
  88.         // 发送验证后的header
  89.         foreach ($headers as $key => $val) {
  90.             $response->header($key, $val);
  91.         }
  93.         // 接受握手 还需要101状态码以切换状态
  94.         $response->status(101);
  95.         var_dump('shake success at fd :' . $request->fd);
  96.         return true;
  97.     }
  98. }

注册

mainServerCreate

  1. <?php
  2. $config = new \EasySwoole\Socket\Config();
  3. $config->setType($config::WEB_SOCKET);
  4. $config->setParser(WebSocketParser::class);
  5. $dispatcher = new \EasySwoole\Socket\Dispatcher($config);
  6. $config->setOnExceptionHandler(function (\Swoole\Server $server, \Throwable $throwable, string $raw, \EasySwoole\Socket\Client\WebSocket $client, \EasySwoole\Socket\Bean\Response $response) {
  7.     $response->setMessage('system error!');
  8.     $response->setStatus($response::STATUS_RESPONSE_AND_CLOSE);
  9. });
  11. // 自定义握手
  12. /*$websocketEvent = new WebSocketEvent();
  13. $register->set(EventRegister::onHandShake, function (\Swoole\Http\Request $request, \Swoole\Http\Response $response) use ($websocketEvent) {
  14.     $websocketEvent->onHandShake($request, $response);
  15. });*/
  17. $register->set($register::onMessage, function (\Swoole\Websocket\Server $server, \Swoole\Websocket\Frame $frame) use ($dispatcher) {
  18.     $dispatcher->dispatch($server, $frame->data, $frame);
  19. });