WebSocket:message 事件
message 事件在收到服务器发来的一条消息时派发。每条消息派发一次。
语法
ws.addEventListener('message', (event) => { })事件对象
类型定义里是 WebSocketMessageEvent。不能取消。回调参数的类型是通用的 Event,要读 data 先转一次类型,见下面的示例。
data
收到的内容:
- 文本消息是字符串。
- 二进制消息是
Blob。size是字节数,要读字节用await data.arrayBuffer()。
什么时候派发
- 连接打开期间,每收到一条消息派发一次,持续派发,直到连接结束。
- 单条消息长度超过
maximumMessageSize时接收失败。这时派发什么未在模拟器验证。 - 派发时还没有加监听器的消息就丢失了,不会补发。
示例
js
const ws = new WebSocket('wss://echo.websocket.org');
ws.addEventListener('message', async (e) => {
const data = /** @type {WebSocketMessageEvent} */ (e).data;
if (typeof data === 'string') {
console.log('文本', data);
} else {
const bytes = new Uint8Array(await data.arrayBuffer());
console.log('二进制', bytes.length, '字节');
}
});效果:文本消息输出它的内容;二进制消息输出它的字节数。
和 Web 的差别
- 浏览器的二进制消息默认是
Blob,可以用binaryType改成ArrayBuffer;这里总是Blob,没有binaryType。 - 浏览器的事件对象是
MessageEvent,还带origin、lastEventId等字段;这里只带data。 - 没有
onmessage属性,只能用addEventListener。