WebSocket 是一种网络通信协议
服务器可以主动向客户端推送信息,客户端也可以主动向服务器发送信息你,属于
服务器推送技术
的一种
- 1)建立在tcp协议之上
- 2)与http协议有良好的兼容性,默认端口80和443
- 3)数据格式轻量化,性能开销小
- 4)可以发送文本,也可以发送二进制数据
- 5)没有同源限制,任意通信
- 6)协议标识符为
ws
(如果加密,则为wss
),服务器网址为url
WebSocke客户端的API
- WebSocke构造函数
新建WebSocke实例,客户端与服务器进行连接。
var ws = new WebSocke('ws://localhost:8080')
- webSocket.readyState
readyState
属性返回实例对象的当前状态,共有四种。
- CONNECTING:值为0,表示正在连接
- OPEN: 值为1,表示连接成功,可以通信
- CLOSING: 值为2,表示连接正在关闭
- CLOSED: 值为3,表示连接已经关闭,或打开失败
- 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 }
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
对象或Arraybuffe
r对象)。
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
});