使用 WebSocket 服务器

开发者可以在游戏进程中启动一个 WebSocket 服务器，提供 RPC 接口。通过完善和调用这些 RPC 接口，开发者能够对游戏进程内部状态进行监控，增加对游戏进程状态的管理能力。

如何启用

WebSocket 服务器 默认是剔除的。若要启用，需要在编辑器顶部菜单栏中 项目设置 -> 功能裁剪 中勾选WebSocket Server 配置。

如何调用 WebSocket 服务器接口

可参考下方实例代码：

  1. // 在原生平台的 Release 模式下或者在 Web /微信小游戏等平台中，WebSocketServer 可能没有定义
  2. if (typeof WebSocketServer === "undefined") {
  3.     console.error("WebSocketServer is not enabled!");
  4.     return;
  5. }
  7. let s = new WebSocketServer();
  8. s.onconnection = function (conn) {
  9.     conn.onmessage = function (data) {
  10.         conn.send(data, (err) => {});
  11.     }
  12.     conn.onclose = function () {
  13.         console.log("connection gone!");
  14.     };
  15. };
  17. s.onclose = function () {
  18.   console.log("server is closed!");
  19. }
  20. s.listen(8080, (err) => {
  21.    if (!err);
  22.    console.log("server booted!");
  23. });

API

接口定义如下：

  1. /**
  2.  * 服务器对象
  3.  */
  4. class WebSocketServer {
  5.     /**
  6.      * 关闭服务
  7.      */
  8.     close(cb?: WsCallback): void;
  9.     /**
  10.      * 监听并启动服务
  11.      */
  12.     listen(port: number, cb?: WsCallback): void;
  13.     /**
  14.      * 处理新的请求
  15.      */
  16.     set onconnection(cb: (client: WebSocketServerConnection) => void);
  17.     /**
  18.      * 设置服务器关闭回调
  19.      */
  20.     set onclose(cb: WsCallback);
  21.     /**
  22.      * 获取所有的连接对象
  23.      */
  24.     get connections(): WebSocketServerConnection[];
  25. }
  27. /**
  28.  * 服务器中客户端的连接对象
  29.  */
  30. class WebSocketServerConnection {
  31.     /**
  32.      * 关闭连接
  33.      */
  34.     close(code?: number, reason?: string): void;
  35.     /**
  36.      * 发送数据
  37.      */
  38.     send(data: string|ArrayBuffer, cb?: WsCallback): void;
  40.     set ontext(cb: (data: string) => void);
  41.     set onbinary(cb: (data: ArrayBuffer) => void);
  42.     set onmessage(cb: (data: string|ArrayBuffer) => void);
  43.     set onconnect(cb: () => void;);
  44.     set onclose(cb: WsCallback);
  45.     set onerror(cb: WsCallback);
  47.     get readyState(): number;
  48. }
  50. interface WsCallback {
  51.     (err?: string): void;
  52. }

注意: ondata 回调已经在 v3.7.0 版本废弃, 请使用 onmessage 代替.

参考链接

接口设计参考了 nodejs-websocket。