命名空间

命名空间

命名空间在 SocketIO 服务器内提供功能和事件处理的逻辑分离。 它们允许应用程序的不同部分使用 单一物理连接.

命名空间不会创建单独的套接字连接。 客户端只连接一次，并且可以在相同的底层 WebSocket/TCP 会话上加入多个命名空间。

---

默认命名空间

如果客户端在连接时未指定命名空间，则会附加到默认命名空间（"").

Configuration config = new Configuration();
config.setPort(9092);

SocketIOServer server = new SocketIOServer(config);
// 默认命名空间隐式存在
server.start();

自定义命名空间

自定义命名空间用于分离应用关注点和事件范围。

SocketIOServer server = new SocketIOServer(config);

Namespace chat = server.addNamespace("/chat");
Namespace admin = server.addNamespace("/auth");

server.start();

请不要忘记添加 "/"，它始终是 "/namespace" 而不是单独的 "namespace"。

每个命名空间定义：

• 它自己的事件监听器

• 它自己的连接生命周期

• 它自己的授权逻辑

• 它自己的广播操作

---

公共命名空间示例（/chat)

该 /chat 命名空间是开放的，允许在不进行身份验证的情况下进行通用消息传递。

服务器

Configuration config = new Configuration();
config.setPort(9092);

SocketIOServer server = new SocketIOServer(config);
Namespace chat = server.addNamespace("/chat");

// 新客户端连接
chat.addConnectListener(client -> {
    log.info("[/chat] connected -> {}", client.getSessionId());
});

// 消息事件
chat.addEventListener("message", String.class, (client, data, ack) -> {
    // 向 /chat 中的所有客户端广播
    chat.getBroadcastOperations().sendEvent("message", data);
});

server.start();

客户端

const chat = io("http://localhost:9092/chat");

chat.on("connect", () => console.log("connected to /chat"));
chat.emit("message", "hello everyone");

---

需要认证的命名空间示例（/auth)

该 /auth 命名空间在连接期间通过执行授权逻辑来限制访问。

服务器

Configuration config = new Configuration();
config.setPort(9092);

SocketIOServer server = new SocketIOServer(config);
Namespace admin = server.addNamespace("/auth");

// 在命名空间连接时验证令牌
admin.setAuthorizationListener(data -> {
    String token = data.getSingleUrlParam("token");
    return "secret123".equals(token);
});

// 特权警报事件
admin.addEventListener("alert", String.class, (client, data, ack) -> {
    admin.getBroadcastOperations().sendEvent("alert", data);
});

server.start();

已授权客户端

const auth = io("http://localhost:9092/auth", {
    query: { token: "secret123" }
});

admin.emit("alert", "restart service");

未授权客户端

io("http://localhost:9092/auth", {
    query: { token: "invalid" }
});

预期服务器输出：

[/auth] authorization failed -> connection rejected

---