Colyseus 的 Relay Room：一种轻量级的房间实现

最新推荐文章于 2025-12-27 19:25:02 发布

原创最新推荐文章于 2025-12-27 19:25:02 发布 · 510 阅读

8 ·

CC 4.0 BY-SA版权

文章标签：

#前端 #javascript #游戏程序 #游戏引擎

Colyseus 专栏收录该内容

47 篇文章

订阅专栏

Colyseus 的 Relay Room 是一种轻量级的房间实现，用于传递和广播消息，而无需复杂的游戏逻辑或状态管理。它特别适合需要快速实现客户端之间通信的场景，例如实时聊天、简单的数据同步或多客户端协作应用。

特点

无状态管理
Relay Room 不会维护任何复杂的服务器端状态。它仅负责在客户端之间传递和广播消息。
简单易用
Relay Room 的逻辑非常轻量，适合快速搭建和实现客户端通信。
灵活的消息处理
客户端可以通过自定义消息类型实现多种通信模式。
广播与点对点通信
支持消息广播到所有客户端，也可以实现点对点消息传递。
低资源占用
Relay Room 不会有额外的状态同步和复杂的服务器计算，运行效率高。

适用场景

实时聊天应用
数据广播（例如游戏大厅的实时更新）
简单的客户端同步（例如白板协作或多屏协作）
客户端之间的直接通信需求

如何实现

1. 创建 Relay Room

Colyseus 提供了一个内置的 RelayRoom 类，您可以直接使用它，无需创建自定义房间类。

import { RelayRoom } from "colyseus";

export class MyRelayRoom extends RelayRoom {
  // 您可以选择扩展 RelayRoom 并添加自定义逻辑（如果需要）
}

2. 注册房间

在服务器端的入口文件中，将 Relay Room 注册到服务器中：

import { Server } from "colyseus";
import { MyRelayRoom } from "./rooms/MyRelayRoom";

const gameServer = new Server();

gameServer.define("relay", MyRelayRoom);

gameServer.listen(2567);
console.log("Game server is running on ws://localhost:2567");

3. 客户端加入房间

客户端使用 Colyseus 客户端库连接到 Relay Room。

import { Client } from "colyseus.js";

const client = new Client("ws://localhost:2567");

const room = await client.joinOrCreate("relay");

console.log("Joined Relay Room:", room);

// 监听消息
room.onMessage((type, message) => {
  console.log("Received message:", type, message);
});

// 发送消息
room.send("chat", { message: "Hello, World!" });

4. 消息广播与处理

Relay Room 会自动将消息广播到所有已连接的客户端。

客户端发送消息时，room.send() 会将消息发送到 Relay Room。
服务器会将该消息转发给所有客户端（包括发送方）。

进阶用法

1. 自定义逻辑

如果需要，您可以扩展 RelayRoom 来实现额外的功能。例如，可以在转发消息前对其进行验证或过滤：

import { RelayRoom } from "colyseus";

export class CustomRelayRoom extends RelayRoom {
  // 覆盖 onMessage 方法
  onMessage(client, type, message) {
    console.log(`Message from client ${client.sessionId}:`, type, message);

    // 添加自定义逻辑，例如过滤或修改消息
    if (type === "chat" && typeof message === "string") {
      message = `[Server] ${message}`;
    }

    // 调用父类方法广播消息
    super.onMessage(client, type, message);
  }
}

2. 点对点消息传递

您可以通过在客户端附加标识来实现点对点通信。例如：

消息结构中包含目标客户端的 sessionId。
在服务器端检查 sessionId 并仅转发给目标客户端。

onMessage(client, type, message) {
  if (type === "privateMessage") {
    const targetClient = this.clients.find(c => c.sessionId === message.targetSessionId);
    if (targetClient) {
      targetClient.send(type, message);
    }
  } else {
    super.onMessage(client, type, message); // 默认广播
  }
}