Skip to content

Instantly share code, notes, and snippets.

@taichi

taichi/SPDY_WS_ON_JETTY9.md Secret

Last active December 15, 2015 10:49
Show Gist options
  • Save taichi/af797a1f1345c51993ef to your computer and use it in GitHub Desktop.
Save taichi/af797a1f1345c51993ef to your computer and use it in GitHub Desktop.
Download ZIP
Jetty9でSPDYとWebSocket
Raw
index.html
<html><head>
<title>WebSocket Chat</title>
<script type='text/javascript'>
if (!window.WebSocket && window.MozWebSocket)
window.WebSocket=window.MozWebSocket;
if (!window.WebSocket)
alert("WebSocket not supported by this browser");
function $() { return document.getElementById(arguments[0]); }
function $F() { return document.getElementById(arguments[0]).value; }
function getKeyCode(ev) { if (window.event) return window.event.keyCode; return ev.keyCode; }
var room = {
join: function(name) {
this._username=name;
var location = document.location.toString().replace('http://','ws://').replace('https://','wss://');
this._ws=new WebSocket(location,"echo-broadcast-ping");
this._ws.onopen=this._onopen;
this._ws.onmessage=this._onmessage;
this._ws.onclose=this._onclose;
},
_onopen: function(){
$('join').className='hidden';
$('joined').className='';
$('phrase').focus();
room._send(room._username,'has joined!');
},
_send: function(user,message){
user=user.replace(':','_');
if (this._ws)
this._ws.send(user+':'+message);
},
chat: function(text) {
if (text != null && text.length>0 )
room._send(room._username,text);
},
_onmessage: function(m) {
if (m.data){
var c=m.data.indexOf(':');
var from=m.data.substring(0,c).replace('<','&lt;').replace('>','&gt;');
var text=m.data.substring(c+1).replace('<','&lt;').replace('>','&gt;');
var chat=$('chat');
var spanFrom = document.createElement('span');
spanFrom.className='from';
spanFrom.innerHTML=from+':&nbsp;';
var spanText = document.createElement('span');
spanText.className='text';
spanText.innerHTML=text;
var lineBreak = document.createElement('br');
chat.appendChild(spanFrom);
chat.appendChild(spanText);
chat.appendChild(lineBreak);
chat.scrollTop = chat.scrollHeight - chat.clientHeight;
}
},
_onclose: function(m) {
this._ws=null;
$('join').className='';
$('joined').className='hidden';
$('username').focus();
$('chat').innerHTML='';
}
};
</script>
<style type='text/css'>
div { border: 0px solid black; }
div#chat { clear: both; width: 40em; height: 20ex; overflow: auto; background-color: #f0f0f0; padding: 4px; border: 1px solid black; }
div#input { clear: both; width: 40em; padding: 4px; background-color: #e0e0e0; border: 1px solid black; border-top: 0px }
input#phrase { width:30em; background-color: #e0f0f0; }
input#username { width:14em; background-color: #e0f0f0; }
div.hidden { display: none; }
span.from { font-weight: bold; }
span.alert { font-style: italic; }
</style>
</head><body>
<div id='chat'></div>
<div id='input'>
<div id='join' >
Username:&nbsp;<input id='username' type='text'/><input id='joinB' class='button' type='submit' name='join' value='Join'/>
</div>
<div id='joined' class='hidden'>
Chat:&nbsp;<input id='phrase' type='text'/>
<input id='sendB' class='button' type='submit' name='join' value='Send'/>
</div>
</div>
<script type='text/javascript'>
$('username').setAttribute('autocomplete','OFF');
$('username').onkeyup = function(ev) { var keyc=getKeyCode(ev); if (keyc==13 || keyc==10) { room.join($F('username')); return false; } return true; } ;
$('joinB').onclick = function(event) { room.join($F('username')); return false; };
$('phrase').setAttribute('autocomplete','OFF');
$('phrase').onkeyup = function(ev) { var keyc=getKeyCode(ev); if (keyc==13 || keyc==10) { room.chat($F('phrase')); $('phrase').value=''; return false; } return true; };
$('sendB').onclick = function(event) { room.chat($F('phrase')); $('phrase').value=''; return false; };
</script>
<p>
This is a demonstration of the Jetty websocket server.
</p>
</body></html>
Raw
keygen.cmd
keytool -genkey -alias spdy -keystore spdy.jks -storepass password -keypass password -dname "CN=localhost, OU=spdy, O=example.org, L=Shinjuku-ku, ST=Tokyo, C=JP" -validity 730
Raw
SPDY_WS_ON_JETTY9.md

Jetty9でSPDY+WebSocket

自己紹介

悪くないモンスターの太一です。
最近はjsばっかり書いてますけども一番得意な言語はJavaです。

アジェンダ

  • Jettyとは何か
  • SPDY
    • 主要なコンポーネントの概要説明
    • GroovyでSPDYサーバを実行する
  • WebSocket
    • 主要なコンポーネントの概要説明
    • GroovyでWebSocketサーバを実行する
    • WebSocketサーバをSPDY上で実行する
  • まとめ

Jettyとは何か？

  • Javaで実装されたHTTPサーバ。
    • デフォルト非同期I/O。
    • JEE6 WebProfile実装なのでServletをデプロイ出来る。
    • ニッチで先進的な機能が満載。
    • 比較的コードがクリーンでライセンスが緩いのでハックし易い。
    • Stableリリースは7系、8系、9系があるので最新の9系ベースで話をする。
  • Eclipse Public License - Version 1.0 / Apache License - Version 2.0
  • 主にintalioの人がメンテナンスしている。

SPDY

  • npn-boot
  • npn-api
  • spdy-core
  • spdy-client
  • spdy-server
  • spdy-http-server

npn-boot

  • Java用のNext Protocol Negotiation Extension実装。
  • OpenJDKの名前空間である sun.security.ssl をダーティハックしている為、GPL。
  • eclipse foundationでは無く、mortbay.org名義でリリースしているが、作業している人は同じなので単に政治的なアレだと思う。
  • Javaがセキュリティアップデートする度に修正が入ったものがリリースされる。
final public class SSLEngineImpl extends SSLEngine
＿人人 人人人＿
＞ 突然のGPL ＜
￣Y^Y^Y^Y^Y￣

npn-api

  • NPNをJettyから使う為のラッパーレイヤー
  • クラスは1つしかないので特に見るべきものは無い

spdy-core

  • SPDYプロトコルを実装しているモジュール
  • 対応しているバージョンはV2とV3

spdy-core パッケージ構成

  • org.eclipse.jetty.spdy
    • SPDY実装の中心
  • org.eclipse.jetty.spdy.api
    • SPDYの基礎的な仕様及びデータ構造定義
  • org.eclipse.jetty.spdy.frames
    • フレーム構造の定義
  • org.eclipse.jetty.spdy.generator
    • 出力仕様に対する実装
  • org.eclipse.jetty.spdy.parser
    • 入力仕様に対する実装
    • 酷いコードの様に見えるかもしれないけど、Javaでプロトコルパーザを普通に書いたらこんなもん。 SynReplyBodyParser.javaだけ抜粋しておいたので見て下さい。

spdy-client

  • 非同期I/OベースのSPDYクライアントライブラリ
  • SPDYに対応しているサーバをクローリングするなら速いかも
  • 自前SPDYサーバを自動テストするのに使うと良いかも？

spdy-server

  • Jettyのサーバフレームワーク上に実装されているSPDYのサーバ実装
  • 主にSPDY用TCPコネクションの管理コード

spdy-http-server

  • HTTP上で動作する為のサーバ処理
  • 文字列に関する処理は全部ここ
  • SPDY-http-proxyの実装
  • JettyをSPDYサーバとして使う場合このモジュールを使う

GroovyでSPDYサーバを実行する

new org.eclipse.jetty.server.Server().with {
	def connector = new org.eclipse.jetty.spdy.server.http.HTTPSPDYServerConnector(it,
			new org.eclipse.jetty.util.ssl.SslContextFactory(
			keyStorePath: 'src/main/resources/spdy.jks',
			keyStorePassword: 'password',
			protocol: 'TLSv1'))
	connector.port = 8443
	addConnector connector

	handler = new org.eclipse.jetty.server.handler.ResourceHandler(
			resourceBase: 'src/main/resources/webcontent')

	start()
	join()
	// https://localhost:8443/spdy.html
	// chrome://net-internals/#spdy
}

運用系のコード無しにSPDYサーバ起動するだけなら20行程度のコードで動く。
このコードは起動する時にnpn-bootをJVMの起動オプションで渡す。
eclipseの場合は Run Configurations ... > Arguments > VM arguments に以下の様な設定を行う。

-Xbootclasspath/p:${project_loc}/lib/npn-boot-1.1.5.v20130313.jar

これを忘れると、以下の様にエラーメッセージが出力されサーバが起動しない。

2013-03-27 20:33:21.240:WARN:oejss.NPNServerConnectionFactory:main: NextProtoNego not from bootloader classloader: sun.misc.Launcher$AppClassLoader@59727745
2013-03-27 20:33:21.240:WARN:oejss.NPNServerConnectionFactory:main: NextProtoNego not available: java.lang.IllegalStateException: NextProtoNego not on bootloader
Exception in thread "main" java.lang.IllegalStateException: NextProtoNego not available
	at org.eclipse.jetty.spdy.server.NPNServerConnectionFactory.<init>(NPNServerConnectionFactory.java:64)

尚、Jetty8 系でこの設定を忘れるとHTTPリクエストを送信した際にCPU使用率が100%に張り付く等、愉快な事が起こる。

WebSocket

  • websocket-api
  • websocket-common
  • websocket-client
  • websocket-servlet
  • websocket-server

JettyにおけるWebSocketの位置づけ

  • アプリケーションでは直接使うべきではないものである。
  • 例えば、CometD の様な抽象度が高いフレームワークを使うべき。
    • CometDなら、long pollingとWebSocketをjsのランタイムから使い易い様に使える。
  • Jetty/Feature/WebSockets

websocket-api

  • WebSocketAPIなので実装はほぼ無くinterfaceの定義が中心。
  • Futureパターンによる非同期I/O
  • JettyでWebSocketするなら理解する必要がある。
  • JavaEE7ではWebSocketが使える様になる。

websocket-common

  • WebSocketプロトコルを実装しているモジュール
  • RFC6455実装
  • 以前は様々なバージョンのWebSocketに対応していたがJetty9で大胆に削除

websocket-common パッケージ構成

  • org.eclipse.jetty.websocket.common
    • Parser見とけばJavaでのWebSocket実装は大体分かる。
  • org.eclipse.jetty.websocket.common.events
    • WebSocketにおけるサーバとアプリケーションのGlueコードが記述されている。
  • org.eclipse.jetty.websocket.common.extensions.compress
  • org.eclipse.jetty.websocket.common.extensions.fragment
  • org.eclipse.jetty.websocket.common.extensions.identity
    • fragmentとidentityは、よく分からない。
  • org.eclipse.jetty.websocket.common.extensions.mux

websocket-client

  • 非同期I/OベースのWebSocketクライアントライブラリ。
  • multiplexing対応のコードもある。

websocket-servlet

  • ServletとしてWebSocketアプリケーションをデプロイする為のライブラリ。
  • JettyでWebSocketするなら、このモジュールを使う。

websocket-server

  • Jettyのサーバフレームワーク上に実装されているWebSocketのサーバ実装。
  • multiplexing対応を含むWebSocket用TCPコネクションの管理コード。
  • ExampleEchoServer.javaを見れば使い方は大体分かる。

GroovyでWebSocketサーバを実行する

@org.eclipse.jetty.websocket.api.annotations.WebSocket
class Echo {
	@org.eclipse.jetty.websocket.api.annotations.OnWebSocketMessage
	void onText(org.eclipse.jetty.websocket.api.Session session, String msg) {
		session.getRemote().sendStringByFuture(msg)
	}
}
new org.eclipse.jetty.server.Server(8080).with {
	handler = new org.eclipse.jetty.websocket.server.WebSocketHandler.Simple(Echo)
	handler.handler = new org.eclipse.jetty.server.handler.ResourceHandler(
			resourceBase: 'src/main/resources/webcontent')

	start()
	join()
	// http://localhost:8080/
}

WebSocketサーバをSPDY上で実行する

@org.eclipse.jetty.websocket.api.annotations.WebSocket
class DoubleEcho {
	@org.eclipse.jetty.websocket.api.annotations.OnWebSocketMessage
	void onText(org.eclipse.jetty.websocket.api.Session session, String msg) {
		session.getRemote().sendStringByFuture("$msg $msg")
	}
}
new org.eclipse.jetty.server.Server().with {
	def connector = new org.eclipse.jetty.spdy.server.http.HTTPSPDYServerConnector(it,
			new org.eclipse.jetty.util.ssl.SslContextFactory(
			keyStorePath: 'src/main/resources/spdy.jks',
			keyStorePassword: 'password',
			protocol: 'TLSv1'))
	connector.port = 8443
	addConnector connector

	handler = new org.eclipse.jetty.websocket.server.WebSocketHandler.Simple(DoubleEcho)
	handler.handler = new org.eclipse.jetty.server.handler.ResourceHandler(
			resourceBase: 'src/main/resources/webcontent')

	start()
	join()
	// https://localhost:8443/
	// chrome://net-internals/#spdy
}

JettyではSPDYはコネクタ系のモジュールでWebSocketはハンドラ系のモジュールなので特に難しい事を考えずとも同時に実行可能です。

まとめ

  • Javaでプロトコルパーザを書くと酷い
  • Jettyは全体的に非同期I/O
  • JettyのWebSocketはCometD越しに使うのがオススメ
  • SPDYの上にWebSocket乗せるのは楽勝
Raw
SynReplyBodyParser.java
//
// ========================================================================
// Copyright (c) 1995-2013 Mort Bay Consulting Pty. Ltd.
// ------------------------------------------------------------------------
// All rights reserved. This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v1.0
// and Apache License v2.0 which accompanies this distribution.
//
// The Eclipse Public License is available at
// http://www.eclipse.org/legal/epl-v10.html
//
// The Apache License v2.0 is available at
// http://www.opensource.org/licenses/apache2.0.php
//
// You may elect to redistribute this code under either of these licenses.
// ========================================================================
//
package org.eclipse.jetty.spdy.parser;
import java.nio.ByteBuffer;
import org.eclipse.jetty.spdy.CompressionFactory;
import org.eclipse.jetty.spdy.api.ReplyInfo;
import org.eclipse.jetty.spdy.api.SPDY;
import org.eclipse.jetty.spdy.frames.ControlFrameType;
import org.eclipse.jetty.spdy.frames.SynReplyFrame;
import org.eclipse.jetty.util.Fields;
public class SynReplyBodyParser extends ControlFrameBodyParser
{
private final Fields headers = new Fields();
private final ControlFrameParser controlFrameParser;
private final HeadersBlockParser headersBlockParser;
private State state = State.STREAM_ID;
private int cursor;
private int streamId;
public SynReplyBodyParser(CompressionFactory.Decompressor decompressor, ControlFrameParser controlFrameParser)
{
this.controlFrameParser = controlFrameParser;
this.headersBlockParser = new SynReplyHeadersBlockParser(decompressor);
}
@Override
public boolean parse(ByteBuffer buffer)
{
while (buffer.hasRemaining())
{
switch (state)
{
case STREAM_ID:
{
if (buffer.remaining() >= 4)
{
streamId = buffer.getInt() & 0x7F_FF_FF_FF;
state = State.ADDITIONAL;
}
else
{
state = State.STREAM_ID_BYTES;
cursor = 4;
}
break;
}
case STREAM_ID_BYTES:
{
byte currByte = buffer.get();
--cursor;
streamId += (currByte & 0xFF) << 8 * cursor;
if (cursor == 0)
{
streamId &= 0x7F_FF_FF_FF;
state = State.ADDITIONAL;
}
break;
}
case ADDITIONAL:
{
switch (controlFrameParser.getVersion())
{
case SPDY.V2:
{
if (buffer.remaining() >= 2)
{
buffer.getShort();
state = State.HEADERS;
}
else
{
state = State.ADDITIONAL_BYTES;
cursor = 2;
}
break;
}
case SPDY.V3:
{
state = State.HEADERS;
break;
}
default:
{
throw new IllegalStateException();
}
}
break;
}
case ADDITIONAL_BYTES:
{
assert controlFrameParser.getVersion() == SPDY.V2;
buffer.get();
--cursor;
if (cursor == 0)
state = State.HEADERS;
break;
}
case HEADERS:
{
short version = controlFrameParser.getVersion();
int length = controlFrameParser.getLength() - getSynReplyDataLength(version);
if (headersBlockParser.parse(streamId, version, length, buffer))
{
byte flags = controlFrameParser.getFlags();
if (flags != 0 && flags != ReplyInfo.FLAG_CLOSE)
throw new IllegalArgumentException("Invalid flag " + flags + " for frame " + ControlFrameType.SYN_REPLY);
SynReplyFrame frame = new SynReplyFrame(version, flags, streamId, new Fields(headers, true));
controlFrameParser.onControlFrame(frame);
reset();
return true;
}
break;
}
default:
{
throw new IllegalStateException();
}
}
}
return false;
}
private int getSynReplyDataLength(short version)
{
switch (version)
{
case 2:
return 6;
case 3:
return 4;
default:
throw new IllegalStateException();
}
}
private void reset()
{
headers.clear();
state = State.STREAM_ID;
cursor = 0;
streamId = 0;
}
private enum State
{
STREAM_ID, STREAM_ID_BYTES, ADDITIONAL, ADDITIONAL_BYTES, HEADERS
}
private class SynReplyHeadersBlockParser extends HeadersBlockParser
{
public SynReplyHeadersBlockParser(CompressionFactory.Decompressor decompressor)
{
super(decompressor);
}
@Override
protected void onHeader(String name, String[] values)
{
for (String value : values)
headers.add(name, value);
}
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment