websocket到底是个啥

websocket到底是个啥

以前在学习时经常听到websocket，做项目的时候也接触过，但对其没有一个明确的认知，突发奇想研究了一下阮一峰老师的WebSocket 教程，做个记录
阮一峰老师原文地址.

websocket实际上和http一样是一种数据传输协议，出现这种协议的目的是为了解决http只能由客户端向服务端发送请求而服务端无法主动推送数据到客户端的问题

websocket的几个特点：
1、和http与https一样有非安全的ws和非安全的wss
2、端口使用的也是80端口和443端口，并且握手阶段采用 HTTP 协议，因此握手时不容易屏蔽，能通过各种 HTTP 代理服务器。
3、不受浏览器同源限制，所以可以用来解决跨域
4、发送的数据可以是文本也可以是Blob
5、协议标识符ws
6、websocket是一种全双工通信协议

websocket服务端有多种实现在这放的是node实现详情见下方链接
WebSocket-Node

websocket客户端实现实例(

//创建websocket
var ws = new WebSocket('ws://localhost:8080')

//连接服务端成功后的回调函数
ws.onopen = function(evt){
	//连接成功后向服务器发送数据 
	ws.send('hello websocket')
}
//接收到服务器数据时调用的回调函数
ws.onmessage = function(evt){
	// 打印服务器返回的数据
	console.log(evt.data)
	// 关闭连接
	ws.close()
}
//监听连接断开时的回调函数
ws.onclose = function(evt){
	console.log('connection close)
}

客户端的 API

WebSocket 客户端的 API 如下。

WebSocket 构造函数

WebSocket 对象作为一个构造函数，用于新建 WebSocket 实例。
var ws = new WebSocket(‘ws://localhost:8080’);
执行上面语句之后，客户端就会与服务器进行连接。

实例对象的所有属性和方法清单，参见这里。

webSocket.readyState

readyState属性返回实例对象的当前状态，共有四种。
CONNECTING：值为0，表示正在连接。
OPEN：值为1，表示连接成功，可以通信了。
CLOSING：值为2，表示连接正在关闭。
CLOSED：值为3，表示连接已经关闭，或者打开连接失败。
下面是一个示例。
switch (ws.readyState) {
case WebSocket.CONNECTING:
// do something
break;
case WebSocket.OPEN:
// do something
break;
case WebSocket.CLOSING:
// do something
break;
case WebSocket.CLOSED:
// do something
break;
default:
// this never happens
break;
}

webSocket.onopen

实例对象的onopen属性，用于指定连接成功后的回调函数。
ws.onopen = function () {
ws.send(‘Hello Server!’);
}
如果要指定多个回调函数，可以使用addEventListener方法。
ws.addEventListener(‘open’, function (event) {
ws.send(‘Hello Server!’);
});

webSocket.onclose

实例对象的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属性，用于指定收到服务器数据后的回调函数。
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”);
}
}
除了动态判断收到的数据类型，也可以使用binaryType属性，显式指定收到的二进制数据类型。
// 收到的是 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()方法用于向服务器发送数据。

发送文本的例子。
ws.send(‘your message’);
发送 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);

webSocket.bufferedAmount

实例对象的bufferedAmount属性，表示还有多少字节的二进制数据没有发送出去。它可以用来判断发送是否结束。
var data = new ArrayBuffer(10000000);
socket.send(data);
if (socket.bufferedAmount === 0) {
// 发送完毕
} else {
// 发送还没结束
}

webSocket.onerror

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

socket.onerror = function(event) {
// handle error event
};

socket.addEventListener(“error”, function(event) {
// handle error event
});