読者です 読者をやめる 読者になる 読者になる

Taste of Tech Topics

Acroquest Technology株式会社のエンジニアが書く技術ブログ

オリジナルの通信プロトコルを実装してみよう(Netty 実践編2)

Netty Java

こんにちは!新しい物好きなエンジニアのツカノです。

Nettyを利用しているOSSは多いですが、Netty4が登場して気になるのはNetty3からの移行ですよね。どのくらいのプロジェクトが移行しようとしているかは分かりませんが、Issueを見ているとNetty4への移行話が登場しているものもチラホラあります。個人的には移行状況もチェックしておきたいと考えています。

さて、前回の実践編1では、オリジナルプロトコルのEncoder/Decoderを作成しました。今回の実践編2ではEncoder/Decoder以外の部分(クライアント/サーバのプログラム)を作成し、ChannelBufferについて解説します。

クライアントのプログラム

以前のシリーズで紹介したクライアントプログラムを参考に、書いてみましょう。

  • MyProtocolClient

StringEncoder/Decoderだった部分をMyProtocolEncoder/Decoderに置き換えます。また、HandlerをMyProtocolClientHandlerに置き換えます。

package netty_sample;

import java.net.InetSocketAddress;
import java.util.concurrent.Executors;
import org.jboss.netty.bootstrap.ClientBootstrap;
import org.jboss.netty.channel.ChannelFactory;
import org.jboss.netty.channel.ChannelFuture;
import org.jboss.netty.channel.ChannelPipeline;
import org.jboss.netty.channel.ChannelPipelineFactory;
import org.jboss.netty.channel.Channels;
import org.jboss.netty.channel.socket.nio.NioClientSocketChannelFactory;
import org.jboss.netty.handler.codec.frame.LengthFieldBasedFrameDecoder;
import org.jboss.netty.handler.codec.frame.LengthFieldPrepender;
import org.jboss.netty.handler.codec.string.StringDecoder;

/**
 * クライアント側メインクラス
 */
public class MyProtocolClient {

    public static void main(String[] args) {
        ChannelFactory factory
            = new NioClientSocketChannelFactory( // client
                Executors.newCachedThreadPool(),
                Executors.newCachedThreadPool()
                );

        ClientBootstrap bootstrap = new ClientBootstrap(factory);
        bootstrap.setPipelineFactory(new ChannelPipelineFactory() {
            public ChannelPipeline getPipeline() {
                ChannelPipeline pipeline = Channels.pipeline();
                // Downstream(送信)
                pipeline.addLast("frameEncoder", new LengthFieldPrepender(4));
                pipeline.addLast("myEncoder", new MyProtocolEncoder());
                // Upstream(受信)
                pipeline.addLast("frameDecoder",
                        new LengthFieldBasedFrameDecoder(8192, 0, 4, 0, 4));
                pipeline.addLast("myDecoder", new StringDecoder());
                // Application Logic Handler
                pipeline.addLast("handler", new MyProtocolClientHandler()); // client
                return pipeline;
            }
        });

        ChannelFuture future = bootstrap.connect(new InetSocketAddress("localhost", 9999)); // 9999番ポートにconnect
        future.getChannel().getCloseFuture().awaitUninterruptibly();
        bootstrap.releaseExternalResources();
    }
}
  • MyProtocolClientHandler

channelConnectedではUserInfoを送信するように変更しています。また、今回はサーバに送信するだけなので、messageReceivedは実装していません。

package netty_sample;

import org.jboss.netty.channel.ChannelHandlerContext;
import org.jboss.netty.channel.ChannelStateEvent;
import org.jboss.netty.channel.SimpleChannelHandler;

/**
 * クライアント側アプリケーションロジック
 */
public class MyProtocolClientHandler extends SimpleChannelHandler {
    /**
     * サーバに接続した際に呼び出されるメソッド
     */
    @Override
    public void channelConnected(ChannelHandlerContext ctx,
            ChannelStateEvent event) {
        // サーバに送信する情報を生成
        UserInfo info = new UserInfo(100, "taro", 20);
        // サーバに送信
        ctx.getChannel().write(info);
    }
}

これで、クライアント側のできあがりです。

サーバのプログラム

以前のシリーズで紹介したサーバプログラムを参考に、書いてみましょう。

  • MyProtocolServer

これも、StringEncoder/Decoderだった部分をMyProtocolEncoder/Decoderに置き換えます。また、HandlerをMyProtocolServerHandlerに置き換えます。

package netty_sample;

import java.net.InetSocketAddress;
import java.util.concurrent.Executors;

import org.jboss.netty.bootstrap.ServerBootstrap;
import org.jboss.netty.channel.ChannelFactory;
import org.jboss.netty.channel.ChannelPipeline;
import org.jboss.netty.channel.ChannelPipelineFactory;
import org.jboss.netty.channel.Channels;
import org.jboss.netty.channel.socket.nio.NioServerSocketChannelFactory;
import org.jboss.netty.handler.codec.frame.LengthFieldBasedFrameDecoder;
import org.jboss.netty.handler.codec.frame.LengthFieldPrepender;

/**
 * サーバ側メインクラス
 */
public class MyProtocolServer {

    public static void main(String[] args) {
        ChannelFactory factory = 
            new NioServerSocketChannelFactory( // server
                    Executors.newCachedThreadPool(),
                    Executors.newCachedThreadPool()
                    );
        
        ServerBootstrap bootstrap = new ServerBootstrap(factory);
        bootstrap.setPipelineFactory(new ChannelPipelineFactory() {
            public ChannelPipeline getPipeline() {
                ChannelPipeline pipeline = Channels.pipeline();
                // Downstream(送信)
                pipeline.addLast("frameEncoder", new LengthFieldPrepender(4));
                pipeline.addLast("myEncoder", new MyProtocolEncoder());
                // Upstream(受信)
                pipeline.addLast("frameDecoder", new LengthFieldBasedFrameDecoder(8192, 0, 4, 0, 4));
                pipeline.addLast("myDecoder", new MyProtocolDecoder());
                // Application Logic Handler
                pipeline.addLast("handler", new MyProtocolServerHandler()); // server
                
                return pipeline;
            }
        });
        
        bootstrap.bind(new InetSocketAddress(9999)); // 9999番ポートでlisten
    }
}
  • MyProtocolServer

messageReceivedで受信したUserInfoを表示しているだけです。また、今回はサーバに送信するだけなので、クライアント側に返信していません。

package netty_sample;

import org.jboss.netty.channel.ChannelHandlerContext;
import org.jboss.netty.channel.MessageEvent;
import org.jboss.netty.channel.SimpleChannelHandler;

/**
 * サーバ側アプリケーションロジック
 */
public class MyProtocolServerHandler extends SimpleChannelHandler {
    /**
     * クライアントからメッセージを受信した際に呼び出されるメソッド
     */
    @Override
    public void messageReceived(ChannelHandlerContext ctx, MessageEvent event) {
        UserInfo msg = (UserInfo) event.getMessage(); // 受信メッセージを取りだす
        System.out.println(msg); // 受信メッセージを表示
    }
}

これで、サーバ側のできあがりです。導入編ものとほぼ同じです。

動作させてみましょう

それでは、実際に動作させてましょう。導入編と同様に、最初にサーバのメインクラスMyProtocolServerを実行し、次にクライアントのメインクラスMyProtocolClientを実行してください。すると、サーバ側で以下の内容を標準出力します。

id=100, name=taro, age=20

どうでしょうか?
こういう独自プロトコルが簡単に書けて、ソースも分かりやすいですね。これがNettyの特徴のひとつです。

ChannelBufferの使い方

さて、前回、ChannelBufferを使う際に基本的に「read型名」「write型名」を利用するように書きました。その利用について説明します。
以下は、ChannelBufferの構造を簡単に説明した図です。ChannelBufferの先頭から後方にかけて、左から右に流れていきます。ChannelBufferをreadする際の残りのbyte列(write済み)が「readable bytes」、writeする際の残りのbyte列(capacityまで)が「writable bytes」です。また、読み書きが終わったbyte列が「discardable bytes」です。この図はChannelBufferのJavadocから引用しています。(余談ですが、NettyはJavadocがかなり充実しています)

      +-------------------+------------------+------------------+
      | discardable bytes |  readable bytes  |  writable bytes  |
      |                   |     (CONTENT)    |                  |
      +-------------------+------------------+------------------+
      |                   |                  |                  |
      0      <=      readerIndex   <=   writerIndex    <=    capacity

ChannelBufferは内部に「readerIndex」「writerIndex」というものを持っています。「read型名」「write型名」のメソッドを実行すると、「readerIndex」「writerIndex」が自動的に更新されるのです。これがあるお陰で、「readの際に何byte目をreadするか指定する」ということが不要になります。前から順番に読み書きしていけば、「何byte目」を意識しなくて済みます。

素直に前から読み書きできないケースでは「get型名」「set型名」を利用します。この際はindexは更新されないため、ご注意ください。

今回のまとめ

これで、Nettyを使ってオリジナルプロトコルのEncoder/Decoderを使うことができました。Nettyはまだまだ様々な要素がありますが、これだけでも威力が大きなフレームワークだと考えています。

Netty4も出ましたし、興味を持った方は是非使ってみてください。
それではまた~