消息处理

如果你定义的ws模块类没有添加 OnMessage 处理方法，框架将会自动托管这个阶段，解析消息并根据路由分发到不同的方法执行。

注解

WsController

websocket 消息控制器注解tag @WsController

  • 注解类： Swoft\WebSocket\Server\Annotation\Mapping\WsController
  • 作用范围： CLASS
  • 拥有属性：
    • prefix string 消息路由前缀

MessageMapping

方法注解 @MessageMapping 标记具体的消息处理方法，类似于http控制器里的action。

  • 注解类： Swoft\WebSocket\Server\Annotation\Mapping\MessageMapping
  • 作用范围： METHOD
  • 拥有属性：
    • command string 消息命令名称

说明

完整的消息路由path是 上面的 preifx 和 command 由点拼接而成 PREFIX.COMMAND

示例

定义ws模块

注意 要绑定消息处理控制器，通常也需要绑定你的消息解析器，内置了几个简单的解析器。

  1. <?php declare(strict_types=1);
  3. namespace App\WebSocket;
  5. use App\WebSocket\Chat\HomeController;
  6. use Swoft\Http\Message\Request;
  7. use Swoft\WebSocket\Server\Annotation\Mapping\OnOpen;
  8. use Swoft\WebSocket\Server\Annotation\Mapping\WsModule;
  9. use Swoft\WebSocket\Server\MessageParser\TokenTextParser;
  10. use function server;
  12. /**
  13.  * Class ChatModule
  14.  *
  15.  * @WsModule(
  16.  *     "/chat",
  17.  *     messageParser=TokenTextParser::class,
  18.  *     controllers={HomeController::class}
  19.  * )
  20.  */
  21. class ChatModule
  22. {
  23.     /**
  24.      * @OnOpen()
  25.      * @param Request $request
  26.      * @param int     $fd
  27.      */
  28.     public function onOpen(Request $request, int $fd): void
  29.     {
  30.         server()->push($request->getFd(), "Opened, welcome!(FD: $fd)");
  31.     }
  32. }

消息控制器

注意 必须使用注解 @WsController 以及 @MessageMapping

  1. <?php declare(strict_types=1);
  3. namespace App\WebSocket\Chat;
  5. use Swoft\Session\Session;
  6. use Swoft\WebSocket\Server\Annotation\Mapping\MessageMapping;
  7. use Swoft\WebSocket\Server\Annotation\Mapping\WsController;
  9. /**
  10.  * Class HomeController
  11.  *
  12.  * @WsController()
  13.  */
  14. class HomeController
  15. {
  16.     /**
  17.      * Message command is: 'home.index'
  18.      *
  19.      * @return void
  20.      * @MessageMapping()
  21.      */
  22.     public function index(): void
  23.     {
  24.         Session::mustGet()->push('hi, this is home.index');
  25.     }
  27.     /**
  28.      * Message command is: 'home.echo'
  29.      *
  30.      * @param $data
  31.      * @MessageMapping()
  32.      */
  33.     public function echo($data): void
  34.     {
  35.         Session::mustGet()->push('(home.echo)Recv: ' . $data);
  36.     }
  38.     /**
  39.      * Message command is: 'home.ar'
  40.      *
  41.      * @param $data
  42.      * @MessageMapping("ar")
  43.      *
  44.      * @return string
  45.      */
  46.     public function autoReply($data): string
  47.     {
  48.         return '(home.ar)Recv: ' . $data;
  49.     }
  50. }