JavaScriptのWebSocket技術を詳しく解説

概要

HTTP プロトコルはステートレス プロトコルであり、サーバー自体にはクライアントを識別する機能がありません。特定のクライアントとの対話を維持するには、セッションや Cookie などの外部メカニズムを使用する必要があります。これは、特にサーバーとクライアントが継続的にデータを交換する必要がある状況 (オンライン チャットなど) では、多少の不便をもたらします。この問題を解決するために、HTML5 ではブラウザの WebSocket API が提案されています。

WebSocket の主な機能は、サーバーとクライアント間の全二重通信を可能にすることです。たとえば、HTTP プロトコルは電子メールの送信に似ており、送信後は相手の応答を待つ必要があります。WebSocket は電話をかけるのと似ており、サーバーとクライアントは同時にデータを相互に送信できます。そしてそれらの間には継続的に開いているデータチャネルがあります。

WebSocket プロトコルは Ajax メソッドを完全に置き換えて、テキストとバイナリ データをサーバーに送信するために使用でき、「同一ドメイン制限」はありません。

WebSocket は HTTP プロトコルを使用せず、独自のプロトコルを使用します。ブラウザによって行われる WebSocket リクエストは次のようになります:

GET / HTTP/1.1
Connection: Upgrade
Upgrade: websocket
Host: example.com
Origin: null
Sec-WebSocket-Key: sN9cRrP/n9NdMgdcy2VJFQ==
Sec-WebSocket-Version: 13
上記のヘッダー情報は、アップグレード用の HTTP ヘッダーがあることを示しています。 HTTP1.1プロトコルでは、Upgradeヘッダ情報で通信プロトコルをHTTP/1.1から項目で指定されたプロトコルに切り替えることが規定されている。 「接続: アップグレード」は、ブラウザがサーバーに、可能であれば webSocket プロトコルにアップグレードするように通知することを意味します。 Origin は、ブラウザのドメイン名がサーバーによって許可された範囲内にあるかどうかを確認するために使用されます。 Sec-WebSocket-Key はハンドシェイク プロトコルに使用されるキーで、base64 でエンコードされた 16 バイトのランダムな文字列です。

サーバー側の WebSocket 応答は、

HTTP/1.1 101 スイッチング プロトコルです
接続: アップグレード
アップグレード: websocket
Sec-WebSocket-Accept: fFBooB7FAkLlXgRSz0BT3v4hq5s=
Sec-WebSocket-Origin: null
Sec -WebSock と場所: ws: //example.com/

サーバーはまた、「接続: アップグレード」を使用して、プロトコルを変更する必要があることをブラウザーに通知します。 Sec-WebSocket-Accept は、サーバーがブラウザーによって提供された Sec-WebSocket-Key 文字列の後に「258EAFA5-E914-47DA-95CA-C5AB0DC85B11」文字列を追加し、sha-1 のハッシュ値を取得することを意味します。ブラウザはこの値を検証して、実際に webSocket リクエストに応答したターゲット サーバーであることを証明します。 Sec-WebSocket-Location は、通信用の WebSocket URL を表します。

WebSocket プロトコルは ws で表されることに注意してください。さらに、暗号化された WebSocket プロトコルを表し、HTTPs プロトコルに対応する wss プロトコルがあります。
ハンドシェイクが完了すると、WebSocket プロトコルが TCP プロトコルの上に位置し、データの送信を開始します。

WebSocket プロトコルにはサーバーのサポートが必要です。現在、より一般的な実装は、node.js に基づくソケット.io です。その他の実装については、Wikipedia を参照してください。ブラウザ側に関しては、現在、携帯電話の Opera Mini と Android ブラウザを除き、すべての主流ブラウザが WebSocket プロトコル (IE 10 以降を含む) をサポートしています。

クライアント側

ブラウザ側の WebSocket プロトコルの処理は次の 3 つにすぎません:

接続の確立と切断
データの送信と受信
エラーの処理

接続の確立と切断

まずall の場合、クライアントは、ウィンドウ オブジェクトに WebSocket 属性があるかどうかを確認して、ブラウザが WebSocket をサポートしているかどうかを確認する必要があります。

if(window.WebSocket != undefined) {
 
 // WebSocket代码
 
}

次に、サーバーとの接続の確立を開始します (サーバーはローカル マシンの 1740 ポートであり、WS プロトコルを使用する必要があると想定されています)。

if(window.WebSocket != undefined) {
 
 var connection = new WebSocket('ws://localhost:1740');
 
}

接続を確立した後、WebSocket インスタンス オブジェクト (つまり、上記のコードの接続) には、現在のステータスを示し、次の 4 つの値を取ることができる readState 属性があります。

0: 接続中
1: 接続成功
2: 終了
3: 接続終了
ハンドシェイクプロトコルが成功すると、readyState が 0 から 1 に変化し、open イベントがトリガーされます。このとき、サーバーに情報を送信できます。 open イベントのコールバック関数を指定できます。

connection.onopen = wsOpen;

function wsOpen (event) {
console.log(‘Connected to: ‘ + event.currentTarget.URL);
}

WebSocket 接続を閉じると、close イベントがトリガーされます。

connection.onclose = wsClose;

function wsClose () {
console.log(“Closed”);
}
 
connection.close();

データの送信とデータの受信

接続が確立された後、クライアントは send メソッドを通じてサーバーにデータを送信します。

connection.send(message);
文字列の送信に加えて、Blob オブジェクトまたは ArrayBuffer オブジェクトを使用してバイナリ データを送信することもできます。

// 使用ArrayBuffer发送canvas图像数据
 
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];
 
}
 
connection.send(binary.buffer);
// 使用Blob发送文件
var file = document.querySelector(‘input[type=”file”]&#39;).files[0];
connection.send(file);

クライアントがサーバーから送信されたデータを受信すると、メッセージ イベントがトリガーされます。メッセージ イベントのコールバック関数を定義することで、サーバーから返されたデータを処理できます。

connection.onmessage = wsMessage;

function wsMessage (event) {
console.log(event.data);
}

上記のコードのコールバック関数 wsMessage のパラメーターはイベント オブジェクトの Event であり、オブジェクトの data 属性にはサーバーから返されたデータが含まれています。

バイナリデータを受信する場合は、接続オブジェクトの形式を blob または arraybuffer に設定する必要があります。

connection.binaryType = 'arraybuffer';
 
connection.onmessage = function(e) {
 console.log(e.data.byteLength); // ArrayBuffer对象有byteLength属性
};

エラーの処理

エラーが発生すると、ブラウザは WebSocket インスタンス オブジェクトのエラー イベントをトリガーします。

connection.onerror = wsError;

function wsError(event) {
console.log(“Error: “ + event.data);
}

服务器端

服务器端需要单独部署处理WebSocket的代码。下面用node.js搭建一个服务器环境。

var http = require('http');
 
var server = http.createServer(function(request, response) {});

假设监听1740端口。

server.listen(1740, function() {
 
 console.log((new Date()) + ' Server is listening on port 1740');
 
});

接着启动WebSocket服务器。这需要加载websocket库，如果没有安装，可以先使用npm命令安装。

var WebSocketServer = require('websocket').server;
 
var wsServer = new WebSocketServer({
 
 httpServer: server
 
});
   
WebSocket服务器建立request事件的回调函数。
var connection;wsServer.on(‘request', function(req){

connection = req.accept(‘echo-protocol', req.origin);
});

上面代码的回调函数接受一个参数req，表示request请求对象。然后，在回调函数内部，建立WebSocket连接connection。接着，就要对connection的message事件指定回调函数。

wsServer.on(‘request', function(r){
 
 connection = req.accept(‘echo-protocol', req.origin);

<span class="nx">connection</span><span class="p">.</span><span class="nx">on</span><span class="p">(</span><span class="s1">&#39;message&#39;</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">message</span><span class="p">)</span> <span class="p">{</span>
 <span class="kd">var</span> <span class="nx">msgString</span> <span class="o">=</span> <span class="nx">message</span><span class="p">.</span><span class="nx">utf8Data</span><span class="p">;</span>
 <span class="nx">connection</span><span class="p">.</span><span class="nx">sendUTF</span><span class="p">(</span><span class="nx">msgString</span><span class="p">);</span>
<span class="p">});</span>
});

最后，监听用户的disconnect事件。

connection.on('close', function(reasonCode, description) {
 
 console.log(connection.remoteAddress + ' disconnected.');
 
});

使用ws模块，部署一个简单的WebSocket服务器非常容易。

var WebSocketServer = require('ws').Server;
var wss = new WebSocketServer({ port: 8080 });
 
wss.on('connection', function connection(ws) {
 ws.on('message', function incoming(message) {
 console.log('received: %s', message);
 });
 
 ws.send('something');
});

Socket.io简介

Socket.io是目前最流行的WebSocket实现，包括服务器和客户端两个部分。它不仅简化了接口，使得操作更容易，而且对于那些不支持WebSocket的浏览器，会自动降为Ajax连接，最大限度地保证了兼容性。它的目标是统一通信机制，使得所有浏览器和移动设备都可以进行实时通信。

第一步，在服务器端的项目根目录下，安装socket.io模块。

$ npm install socket.io

第二步，在根目录下建立app.js，并写入以下代码（假定使用了Express框架）。

var app = require('express')();
var server = require('http').createServer(app);
var io = require('socket.io').listen(server);
 
server.listen(80);
 
app.get('/', function (req, res) {
 res.sendfile(__dirname + '/index.html');
});

上面代码表示，先建立并运行HTTP服务器。Socket.io的运行建立在HTTP服务器之上。

第三步，将Socket.io插入客户端网页。

然后，在客户端脚本中，建立WebSocket连接。

var socket = io.connect('http://localhost:80');

由于本例假定WebSocket主机与客户端是同一台机器，所以connect方法的参数是http://localhost。接着，指定news事件（即服务器端发送news）的回调函数。

socket.on('news', function (data){
 console.log(data);
});

最后，用emit方法向服务器端发送信号，触发服务器端的anotherNews事件。

socket.emit('anotherNews');

请注意，emit方法可以取代Ajax请求，而on方法指定的回调函数，也等同于Ajax的回调函数。
第四步，在服务器端的app.js，加入以下代码。

io.sockets.on('connection', function (socket) {
 socket.emit('news', { hello: 'world' });
 socket.on('anotherNews', function (data) {
 console.log(data);
 });
})
;

上面代码的io.sockets.on方法指定connection事件（WebSocket连接建立）的回调函数。在回调函数中，用emit方法向客户端发送数据，触发客户端的news事件。然后，再用on方法指定服务器端anotherNews事件的回调函数。

不管是服务器还是客户端，socket.io提供两个核心方法：emit方法用于发送消息，on方法用于监听对方发送的消息。