こんにちは、summerwind です。
今日は「東京Node学園 4時限目」ということで、Node.js ハッカソンにきています。
今回の会場は @nifty エンジニアサポートさんにご提供いただきました。お菓子の差し入れなどもいただきありがとうございます！
さて、会場で Jxck 先生に「ぜひブログにもなんか書いて」と言ってもらったので、今回は先日リリースされた Node v0.7.5 の変更点について、いくつか簡単にピックアップして紹介したいと思います。全ての変更点については日本語訳した ChangeLog をご確認ください。
まずは、crypto モジュールに追加された getDiffieHallman() 関数を紹介したいと思います。
従来から crypto.createDiffieHellman() 関数を利用することで Diffie-Hellman 方式の共有鍵を生成することはできましたが、 今回追加された getDiffieHellman() を利用すると、より容易に共通鍵を用意することができます。
マニュアルには下記のような使い方が記載されています。
var crypto = require('crypto');
var alice = crypto.getDiffieHellman('modp5');
var bob = crypto.getDiffieHellman('modp5');
alice.generateKeys();
bob.generateKeys();
var alice_secret = alice.computeSecret(bob.getPublicKey(), 'binary', 'hex');
var bob_secret = bob.computeSecret(alice.getPublicKey(), 'binary', 'hex');
/* alice_secret and bob_secret should be the same */
console.log(alice_secret == bob_secret);
実際のコードの変更内容はコミットログで確認することができます。コードが気になる方はぜひこちらもご確認ください。
cluster モジュールは，HTTP を含めた TCP 接続を複数の子プロセス (ワーカプロセス) で処理することにより，特にマルチコア環境でのスループット (リクエスト／秒) を向上するための機能です．cluster モジュールによって API が提供されるようになり，その翌週の v0.6.0 リリース数時間前にはその API が変更されるというドタバタぶりでしたwlistening = socket(...); // ソケットをオープン
bind(listening, ...); // ローカルアドレス&ポートを割り当て
listen(listening, ...); // リスニングソケットに変換
for (;;) {
connected = accept(listening, ...); // 接続済みソケットを返す
...
close(connected);
}
socket(), bind(), listen() でリスニングソケットを準備して，accept() でリスニングソケットに届いた接続済みソケットを取得します．accept() を select() 等のシステムコールによって「多重化」するイベントループを使うためにこの問題はありませんが，しばらくの間それは忘れましょう．fork() して新しいプロセスを作成するというものです．listening = socket(...); // ソケットをオープン
bind(listening, ...); // ローカルアドレス&ポートを割り当て
listen(listening, ...); // リスニングソケットに変換
for (;;) {
connected = accept(listening, ...); // 接続済みソケットを返す
if (fork() == 0) {
// 子プロセス (親プロセスとは並行に実行される)
...
exit(0);
}
// 親プロセス
close(connected);
}
exec() (現在のプロセス上で別のプログラムを実行) すれば，CGI の動作になります．// マスタ
listening = socket(...); // ソケットをオープン
bind(listening, ...); // ローカルアドレス&ポートを割り当て
listen(listening, ...); // リスニングソケットに変換
for (;;) {
connected = accept(listening, ...); // 接続済みソケットを返す
worker = socket(...); // ワーカとの通信用のソケットをオープン
connect(worker, ...); // ワーカに接続
... // クライアントとワーカの間でデータを転送
close(worker);
close(connected);
}
accept() もワーカとの接続や送受信も，全て多重化されてイベントループの中で行われるということにしてください．connect() で接続するワーカをラウンドロビンなどの方法で切り替えることにより，複数のワーカにクライアントからの処理を分散することができます．新しいクライアントをどのワーカで処理させるか (ロードバランシング) はマスタが判断することになります．// マスタ
listening = socket(...); // ソケットをオープン
bind(listening, ...); // ローカルアドレス&ポートを割り当て
listen(listening, ...); // リスニングソケットに変換
for (;;) {
connected = accept(listening, ...); // 接続済みソケットを返す
... // connected をワーカに転送する
close(connected);
}
cluster.schedulingPolicy に cluster.SCHED_RR を指定します (または、NODE_CLUSTER_SCHED_POLICY 環境変数に rr を指定します)。// マスタ listening = socket(...); // ソケットをオープン bind(listening, ...); // ローカルアドレス&ポートを割り当て ... // ソケットをワーカに渡す
listen()～accept() はマスタで実行していましたが，この方式ではワーカがそれを実行します．// ワーカ
... // マスタからソケットを受け取る
listen(listening, ...); // ソケットをリスニングソケットに変換
for (;;) {
connected = accept(listening, ...); // 接続済みソケットを返す
...
close(connected);
}
cluster.schedulingPolicy に cluster.SCHED_NONE を指定します (または、NODE_CLUSTER_SCHED_POLICY 環境変数に none を指定します)。cluster モジュールを使用しない単純な HTTP サーバの例です．var http = require('http');
http.createServer(function (req, res) {
res.writeHead(200, {'Content-Type': 'text/plain'});
res.end('Hello World\n');
}).listen(1337, 'localhost');
cluster モジュールを使わず直接実行すると，http.Server (実際には net.Server) の listen() メソッドは，内部的にソケットの socket() と bind(), listen() と accept() を呼び出します．cluster モジュールを使用すると，var cluster = require('cluster');
var http = require('http');
var numCPUs = require('os').cpus().length;
if (cluster.isMaster) {
// マスタ
for (var i = 0; i < numCPUs; i++) {
cluster.fork(); // ワーカを起動
}
cluster.on('death', function(worker) {
console.log('worker ' + worker.pid + ' died');
});
} else {
// ワーカ
http.createServer(function (req, res) {
res.writeHead(200, {'Content-Type': 'text/plain'});
res.end('Hello World\n');
}).listen(1337, 'localhost');
}
cluster を使わない例と全く同じですが，http.Server の listen() メソッドの動作が変わります．ワーカとして実行されているプロセスでは，http.Server の listen() メソッドはマスタに「"localhost" に 1337 番でバインドされたソケットをよこせ」という要求 (プロセス間通信) を行います．そこでマスタは socket(), bind() を呼び出してソケットを作成し，ワーカに転送します．ワーカはそのソケットに対して listen(), accept() を実行します．"localhost" に 1337 番でバインドされたソケットをよこせ」とマスタに要求すると，マスタは先ほど作成したソケットを転送します．これにより，複数のワーカ間でリスニングソケットが共有されます．cluster モジュールを使ってみてください．| v0.4.12 (linux) | v0.6.0 (linux) | |
|---|---|---|
| http_simple.js /bytes/1024 | 5461 r/s | 6263 r/s |
| io.js read | 19.75 mB/s | 26.63 mB/s |
| io.js write | 21.60 mB/s | 17.40 mB/s |
| startup.js | 74.7 ms | 49.6 ms |
| v0.4.12 (windows) | v0.6.0 (windows) | |
|---|---|---|
| http_simple.js /bytes/1024 | 3858 r/s | 5823 r/s |
| io.js read | 12.41 mB/s | 26.51 mB/s |
| io.js write | 12.61 mB/s | 33.58 mB/s |
| startup.js | 152.81 ms | 52.04 ms |
$ mkdir foo
$ express fooで、プロジェクトを自動生成できます。 /test に app.test.js というテストコードがあります。これは Expresso 用のテストコードですが、いまの Expresso では動きません。そこでテストコードを以下のように修正します。
を実行すると、テストが走ります。Github のコードは修正されているので、もうしばらく待っていたら解消すると思います。$ expresso
$ mkdir lib
$ mv app.js lib外部ファイルのパスを修正します。
$ expresso -I lib -c
server.js | |
|---|---|
| では、サーバ側のコードから見ていきます。 | |
| 依存しているモジュールをインポートしています。インポートしているのは、 Connect, Socket.IO, SessionWebSocket です。 | var connect = require("connect");
var io = require("socket.io");
var sws = require("../sws.js")();
|
| まずは Connect で Web サーバをつくります。 Connect は Web アプリケーション用のミドルウェアフレームワークです。決められたインターフェースに従ってつくられたアプリケーションを pluggable なミドルウェアとして扱うことができます。 | |
| createServer の引数に渡しているのがミドルウェアです。 | var server = connect.createServer(
|
| HTTP のセッションを管理しています。 | connect.cookieDecoder(),
connect.session(),
|
| 今回の主役のひとり。セッションのトークンを発行します。 | sws.http,
|
| これは静的ファイルを扱います。 | connect.staticProvider(__dirname+"/static")
);
|
| サーバをポート 8000 番で起動します。 | server.listen(8000);
|
| 次に、 WebSocket のサーバを準備します。 | |
| さきほどの Web サーバが WebSocket を扱えるようにしてやります。 | var socket = io.listen(server);
|
| イベントハンドラを設定します。引数に渡している sws.ws がもうひとりの主役です。 WebSocket 側のセッションを管理しています。こんなふうにコールバックにコールバックを渡すあたりがたまらないですね。 | socket.on('connection', sws.ws(function(client) {
|
| 認証済みの場合のイベントハンドラです。セッション ID を出力してみます。 | client.on("secure", function() {
console.log("SECURE");
console.log(client.session.req.sessionID);
});
|
| 認証が済んでいない場合のイベントハンドラです。 | client.on("insecure", function() {
console.log("INSECURE ACCESS");
});
|
| メッセージ受信時のイベントハンドラです。 | client.on("message", function(msg) {
client.send(msg);
console.log("MSG:"+msg);
});
}));
|
sws.js | |
|---|---|
var util = require('util');
| |
| では、いよいよセッション管理のミドルウェアについて見ていきます。 | |
| 関数を exports にセットしています。先ほどアプリケーション側で require したときに呼んでいました。引数からオプションを受け取るために関数にしていたわけですね。 | module.exports = function verifier(options)
{
|
| デフォルトの設定です。セッションの生存期間 (ttl = time to live) を設定しています。 | var defaults = {
ttl: 30*1000 // 30 秒
};
|
| 引数でもらったオプションを反映させています。 | for (var k in options) {
defaults[k] = options[k];
}
|
| 複数のセッションを扱うためのオブジェクトです。 | var session_jar = {};
|
| この関数は、セッションのトークンを発行するミドルウェアと、 WebSocket 用のセッション管理の関数をプロパティにもつオブジェクトを返します。 | return {
|
| 先ほど createServer に渡していたミドルウェアです。 リクエストオブジェクト、レスポンスオブジェクト、next という関数を引数にとる、というのが決められたインターフェースです。 | http:function give_token(req, res, next) {
|
| リクエストのヘッダを参照し、 'x-access-request-token' フィールドが 'simple' だったらトークンを生成します。 | if (req.headers["x-access-request-token"]) {
if (req.headers["x-access-request-token"].toLowerCase()==="simple") {
var token = Math.random();
|
| ユニークな値をとれるまで繰り返します。 | while (session_jar[token]) {
token = Math.random();
}
|
| トークンをキーとしてセッションデータと発行した日時を保存しています。 req.session は connect.session が生成したものです。 | var tmp = Date.now();
session_jar[token] = {
session: req.session,
date: tmp,
id: req.sessionID
};
|
| レスポンスを生成します。トークンと発行日時を JSON で返しています。 | res.writeHead(200);
res.end('{"x-access-token": "'+token+';'+tmp+'"}');
return;
}
}
|
| 'x-access-request-token' フィールドがリクエストのヘッダにない場合は、このミドルウェアはやることがないので、 next を呼んで次のミドルウェアに処理をまかせます。 | if (next) {
next();
}
}
|
| こちらは WebSocket のセッションを管理する関数です。 | , ws: function attach_client(cb) {
return function route_client(client) {
|
| トークンの有効性をチェックする関数を定義します。 | function verify(token) {
var tmp = session_jar[token];
|
| セッションの期限切れをチェックしています。認証されたら削除しているので、トークンは１回だけしか使わない仕様になっています。 | if (tmp && tmp.date > Date.now() - defaults.ttl) {
var session = tmp;
delete session_jar[token];
return session;
}
return false;
}
|
| 'message' に対するイベントハンドラを設定します。トークンをチェックしています。この関数を実行するのは最初にメッセージを受信したときだけです。 | client.once('message', function first_verify(msg) {
|
| メッセージで渡されたトークンが有効な場合は、クライアントにセッションデータを設定して、'secure' イベントをクライアントに対して発行します。 | var session = verify(msg) || false;
if (session) {
client._session = session;
client.session = session.session;
client.emit("secure");
|
| セッションが有効だったので、 client.on を元に戻して、退避しておいた 'message' に対するイベントハンドラをバインドします。退避する処理は下の方にでてきます。 | client.on = oldon;
for (var i = 0, l = onmsgs.length; i < l; i++) {
client.on('message', onmsgs[i]);
}
}
|
| セッションデータがないので 'insecure' イベントをクライアントに対して発行します。 | else {
client.emit("insecure");
}
});
|
| 'message' イベントに対するイベントハンドラは、セッションが有効かどうかのチェックが済んだあとから実行されるようにしたいので、 client.on を 'message' イベントのハンドラだけ退避するように書き換えます。 | var onmsgs = [];
var oldon = client.on;
client.on = function(name, fn) {
if (name === "message") onmsgs[onmsgs.length] = fn;
else oldon.apply(this, arguments);
};
|
| 呼び出し元にクライアントを渡します。 | cb(client);
};
}
};
};
|
client.js | |
|---|---|
| 次にクライアント側を見ていきます。 | |
| SessionWebSocket で、トークンのやりとりをしてから、 'message' に対するイベントハンドラをバインドします。 | SessionWebSocket(function(socket){
socket.on('message',function(msg){
console.log("SWS:",msg);
});
|
| セッションが確立した場合、このメッセージは受信されます。 | setInterval(function() {
socket.send('Succeed!');
}, 1000);
});
|
| セキュアでないコネクションを示すための例です。こちらで送信したメッセージは弾かれます。 | var socket = new io.Socket()
socket.connect();
socket.send("OH NOES");
|
sws.js | |
|---|---|
| 次に クライアントサイドのモジュールのコードです。トークンを取得して、返ってきたらコネクションを張り直します。 | function SessionWebSocket(cb) {
var xhr = new XMLHttpRequest()
xhr.open("GET","/?no-cache="+(new Date()+0));
|
| トークンを取得するためのヘッダを設定します。 | xhr.setRequestHeader("x-access-request-token","simple");
|
| レスポンスに対するコールバックを設定します。 | xhr.onreadystatechange = function xhrverify() {
|
| 受信完了 | if (xhr.readyState === 4) {
var tmp;
try {
|
| トークンが返ってきていたら、新規に WebSocket の接続を開始します。 | if (tmp = JSON.parse(xhr.responseText)["x-access-token"]) {
var socket = new io.Socket();
cb(socket);
socket.connect();
|
| 取得したトークンを送っています | socket.send(tmp.split(";")[0]);
}
}
catch(e) {
throw new Error("XMLHttpResponse had non-json response, possible cache issue?")
}
}
};
|
| リクエストを送信します。 | xhr.send();
}
|
