最近在工作中遇到了需要服务器推送消息的场景,这里总结一下收集整理 WebSocket 相关资料的收获。

1. 概述

1.1 服务器推送

WebSocket 作为一种通信协议,属于服务器推送技术的一种,IE10+ 支持。

服务器推送技术不止一种,有短轮询、长轮询、WebSocket、Server-sent Events(SSE)等,它们各有优缺点

image-11

短轮询最简单,在一些简单的场景也会经常使用,就是隔一段时间就发起一个 ajax 请求。那么长轮询是什么呢?

长轮询(Long Polling)是在 Ajax 轮询基础上做的一些改进,在没有更新的时候不再返回空响应,而且把连接保持到有更新的时候,客户端向服务器发送 Ajax 请求,服务器接到请求后 hold 住连接,直到有新消息才返回响应信息并关闭连接,客户端处理完响应信息后再向服务器发送新的请求。它是一个解决方案,但不是最佳的技术方案。

如果说短轮询是客户端不断打电话问服务端有没有消息,服务端回复后立刻挂断,等待下次再打;长轮询是客户端一直打电话,服务端接到电话不挂断,有消息的时候再回复客户端并挂断。

SSE(Server-Sent Events)与长轮询机制类似,区别是每个连接不只发送一个消息。客户端发送一个请求,服务端保持这个连接直到有新消息发送回客户端,仍然保持着连接,这样连接就可以支持消息的再次发送,由服务器单向发送给客户端。然而IE直到11都不支持,不多说了......

1.2 WebSocket 的特点

为什么已经有了轮询还要 WebSocket 呢,是因为短轮询和长轮询有个缺陷:通信只能由客户端发起。

那么如果后端想往前端推送消息需要前端去轮询,不断查询后端是否有新消息,而轮询的效率低且浪费资源(必须不停 setInterval 或 setTimeout 去连接,或者 HTTP 连接始终打开),WebSocket 提供了一个文明优雅的全双工通信方案。一般适合于对数据的实时性要求比较强的场景,如通信、股票、直播、共享桌面,特别适合于客户端与服务频繁交互的情况下,如聊天室、实时共享、多人协作等平台。

特点

  1. 建立在 TCP 协议之上,服务器端的实现比较容易。
  2. 与 HTTP 协议有着良好的兼容性。默认端口也是 80 和 443,并且握手阶段采用 HTTP 协议,因此握手时不容易屏蔽,能通过各种 HTTP 代理服务器。
  3. 数据格式比较轻量,性能开销小,通信高效。服务器与客户端之间交换的标头信息大概只有 2 字节;
  4. 可以发送文本,也可以发送二进制数据。
  5. 没有同源限制,客户端可以与任意服务器通信。
  6. 协议标识符是ws(如果加密,则为 wss),服务器网址就是 URL。ex:ws://example.com:80/some/path
  7. 不用频繁创建及销毁 TCP 请求,减少网络带宽资源的占用,同时也节省服务器资源;
  8. WebSocket 是纯事件驱动的,一旦连接建立,通过监听事件可以处理到来的数据和改变的连接状态,数据都以帧序列的形式传输。服务端发送数据后,消息和事件会异步到达。
  9. 无超时处理。

HTTP 与 WS 协议结构

WebSocket 协议标识符用ws表示。`wss 协议表示加密的 WebSocket 协议,对应 HTTPs 协议。结构如下:

  • HTTP: TCP > HTTP
  • HTTPS: TCP > TLS > HTTP
  • WS: TCP > WS
  • WSS: TCP > TLS > WS

2 WebSocket 的通信过程

首先,Websocket 是一个持久化的协议,相对于 HTTP 这种非持久的协议来说。

一个 HTTP 的通信生命周期通过 Request 来界定,也就是一个 Request 一个  Response ,那么在 HTTP1.0 中,这次 HTTP 请求就结束了。 在 HTTP1.1 中进行了改进,有了一个keep-alive,在一个 HTTP 连接中,可以发送多个 Request,接收多个 Response,也就是合并多个请求。但是一个 Request 只能对应一个 Response,而且这个 Response 是被动的,不能主动发起。

Websocket 其实是一个新协议,但是为了兼容现有浏览器的握手规范而借用了 HTTP 的协议来完成一部分握手。

WebSocket 是纯事件驱动的,一旦连接建立,通过监听事件可以处理到来的数据和改变的连接状态,数据都以帧序列的形式传输。服务端发送数据后,消息和事件会异步到达。WebSocket 编程遵循一个异步编程模型,只需要对 WebSocket 对象增加回调函数就可以监听事件。

2.1 WebSocket 通信流程图

image-12

这里可以看出传统 HTTP 通讯与 WebSocket 通讯的通信流程上的区别,下图显示 WebSocket 主要的三步中浏览器和服务器端分别做了哪些事情。

image-13

2.2 建立连接的握手

当 Web 应用程序调用new WebSocket(url)接口时,客户端就开始了与地址为 url 的 WebServer 建立握手连接的过程。

  1. 客户端与服务端通过 TCP 三次握手建立连接,如果这个建立连接失败,那么后面的过程就不会执行,Web 应用程序将收到错误消息通知。
  2. 在 TCP 建立连接成功后,客户端通过 HTTP 协议传送 WebSocket 支持的版本号、协议的字版本号、原始地址、主机地址等等一些列字段给服务器端。
  3. 服务端收到客户端发送来的握手请求后,如果数据包数据和格式正确、客户端和服务端的协议版本号匹配等等,就接受本次握手连接,并给出相应的数据回复,同样回复的数据包也是采用 HTTP 协议传输。
  4. 客户端收到服务端回复的数据包后,如果数据包内容、格式都没有问题的话,就表示本次连接成功,触发onopen,此时 Web 开发者就可以在此时通过send()向服务器发送数据。否则握手连接失败,Web 应用程序触发onerror,并且能知道连接失败的原因。

这个握手很像 HTTP,但是实际上却不是,它允许服务器以 HTTP 的方式解释一部分 handshake 的请求,然后切换为 websocket。

2.3 WebSocket 握手报文

一个浏览器发出的 WebSocket 请求报文类似于:

GET /chat HTTP/1.1
Host: server.example.com
Upgrade: websocket
Connection: Upgrade
Sec-WebSocket-Key: x3JJHMbDL1EzLkh9GBhXDw==
Sec-WebSocket-Protocol: chat, superchat
Sec-WebSocket-Version: 13
Origin: http://example.com

HTTP1.1 协议规定,Upgrade 头信息表示将通信协议从 HTTP/1.1 转向该项所指定的协议。

  • Connection: Upgrade表示浏览器通知服务器,如果可以,就升级到 webSocket 协议。
  • Origin用于验证浏览器域名是否在服务器许可的范围内。
  • Sec-WebSocket-Key则是用于握手协议的密钥,是浏览器生成的 Base64 编码的 16 字节随机字符串。
  • Sec-WebSocket-Protocol是一个用户定义的字符串,用来区分同 URL 下,不同的服务所需要的协议。
  • Sec-WebSocket-Version是告诉服务器所使用的协议版本。

服务端 WebSocket 回复报文:

HTTP/1.1 101 Switching Protocols
Upgrade: websocket
Connection: Upgrade
Sec-WebSocket-Accept: HSmrc0sMlYUkAGmm5OPpG2HaGWk=
Sec-WebSocket-Protocol: chat
Sec-WebSocket-Origin: null
Sec-WebSocket-Location: ws://example.com/
  • 服务器端同样用Connection: Upgrade通知浏览器,服务端已经成功切换协议。
  • Sec-WebSocket-Accept是经过服务器确认并且加密过后的Sec-WebSocket-Key
  • Sec-WebSocket-Location表示进行通信的 WebSocket 网址。
  • Sec-WebSocket-Protocol表示最终使用的协议。

在这样一个类似于 HTTP 通信的握手结束之后,下面就按照 WebSocket 协议进行通信了。客户端与服务器之间不会再发生 HTTP 通信,一切由 WebSocket 协议接管。

3. WebSocket API

浏览器提供了一个 WebSocket 对象的实现,可以用这个对象来创建和管理 WebSocket 连接,并且可以通过该连接发送和接受数据。WebSocket 是事件驱动的,因此只需要对 WebSocket 对象增加回调函数就可以监听事件的发生。

XMLHttpRequest 一样,通过该构造函数先 new 出来对象实例const ws = new WebSocket('ws://localhost:8080'),再使用对象下挂载的属性与方法来操作。后文都用 ws 来指代 WebSocket 的实例。

查看 DEMO

3.1 ws上常用属性

ws.readyState

WebSocket 实例对象类似于 XHR 有个的只读属性readyState来指示连接的当前状态:状态值描述 CONNECTING0 连接还没开启。OPEN1 连接已开启并准备好进行通信。CLOSING2 连接正在关闭的过程中。CLOSED3 连接已经关闭,或者连接无法建立。

一个示例:

switch (ws.readyState) {
  case WebSocket.CONNECTING:
    // ...
    break;
  case WebSocket.OPEN:
    // ...
    break;
  case WebSocket.CLOSING:
    // ...
    break;
  case WebSocket.CLOSED:
    // ...
    break;
  default:
    //  this never happens
    break;
}

ws.onopen /  ws.onclose

实例对象的onopen属性,用于指定连接成功后的回调函数。

ws.onopen = function () {
  ws.send('Hello Server!');
}

如果要指定多个回调函数,可以addEventListener

ws.addEventListener('open', function (event) {
  ws.send('Hello Server!');
});

实例对象的onclose属性,用于指定连接关闭后的回调函数。

ws.onclose = function(event) {
    const { code, reason, wasClean} = event
    // ...
};
ws.addEventListener('close', function(event) {
    const { code, reason, wasClean} = event
    // ...
})

ws.onmessage

实例对象的onmessage属性,用于指定收到服务器数据后的回调函数。

ws.onmessage = function(event) {
  const { data } = event;
  // ...
};
ws.addEventListener('message', function(event) {
  const { data } = event; 
  // ...
});

注意,服务器数据可能是文本,也可能是二进制数据(blob 对象或 Arraybuffer 对象)。

ws.onmessage = function(event){
  if(typeof event.data === String) {
    // string
  }
  if(event.data instanceof ArrayBuffer){
    const { data: buffer } = event;
    // array buffer
  }
}

除了动态判断收到的数据类型,也可以使用binaryType属性,显式指定收到的二进制数据类型。binaryType取值应当是 'blob' 或者 'arraybuffer','blob' 表示使用 Blob  对象,而 'arraybuffer' 表示使用 ArrayBuffer 对象。

ws.binaryType = 'blob';                // 收到的是 Blob 数据
ws.onmessage = function(e) {
  console.log(e.data.size);
};

ws.binaryType = 'arraybuffer';            // 收到的是 ArrayBuffer 数据
ws.onmessage = function(e) {
  console.log(e.data.byteLength);
};

查看 DEMO

ws.bufferedAmount

实例对象的bufferedAmount只读属性,表示还有多少字节的二进制数据没有发送出去。它可以用来判断发送是否结束。 该值会在所有队列数据被发送后重置为 0,而当连接关闭时不会设为 0。如果持续调用 send(),这个值会持续增长。

var data = new ArrayBuffer(10000000);
ws.send(data);
if (ws.bufferedAmount === 0) {
  // 发送完毕
} else {
  // 发送还没结束
}

ws.onerror

实例对象的onerror属性,用于指定报错时的回调函数。

ws.onerror = function(event) {
  // handle error event
};
ws.addEventListener("error", function(event) {
  // handle error event
});

3.2 ws上常用方法

ws.close()

关闭 WebSocket 连接或停止正在进行的连接请求。如果连接的状态已经是 closed,这个方法不会有任何效果。

ws.send()

实例对象的send()方法用于向服务器发送数据。

ws.send('your message');                // 发送文本的例子

var file = document
  .querySelector('input[type="file"]')
  .files[0];
ws.send(file);                            // 发送 Blob 对象的例子

// Sending canvas ImageData as ArrayBuffer   
var img = canvas_context.getImageData(0, 0, 400, 320);
var binary = new Uint8Array(img.data.length);
for (var i = 0; i < img.data.length; i++) {
  binary[i] = img.data[i];
}
ws.send(binary.buffer);                // 发送 ArrayBuffer 对象的例子

最后一个 ArrayBuffer 对象栗子中的 canvas_context 实例是 CanvasRenderingContext2D 类型的对象,其上的.getImageData()方法返回一个 ImageData 对象。