监听事件

有几种方法可以处理在服务器和客户端之间传输的事件。

EventEmitter 方法

在服务器端，Socket 实例扩展了 Node.js EventEmitter 类。

在客户端，Socket 实例使用由 component-emitter 库提供的事件发射器，该库公开了一部分 EventEmitter 方法。

socket.on(eventName, listener)

将 listener 函数添加到名为 eventName 的事件的监听器数组的末尾。

socket.on("details", (...args) => {
  // ...
});

socket.once(eventName, listener)

为名为 eventName 的事件添加一个一次性的 listener 函数

socket.once("details", (...args) => {
  // ...
});

socket.off(eventName, listener)

从名为 eventName 的事件的监听器数组中删除指定的 listener。

const listener = (...args) => {
  console.log(args);
}

socket.on("details", listener);

// and then later...
socket.off("details", listener);

socket.removeAllListeners([eventName])

删除所有监听器，或指定 eventName 的监听器。

// for a specific event
socket.removeAllListeners("details");
// for all events
socket.removeAllListeners();

通配符监听器

从 Socket.IO v3 开始，一个新的 API 受到 EventEmitter2 库的启发，允许声明通配符监听器。

此功能在客户端和服务器上都可用。

socket.onAny(listener)

添加一个监听器，当任何事件被发射时，它将被触发。

socket.onAny((eventName, ...args) => {
  // ...
});

注意

确认 不会被通配符监听器捕获。

socket.emit("foo", (value) => {
  // ...
});

socket.onAnyOutgoing(() => {
  // triggered when the event is sent
});

socket.onAny(() => {
  // not triggered when the acknowledgement is received
});

socket.prependAny(listener)

添加一个监听器，当任何事件被发射时，它将被触发。监听器被添加到监听器数组的开头。

socket.prependAny((eventName, ...args) => {
  // ...
});

socket.offAny([listener])

删除所有通配符监听器，或给定的监听器。

const listener = (eventName, ...args) => {
  console.log(eventName, args);
}

socket.onAny(listener);

// and then later...
socket.offAny(listener);

// or all listeners
socket.offAny();

socket.onAnyOutgoing(listener)

为传出数据包注册一个新的通配符监听器。

socket.onAnyOutgoing((event, ...args) => {
  // ...
});

注意

确认 不会被通配符监听器捕获。

socket.on("foo", (value, callback) => {
  callback("OK");
});

socket.onAny(() => {
  // triggered when the event is received
});

socket.onAnyOutgoing(() => {
  // not triggered when the acknowledgement is sent
});

socket.prependAnyOutgoing(listener)

为传出数据包注册一个新的通配符监听器。监听器被添加到监听器数组的开头。

socket.prependAnyOutgoing((event, ...args) => {
  // ...
});

socket.offAnyOutgoing([listener])

删除之前注册的监听器。如果没有提供监听器，则删除所有通配符监听器。

const listener = (eventName, ...args) => {
  console.log(eventName, args);
}

socket.onAnyOutgoing(listener);

// remove a single listener
socket.offAnyOutgoing(listener);

// remove all listeners
socket.offAnyOutgoing();

验证

事件参数的验证超出了 Socket.IO 库的范围。

JS 生态系统中有很多包涵盖了这种用例，其中包括

• joi
• ajv
• validatorjs

使用 joi 和 确认 的示例

const Joi = require("joi");

const userSchema = Joi.object({
  username: Joi.string().max(30).required(),
  email: Joi.string().email().required()
});

io.on("connection", (socket) => {
  socket.on("create user", (payload, callback) => {
    if (typeof callback !== "function") {
      // not an acknowledgement
      return socket.disconnect();
    }
    const { error, value } = userSchema.validate(payload);
    if (error) {
      return callback({
        status: "Bad Request",
        error
      });
    }
    // do something with the value, and then
    callback({
      status: "OK"
    });
  });

});

错误处理

Socket.IO 库目前没有内置的错误处理，这意味着您必须捕获监听器中可能抛出的任何错误。

io.on("connection", (socket) => {
  socket.on("list items", async (callback) => {
    try {
      const items = await findItems();
      callback({
        status: "OK",
        items
      });
    } catch (e) {
      callback({
        status: "NOK"
      });
    }
  });
});

这可以重构为

const errorHandler = (handler) => {
  const handleError = (err) => {
    console.error("please handle me", err);
  };

  return (...args) => {
    try {
      const ret = handler.apply(this, args);
      if (ret && typeof ret.catch === "function") {
        // async handler
        ret.catch(handleError);
      }
    } catch (e) {
      // sync handler
      handleError(e);
    }
  };
};

// server or client side
socket.on("hello", errorHandler(() => {
  throw new Error("let's panic");
}));