WebSocket 由多个标准构成: WebSocket API 是 W3C 定义的,而 WebSocket 协议(RFC 6455)及其扩展则由 HyBi Working Group(IETF)定义。javascript
HTML5 开始提供的一种浏览器与服务器进行全双工通信的网络技术,属于应用层协议。它基于TCP 传输协议,并复用 HTTP 的握手通道。 WebSocket
能够实现客户端与服务器间双向、基于消息的文本或二进制数据传输。WebSocket
链接远远不是一个网络套接字,由于浏览器在这个简单的 API 以后隐藏了全部的复杂性,并且还提供了更多服务:html
为何已经有了轮询还要 WebSocket 呢,是由于短轮询和长轮询有个缺陷:通讯只能由客户端发起。 WebSocket 提供了一个文明优雅的全双工通讯方案。通常适合于对数据的实时性要求比较强的场景,如通讯、股票、直播、共享桌面,特别适合于客户端与服务频繁交互的状况下,如聊天室、实时共享、多人协做等平台。 他的主要特色以下:java
ws
(若是加密,则为 wss),服务器网址就是 URL。ex:ws://example.com:80/some/path
readyState
属性返回实例对象的当前状态,共有四种。web
实例对象的onopen
属性,用于指定链接成功后的回调函数。ajax
ws.onopen = function() {
ws.send("Hello Server!");
};
// 若是要指定多个回调函数,可使用addEventListener方法。
ws.addEventListener("open", function(event) {
ws.send("Hello Server!");
});
复制代码
实例对象的onclose
属性,用于指定链接关闭后的回调函数。算法
ws.onclose = function(event) {
var code = event.code;
var reason = event.reason;
var wasClean = event.wasClean;
// handle close event
};
ws.addEventListener("close", function(event) {
var code = event.code;
var reason = event.reason;
var wasClean = event.wasClean;
// handle close event
});
复制代码
webSocket.onmessage() 实例对象的onmessage
属性,用于指定收到服务器数据后的回调函数。也能够处理二进制数据。express
ws.onmessage = function(event) {
var data = event.data;
// 处理数据
};
ws.addEventListener("message", function(event) {
var data = event.data;
// 处理数据
});
// 注意,服务器数据多是文本,也多是二进制数据(`blob对象或Arraybuffer对象`)。
ws.onmessage = function(event) {
if (typeof event.data === String) {
console.log("Received data string");
}
if (event.data instanceof ArrayBuffer) {
var buffer = event.data;
console.log("Received arraybuffer");
}
};
// 收到的是 blob 数据
ws.binaryType = "blob";
ws.onmessage = function(e) {
console.log(e.data.size);
};
// 收到的是 ArrayBuffer 数据
ws.binaryType = "arraybuffer";
ws.onmessage = function(e) {
console.log(e.data.byteLength);
};
复制代码
webSocket.send() 实例对象的send()
方法用于向服务器发送数据。canvas
ws.onmessage = function(event) {
var data = event.data;
// 处理数据
};
ws.addEventListener("message", function(event) {
var data = event.data;
// 处理数据
});
// 发送 Blob 对象的例子。
var file = document.querySelector('input[type="file"]').files[0];
ws.send(file);
// 发送 ArrayBuffer 对象的例子。
// 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);
复制代码
实例对象的bufferedAmount
属性,表示还有多少字节的二进制数据没有发送出去。它能够用来判断发送是否结束。segmentfault
var data = new ArrayBuffer(10000000);
socket.send(data);
if (socket.bufferedAmount === 0) {
// 发送完毕
} else {
// 发送还没结束
}
复制代码
实例对象的onerror
属性,用于指定报错时的回调函数。浏览器
socket.onerror = function(event) {
// handle error event
};
socket.addEventListener("error", function(event) {
// handle error event
});
复制代码
对网络应用层协议的学习来讲,最重要的每每就是链接创建过程、数据交换教程。固然,数据的格式是逃不掉的,由于它直接决定了协议自己的能力。好的数据格式能让协议更高效、扩展性更好。 大体能够经过下面的几个方面来学习:
在正式介绍协议细节前,先来看一个简单的例子,有个直观感觉。例子包括了WebSocket 服务端、WebSocket 客户端(网页端)。完整代码能够在 这里 找到。这里服务端用了ws
这个库。相比你们熟悉的socket.io
,ws 实现更轻量,更适合学习的目的。
代码以下,监听8080
端口。当有新的链接请求到达时,打印日志,同时向客户端发送消息。当收到到来自客户端的消息时,一样打印日志。
const express = require("express");
const app = express();
const server = require("http").Server(app);
const WebSocket = require("ws");
const wss = new WebSocket.Server({ port: 8080 });
wss.on("connection", function connection(ws) {
console.log("server: receive connection");
ws.on("message", function incoming(message) {
console.log("server: recevied: %s", message);
});
ws.send("world");
});
app.get("/", function(req, res) {
res.sendfile(__dirname + "/index.html");
});
app.listen(3000);
复制代码
服务端运行结果以下图所示:
代码以下,向 8080 端口发起 WebSocket 链接。链接创建后,打印日志,同时向服务端发送消息。接收到来自服务端的消息后,一样打印日志。
const ws = new WebSocket("ws://localhost:8080");
ws.onopen = function() {
console.log("ws onopen");
ws.send("from client:hello");
};
ws.onmessage = function(e) {
console.log("ws onmessage");
console.log("from server:" + e.data);
};
复制代码
客户端运行结果以下图所示:
前面提到,WebSocket 复用了HTTP 的握手通道。具体指的是,客户端经过 HTTP 请求与 WebSocket服务端协商升级协议。协议升级完成后,后续的数据交换则遵守WebSocket 的协议。
首先,客户端发起协议升级请求。能够看到,采用的是标准的 HTTP 报文格式,且只支持GET 方法。
GET / HTTP/1.1
Host: localhost:8080
Origin: http://127.0.0.1:3000
Connection: Upgrade // 表示要升级协议
Upgrade: websocket // 表示要升级到websocket协议。
Sec-WebSocket-Version: 13 // 表示websocket的版本。若是服务端不支持该版本,须要返回一个Sec-WebSocket-Versionheader,里面包含服务端支持的版本号。
Sec-WebSocket-Key: w4v7O6xFTi36lq3RNcgctw== // 与后面服务端响应首部的Sec-WebSocket-Accept是配套的,提供基本的防御,好比恶意的链接,或者无心的链接。
复制代码
重点请求首部意义以下:
Connection
: Upgrade:表示要升级协议Upgrade: websocket
:表示要升级到 websocket 协议。Sec-WebSocket-Version
: 13:表示 websocket 的版本。若是服务端不支持该版本,须要返回一个 Sec-WebSocket-Versionheader,里面包含服务端支持的版本号。Sec-WebSocket-Key
:与后面服务端响应首部的 Sec-WebSocket-Accept 是配套的,提供基本的防御,好比恶意的链接,或者无心的链接。注意,上面请求省略了部分非重点请求首部。因为是标准的 HTTP 请求,相似 Host、Origin、Cookie 等请求首部会照常发送。在握手阶段,能够经过相关请求首部进行 安全限制、权限校验等。
服务端返回内容以下,状态代码101
表示协议切换。到此完成协议升级,后续的数据交互都按照新的协议来。
HTTP/1.1 101 Switching Protocols
Connection:Upgrade
Upgrade: websocket
Sec-WebSocket-Accept: Oy4NRAQ13jhfONC7bP8dTKb4PTU=
复制代码
以下图所示:
备注:每一个 header 都以\r\n 结尾,而且最后一行加上一个额外的空行\r\n。此外,服务端回应的 HTTP 状态码只能在握手阶段使用。过了握手阶段后,就只能采用特定的错误码。
Sec-WebSocket-Accept
根据客户端请求首部的Sec-WebSocket-Key
计算出来。 计算公式为:
Sec-WebSocket-Key
跟258EAFA5-E914-47DA-95CA-C5AB0DC85B11
拼接。SHA1
计算出摘要,并转成base64
字符串。伪代码以下: >toBase64( sha1( Sec-WebSocket-Key + 258EAFA5-E914-47DA-95CA-C5AB0DC85B11 ) )
验证下前面的返回结果:
const crypto = require("crypto");
const magic = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
const secWebSocketKey = "w4v7O6xFTi36lq3RNcgctw==";
let secWebSocketAccept = crypto
.createHash("sha1")
.update(secWebSocketKey + magic)
.digest("base64");
console.log(secWebSocketAccept);
// Oy4NRAQ13jhfONC7bP8dTKb4PTU=
复制代码
客户端、服务端数据的交换,离不开数据帧格式的定义。所以,在实际讲解数据交换以前,咱们先来看下 WebSocket 的数据帧格式。 WebSocket 客户端、服务端通讯的最小单位是帧(frame),由 1 个或多个帧组成一条完整的消息(message)。
数据帧的格式。详细定义可参考 RFC6455 5.2 节 。
下面给出了 WebSocket 数据帧的统一格式。熟悉 TCP/IP 协议的同窗对这样的图应该不陌生。
FIN
、RSV1
各占据 1 比特,opcode
占据 4 比特。0 1 2 3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-------+-+-------------+-------------------------------+
|F|R|R|R| opcode|M| Payload len | Extended payload length |
|I|S|S|S| (4) |A| (7) | (16/64) |
|N|V|V|V| |S| | (if payload len==126/127) |
| |1|2|3| |K| | |
+-+-+-+-+-------+-+-------------+ - - - - - - - - - - - - - - - +
| Extended payload length continued, if payload len == 127 |
+ - - - - - - - - - - - - - - - +-------------------------------+
| |Masking-key, if MASK set to 1 |
+-------------------------------+-------------------------------+
| Masking-key (continued) | Payload Data |
+-------------------------------- - - - - - - - - - - - - - - - +
: Payload Data continued ... :
+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
| Payload Data continued ... |
+---------------------------------------------------------------+
复制代码
FIN:1 个比特。 若是是1,表示这是消息(message)的最后一个分片(fragment),若是是0,表示不是是消息(message)的最后一个分片(fragment)。
RSV1, RSV2, RSV3:各占 1 个比特。 通常状况下全为 0。当客户端、服务端协商采用 WebSocket 扩展时,这三个标志位能够非 0,且值的含义由扩展进行定义。若是出现非零的值,且并无采用 WebSocket 扩展,链接出错。
Opcode: 4 个比特。 操做代码,Opcode 的值决定了应该如何解析后续的数据载荷(data payload)。若是操做代码是不认识的,那么接收端应该断开链接(fail the connection)。可选的操做代码以下:
Mask: 1 个比特。 表示是否要对数据载荷进行掩码操做。从客户端向服务端发送数据时,须要对数据进行掩码操做;从服务端向客户端发送数据时,不须要对数据进行掩码操做。 若是服务端接收到的数据没有进行过掩码操做,服务端须要断开链接。 若是 Mask 是 1,那么在 Masking-key 中会定义一个掩码键(masking key),并用这个掩码键来对数据载荷进行反掩码。全部客户端发送到服务端的数据帧,Mask 都是 1。
**Payload length:**数据载荷的长度,单位是字节。为 7 位,或 7+16 位,或 1+64 位。 假设数 Payload length === x,若是
**Masking-key:**或 4 字节(32 位) 全部从客户端传送到服务端的数据帧,数据载荷都进行了掩码操做,Mask 为 1,且携带了 4 字节的 Masking-key。若是 Mask 为 0,则没有 Masking-key。
备注:载荷数据的长度,不包括 mask key 的长度。
Payload data:(x+y) 字节 载荷数据:包括了扩展数据、应用数据。其中,扩展数据 x 字节,应用数据 y 字节。
扩展数据:若是没有协商使用扩展的话,扩展数据数据为 0 字节。全部的扩展都必须声明扩展数据的长度,或者能够如何计算出扩展数据的长度。此外,扩展如何使用必须在握手阶段就协商好。若是扩展数据存在,那么载荷数据长度必须将扩展数据的长度包含在内。
应用数据:任意的应用数据,在扩展数据以后(若是存在扩展数据),占据了数据帧剩余的位置。载荷数据长度 减去 扩展数据长度,就获得应用数据的长度。
掩码键(Masking-key)是由客户端挑选出来的 32 位的随机数。掩码操做不会影响数据载荷的长度。掩码、反掩码操做都采用以下算法:
首先,假设:
算法描述为: original-octet-i 与 masking-key-octet-j 异或后,获得 transformed-octet-i。
j = i MOD 4 transformed-octet-i = original-octet-i XOR masking-key-octet-j
一旦 WebSocket 客户端、服务端创建链接后,后续的操做都是基于数据帧的传递。
WebSocket 根据opcode来区分操做的类型。好比0x8 表示断开链接,0x0-0x2 表示数据交互。
WebSocket 的每条消息可能被切分红多个数据帧。当 WebSocket 的接收方收到一个数据帧时,会根据FIN 的值来判断,是否已经收到消息的最后一个数据帧。
FIN=1表示当前数据帧为消息的最后一个数据帧,此时接收方已经收到完整的消息,能够对消息进行处理。FIN=0,则接收方还须要继续监听接收其他的数据帧。
此外,opcode在数据交换的场景下,表示的是数据的类型。0x01 表示文本,0x02 表示二进制。而 0x00比较特殊,表示延续帧(continuation frame),顾名思义,就是完整消息对应的数据帧还没接收完。
直接看例子更形象些。下面例子来自MDN,能够很好地演示数据的分片。客户端向服务端两次发送消息,服务端收到消息后回应客户端,这里主要看客户端往服务端发送的消息。
第一条消息 FIN=1, 表示是当前消息的最后一个数据帧。服务端收到当前数据帧后,能够处理消息。opcode=0x1,表示客户端发送的是文本类型。
第二条消息
Client: FIN=1, opcode=0x1, msg="hello"
Server: (process complete message immediately) Hi.
Client: FIN=0, opcode=0x1, msg="and a"
Server: (listening, new message containing text started)
Client: FIN=0, opcode=0x0, msg="happy new"
Server: (listening, payload concatenated to previous message)
Client: FIN=1, opcode=0x0, msg="year!"
Server: (process complete message) Happy new year to you too!
复制代码
WebSocket 为了保持客户端、服务端的实时双向通讯,须要确保客户端、服务端之间的 TCP 通道保持链接没有断开。然而,对于长时间没有数据往来的链接,若是依旧长时间保持着,可能会浪费包括的链接资源。 但不排除有些场景,客户端、服务端虽然长时间没有数据往来,但仍须要保持链接。这个时候,能够采用心跳来实现。
ping、pong 的操做,对应的是 WebSocket 的两个控制帧,opcode 分别是 0x九、0xA。
举例,WebSocket 服务端向客户端发送 ping,只须要以下代码(采用 ws 模块)
ws.ping("", false, true);
复制代码
前面提到了,Sec-WebSocket-Key/Sec-WebSocket-Accept
在主要做用在于提供基础的防御,减小恶意链接、意外链接。
做用大体概括以下:
强调:Sec-WebSocket-Key/Sec-WebSocket-Accept 的换算,只能带来基本的保障,但链接是否安全、数据是否安全、客户端/服务端是否合法的 ws 客户端、ws 服务端,其实并无实际性的保证。
WebSocket 协议中,数据掩码的做用是加强协议的安全性。但数据掩码并非为了保护数据自己,由于算法自己是公开的,运算也不复杂。除了加密通道自己,彷佛没有太多有效的保护通讯安全的办法。