菜单

WebSocket教程

2019年2月19日 - XML

WebSocket 教程

2017/05/15 · 基本功技术 ·
websocket

原稿出处:
阮一峰   

WebSocket
是一种互连网通讯协议,很多尖端功效都须要它。

本文介绍 WebSocket 协议的采取办法。

图片 1

WebSocket

指出科学的题材,往往等于化解了难题的差不离。——海森堡

图片 2

Learn.png

            public SimpleSocket()
            {
                this.closeLatch = new CountDownLatch(1);
            }

            public boolean awaitClose(int duration, TimeUnit unit) throws InterruptedException
            {
                return this.closeLatch.await(duration,unit);
            }

            @OnWebSocketClose
            public void onClose(int statusCode, String reason)
            {
                System.out.printf("Connection closed: %d - %s%n",statusCode,reason);
                this.session = null;
                this.closeLatch.countDown(); // trigger latch
            }

            @OnWebSocketConnect
            public void onConnect(Session session)
            {
                System.out.printf("Got connect: %s%n",session);
                this.session = session;
                try
                {
                    Future<Void> fut;

                    //向服务端传送指令
                    map.put("ACTION","REMIND");

                    JSONObject dataJson=new JSONObject(map);

                    fut = session.getRemote().sendStringByFuture(dataJson.toString());

                    fut.get(2,TimeUnit.SECONDS); // wait for send to complete.

                    session.close(StatusCode.NORMAL,"I'm done");
                }
                catch (Throwable t)
                {
                    t.printStackTrace();
                }
            }

            @OnWebSocketMessage
            public void onMessage(String msg)
            {
                //接受服务端接受的json字符串
                JSONObject dataJson=new JSONObject(msg);

                //判断指令
                if ("REMIND".equals(dataJson.get("ACTION"))) {

                    //// TODO: 2017/11/20
                }else{

                    //// TODO: 2017/11/20
                }

            }
        }

    `注:java客户端代码使用环境适于Jdk8`

-   服务端代码

        @ServerEndpoint("/api")
        public class WebSocketTestChat {
            Set<Session> session_list =null;
            @OnMessage
            public void onMessage(String message, Session session) 
                throws IOException, InterruptedException {

                JSONObject dataJson=new JSONObject(message);

                String action = (String) dataJson.get("ACTION");
                if(action.equals("REMIND")){
                    //// TODO: 2017/11/20

                }else{
                    //// TODO: 2017/11/20
                }
                session_list =session.getOpenSessions();
                for(Session s:session_list){
                    s.getBasicRemote().sendText(dataJson.toString());
                }
            }
            @OnOpen
            public void onOpen () {
            }

            @OnClose
            public void onClose () {
            }
        }

① 、为啥需求 WebSocket?

第三接触 WebSocket 的人,都会问一样的题材:大家早已有了 HTTP
协议,为何还索要另1个协商?它能拉动什么便宜?

答案很简单,因为 HTTP 协议有3个通病:通讯只可以由客户端发起。

比喻来说,我们想打听今日的天气,只可以是客户端向服务器发出请求,服务器再次回到查询结果。HTTP
协议做不到服务器主动向客户端推送新闻。

图片 3

那种单方面请求的特点,注定了倘诺服务器有连日的情事变化,客户端要获知就老大麻烦。大家不得不选取“轮询”:每隔一段时候,就发生二个摸底,明白服务器有没有新的消息。最叹为观止的景色就是聊天室。

轮询的频率低,至极浪费能源(因为必须不停连接,或许 HTTP
连接始终开拓)。由此,工程师们一向在思索,有没有更好的主意。WebSocket
就是这么表达的。

二、简介

WebSocket 协议在2008年诞生,二〇一一年变为国际标准。全部浏览器都曾经襄助了。

它的最大特色就是,服务器可以积极向客户端推送消息,客户端也得以主动向服务器发送音信,是的确的双向平等对话,属于服务器推送技术的一种。

图片 4

其它特色包涵:

(1)建立在 TCP 磋商之上,服务器端的落实相比较不难。

(2)与 HTTP 协议抱有美好的包容性。暗中认同端口也是80和443,并且握手阶段采用HTTP 协议,因而不不难屏蔽,能因而各样 HTTP 代理服务器。

(3)数据格式比较轻量,品质费用小,通讯高效。

(4)可以发送文书,也得以发送二进制数据。

(5)没有同源限制,客户端可以与自由服务器通讯。

(6)协议标识符是ws(假使加密,则为wss),服务器网址就是 U奥迪Q3L。

ws://example.com:80/some/path

1
2
ws://example.com:80/some/path
 

图片 5

叁 、客户端的简练示例

WebSocket 的用法卓绝不难。

上边是二个网页脚本的事例(点击这里看运营结果),基本上一眼就能知道。

var ws = new WebSocket(“wss://echo.websocket.org”); ws.onopen =
function(evt) { console.log(“Connection open …”); ws.send(“Hello
WebSockets!”); }; ws.onmessage = function(evt) { console.log( “Received
Message: ” + evt.data); ws.close(); }; ws.onclose = function(evt) {
console.log(“Connection closed.”); };

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
var ws = new WebSocket("wss://echo.websocket.org");
 
ws.onopen = function(evt) {
  console.log("Connection open …");
  ws.send("Hello WebSockets!");
};
 
ws.onmessage = function(evt) {
  console.log( "Received Message: " + evt.data);
  ws.close();
};
 
ws.onclose = function(evt) {
  console.log("Connection closed.");
};      
 

肆 、客户端的 API

WebSocket 客户端的 API 如下。

4.1 WebSocket 构造函数

WebSocket 对象作为2个构造函数,用于新建 WebSocket 实例。

var ws = new WebSocket(‘ws://localhost:8080’);

1
2
var ws = new WebSocket(‘ws://localhost:8080’);
 

推行上边语句之后,客户端就会与服务器举行连接。

实例对象的享有属性和格局清单,参见这里

4.2 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; }

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
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;
}
 

4.3 webSocket.onopen

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

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

1
2
3
4
ws.onopen = function () {
  ws.send(‘Hello Server!’);
}
 

假如要指定三个回调函数,可以利用add伊芙ntListener`方法。

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

1
2
3
4
ws.addEventListener(‘open’, function (event) {
  ws.send(‘Hello Server!’);
});
 

4.4 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 });

1
2
3
4
5
6
7
8
9
10
11
12
13
14
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
});
 

4.5 webSocket.onmessage

实例对象的onmessage品质,用于钦点收到服务器数据后的回调函数。

ws.onmessage = function(event) { var data = event.data; // 处理数据 };
ws.add伊夫ntListener(“message”, function(event) { var data = event.data;
// 处理数据 });

1
2
3
4
5
6
7
8
9
10
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”); } }

1
2
3
4
5
6
7
8
9
10
11
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); };

1
2
3
4
5
6
7
8
9
10
11
12
// 收到的是 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);
};
 

4.6 webSocket.send()

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

发送文书的例证。

ws.send(‘your message’);

1
2
ws.send(‘your message’);
 

发送 Blob 对象的例子。

var file = document .querySelector(‘input[type=”file”]’) .files[0];
ws.send(file);

1
2
3
4
5
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

1
2
3
4
// 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

4.7 webSocket.bufferedAmount

实例对象的bufferedAmount本性,表示还有稍稍字节的二进制数据没有发送出去。它可以用来判断发送是或不是停止。

var data = new ArrayBuffer(一千0000); socket.send(data); if
(socket.bufferedAmount === 0) { // 发送完成 } else { // 发送还没竣事 }

1
2
3
4
5
6
7
8
9
var data = new ArrayBuffer(10000000);
socket.send(data);
 
if (socket.bufferedAmount === 0) {
  // 发送完毕
} else {
  // 发送还没结束
}
 

4.8 webSocket.onerror

实例对象的onerror质量,用于钦赐报错时的回调函数。

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

1
2
3
4
5
6
7
8
socket.onerror = function(event) {
  // handle error event
};
 
socket.addEventListener("error", function(event) {
  // handle error event
});
 

五 、服务端的落到实处

WebSocket
服务器的兑现,可以查阅维基百科的列表

常用的 Node 达成有以下三种。

切实的用法请查看它们的文档,那里不详细介绍了。

六、WebSocketd

上边,小编要引进一款尤其尤其的 WebSocket
服务器:Websocketd

它的最大特点,就是后台脚本不限语言,标准输入(stdin)就是 WebSocket
的输入,标准输出(stdout)就是 WebSocket 的输出。

图片 6

举例来说来说,上边是3个 Bash 脚本counter.sh

#!/bin/bash echo 1 sleep 1 echo 2 sleep 1 echo 3

1
2
3
4
5
6
7
8
9
10
#!/bin/bash
 
echo 1
sleep 1
 
echo 2
sleep 1
 
echo 3
 

指令行下运营那一个剧本,会输出一 、贰 、3,每一种值时期距离1秒。

$ bash ./counter.sh 1 2 3

1
2
3
4
5
$ bash ./counter.sh
1
2
3
 

现在,启动websocketd,钦点这一个剧本作为劳务。

$ websocketd –port=8080 bash ./counter.sh

1
2
$ websocketd –port=8080 bash ./counter.sh
 

下面的吩咐会运营二个 WebSocket
服务器,端口是8080。每当客户端连接这么些服务器,就会举办counter.sh剧本,并将它的出口推送给客户端。

var ws = new WebSocket(‘ws://localhost:8080/’); ws.onmessage =
function(event) { console.log(event.data); };

1
2
3
4
5
6
var ws = new WebSocket(‘ws://localhost:8080/’);
 
ws.onmessage = function(event) {
  console.log(event.data);
};
 

地点是客户端的 JavaScript 代码,运营之后会在控制台依次输出一 、② 、3。

有了它,就可以很有利地将命令行的出口,发给浏览器。

$ websocketd –port=8080 ls

1
2
$ websocketd –port=8080 ls
 

地点的命令会执行ls一声令下,从而将当前目录的内容,发给浏览器。使用那种办法实时监察服务器,简直是轻易(代码)。

图片 7

更加多的用法可以参照官方示例

图片 8

websocketd 的本色,就是命令行的 WebSocket
代理。只要命令行能够执行的顺序,都可以因此它与浏览器举办 WebSocket
通讯。下边是一个 Node
落成的回音服务greeter.js

process.stdin.setEncoding(‘utf8’); process.stdin.on(‘readable’,
function() { var chunk = process.stdin.read(); if (chunk !== null) {
process.stdout.write(‘data: ‘ + chunk); } });

1
2
3
4
5
6
7
8
9
process.stdin.setEncoding(‘utf8’);
 
process.stdin.on(‘readable’, function() {
  var chunk = process.stdin.read();
  if (chunk !== null) {
    process.stdout.write(‘data: ‘ + chunk);
  }
});
 

启航那么些剧本的通令如下。

$ websocketd –port=8080 node ./greeter.js

1
2
$ websocketd –port=8080 node ./greeter.js
 

法定仓库还有其余各个语言的例子。

七 、参考链接

图片 9

相关文章

发表评论

电子邮件地址不会被公开。 必填项已用*标注

网站地图xml地图