GWTでChannelAPIクライアントを実装する

昨日に引き続いて、Channel APIの話題です。ライブラリを使って意外と簡単にGWTで実装できましたので、取り急ぎ報告します。あ、まだGAE上では試してません。

gwt-gae-channelライブラリを使う
gwt-gae-channelプロジェクトというのがありますので、これを使いました。まだバージョン0.3αですがいちおう動くようです。なお、gwt.xmlファイルへの記述は、

• ＜inherits name='com.google.gwt.appengine.channel.Channel' />

となります。

Tokenの入手

これは、前回の記事を参考にして、まずはTokenを入手してください。入手方法はお好きなように、、、まあ、GWTユーザならGWT-RPCを使うのが普通でしょう。

Channelの接続

ここで、gwt-gae-channelのライブラリを使います。以下のような記述でOK。

ChannelFactory.createChannel(token, new ChannelCreatedCallback() {
            @Override
            public void onChannelCreated(Channel channel) {
                channel.open(new SocketListener() {
                    @Override
                    public void onOpen() {
                        Window.alert("Channel opened!");
                    }
                    @Override
                    public void onMessage(String message) {
                        Window.alert("Received: " + message);
                    }

                    @Override
                    public void onError(SocketError error) {
                        Window.alert("Error: " + error.getDescription());
                    }

                    @Override
                    public void onClose() {
                        Window.alert("Channel closed!");
                    }
                });
            }
        });

この記述は、Tokenを入手した直後にするのが無難でしょう。接続が確立すると、onOpenメソッドが反応します。この処理を終えることで、サーバとのcomet接続が維持されます。

Pushの呼び出し
上記の処理が終えた後、サーバー側でpushをする処理（前日の記事を参照）を実行させれば、上記のonMessageが反応します。push処理の呼び出し方は、サーブレットでもいいし、GWT-RPCでもいいです。

正直、なんでこれでpushされてくるのかイマイチがところはあります（笑）。サンプルとか殆どないのでわかりにくいですが、cometのことがわかっていれば理解可能だと思います。

GAEのChannelAPIを理解する ～サーバ編～

GAEで、1.4から採用されたChannel APIについてちょっとわかってきたので簡単に報告します。

ChannelAPIとは
これは俗にいうCometの処理に相当します。チャットのようなPushするプログラミングを作成する際に、GAEのリソースを利用して実装できるというのは大きな魅力でしょう。

ChannelAPIにおいて理解しておくべき最低限の用語２つ

• Token ・・・ ユーザとコネクションを貼るためのトークン。サーバーは最初の接続要求の時に、このTokenの値をクライアントに渡す必要があります。
  
• channelKey ・・・接続チャンネル。ユーザごとに区別するような方法が一般的らしい。

最初の接続処理Tokenの生成部分

ChannelService channelService = ChannelServiceFactory.getChannelService();
String token = channelService.createChannel(channelKey);

//ここで生成されたtokenをクライアントに渡すこと

プッシュ処理（ユーザへの送信）部分

String message="なにか来ました"
ChannelService channelService = ChannelServiceFactory.getChannelService();
channelService.sendMessage(new ChannelMessage(channelKey, message));

とまあ、驚くほど簡単にできたりします。

ちょっとchannelKeyの設定の仕方はいろいろあるようですが、例えば１つに固定にしておくとそのchannelKeyで接続したユーザ全てに同じメッセージを送ることができました。単純にブロードキャストするだけでしたら、そういった方法もいいかもしれません。個別にプッシュ対応する場合は、該当するchannelKeyに対してのみ、sendMessageメソッドを呼び出せば良いのでしょう。

なお、GAE上で本格的に稼働させたわけではないので、どれぐらいの負荷がかかるのかは不明です。

クライアント編については、また後日。。。