Java で WebSocket サーバーを書く
この例では、Oracle Java を使用して WebSocket API サーバーを作成する方法を示します。
他のサーバーサイドの言語を使用して WebSocket サーバーを作成することもできますが、この例では Oracle Java を使用してサンプルコードを簡略化しています。
このサーバーは RFC 6455 に準拠しているため、 Chrome バージョン 16、Firefox 11、IE 10 以降の接続のみを処理します。
最初のステップ
WebSocket は TCP (伝送制御プロトコル) 接続を介して通信します。 Java の ServerSocket クラスは java.net パッケージにあります。
ServerSocket
ServerSocket
コンストラクターは、単一の引数 port
を int
型で取ります。
ServerSocket クラスをインスタンス化すると、port 引数で指定したポート番号にバインドされます。
こちらが実装を部品に分割したものです。
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.ServerSocket;
import java.net.Socket;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.util.Base64;
import java.util.Scanner;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
public class WebSocket {
public static void main(String[] args) throws IOException, NoSuchAlgorithmException {
ServerSocket server = new ServerSocket(80);
try {
System.out.println("Server has started on 127.0.0.1:80.\r\nWaiting for a connection…");
Socket client = server.accept();
System.out.println("A client connected.");
Socket のメソッド
-
java.net.Socket.getInputStream()
このソケットの入力ストリームを返します。 -
java.net.Socket.getOutputStream()
このソケットの出力ストリームを返します。
OutputStream のメソッド
write(byte[] b, int off, int len)
指定された byte 配列からオフセット off
で始まる len
バイトをこの出力ストリームに書き込みます。
InputStream のメソッド
read(byte[] b, int off, int len)
最大 len バイトのデータを入力ストリームからバイト配列に読み込みます。
例を拡張してみましょう。
InputStream in = client.getInputStream();
OutputStream out = client.getOutputStream();
Scanner s = new Scanner(in, "UTF-8");
ハンドシェイク
クライアントがサーバーに接続すると、単純な HTTP リクエストから WebSocket への接続をアップグレードするための GET リクエストが送信されます。 これはハンドシェイクと呼ばれます。
try {
String data = s.useDelimiter("\\r\\n\\r\\n").next();
Matcher get = Pattern.compile("^GET").matcher(data);
このようにしなければならない理由を理解するよりも、レスポンスを作成する方が簡単です。
次のことをやらなければなりません。
- 先頭と末尾の空白なしで Sec-WebSocket-Key リクエストヘッダーの値を取得します
- "258EAFA5-E914-47DA-95CA-C5AB0DC85B11" とリンクします
- SHA-1 と Base64 のコードを計算します
- Sec-WebSocket-Accept レスポンスヘッダーの値を HTTP レスポンスの一部として書き戻します
if (get.find()) {
Matcher match = Pattern.compile("Sec-WebSocket-Key: (.*)").matcher(data);
match.find();
byte[] response = ("HTTP/1.1 101 Switching Protocols\r\n"
+ "Connection: Upgrade\r\n"
+ "Upgrade: websocket\r\n"
+ "Sec-WebSocket-Accept: "
+ Base64.getEncoder().encodeToString(MessageDigest.getInstance("SHA-1").digest((match.group(1) + "258EAFA5-E914-47DA-95CA-C5AB0DC85B11").getBytes("UTF-8")))
+ "\r\n\r\n").getBytes("UTF-8");
out.write(response, 0, response.length);
メッセージのデコード
ハンドシェイクが成功した後、クライアントはサーバーにメッセージを送信できますが、これはエンコードされています。
"abcdef" を送信すると、次のバイトが得られます。
129 134 167 225 225 210 198 131 130 182 194 135
-
129:
FIN: メッセージをフレームで送ることができますが、単純化します。 Opcode 0x1 はテキストであることを意味します。 Opcode の完全なリスト
FIN (これがメッセージ全体であるかどうか) RSV1 RSV2 RSV3 Opcode 1 0 0 0 0x1=0001 - 134:
メモ: 最初のビットは常に 1 なので、 128 を取ることができます。
- 167、225、225、および 210 はデコードするキーのバイトです。それは毎回変わります。
- 残りの符号化されたバイトはメッセージです。
デコードアルゴリズム
デコードされたバイト = エンコードされたバイト XOR (エンコードされたバイトの位置 BITWISE および 0x3) バイト目のキー
Java の例です。
byte[] decoded = new byte[6];
byte[] encoded = new byte[] { (byte) 198, (byte) 131, (byte) 130, (byte) 182, (byte) 194, (byte) 135 };
byte[] key = new byte[] { (byte) 167, (byte) 225, (byte) 225, (byte) 210 };
for (int i = 0; i < encoded.length; i++) {
decoded[i] = (byte) (encoded[i] ^ key[i & 0x3]);
}
}
} finally {
s.close();
}
} finally {
server.close();
}
}
}