背景と課題

TCP プロトコルはストリーム指向の通信手段です。この特性ゆえ、アプリケーション層のデータを送信する際、バイトストリームの中に明確な境界を定義する必要があります。一般的には特定のバイト配列（デリミタ）を用いてメッセージの区切りに利用しますが、受信側はこの区切りを検知してメッセージフレーム（Message Frame）として認識します。

しかし、送信する業務データの中にそのデリミタと同じパターンが含まれてしまう場合、メッセージは意図せずに中途で切断され、正常に解析できなくなります。このようなケースでは、受信元で正しいデータの再構築を行うために「エスケープ処理」が不可欠となります。

依存関係の設定

本実装には以下のライブラリが必要です。Maven リポジトリから最新バージョンを取得してください。

<dependency>
    <groupId>io.github.fbbzl</groupId>
    <artifactId>nettyx</artifactId>
    <version>{latestVersion}</version>
</dependency>

EscapeCodec の活用

nettyx ライブラリには、メッセージの内容を安全に変換する EscapeCodec が用意されています。このコンポーネントを使用するには、元のデータと置換後のペアを定義する EscapeMapping インスタンスを初期化パラメータとして指定します。内部ロジックでは、不正な置換パターンの検証が行われています。

EscapeMapping クラスは、原文バイトシーケンスとエスケープ後のバイトシーケンスのマッピングを管理するためのメソッド群を提供しています。以下に、簡略化した PPP プロトコル風の挙動を示すパイプライン設定例を示します。

実装例

ここでは NioSocketChannel の初期化ロジックを示します。EscapeMap にデリミタの回避ルールを設定し、ピpline 内の順序を適切に調整します。

private ChannelPipeline configurePipeline(NioSocketChannel channel) {
    // デフォルトのインバウンド設定
    ChannelPipeline pipeline = channel.pipeline();

    // エスケープ定義の生成
    ByteEscapeStrategy rules = createEscapeRules();
    
    // エスケープ対象のパラメータセットアップ
    // キー：生データ (0x7e)、バリュー：置換データ (0x7d5e)
    rules.defineReplacement((byte) 0x7e, new byte[]{(byte) 0x7d, (byte) 0x5e});

    // フィールドコードデコーダを追加
    // メッセージ長制限：1MB、区切り文字：0x7e
    StartEndFrameDecoder frameCodec = 
        new StartEndFrameDecoder(1024 * 1024, false, Unpooled.wrappedBuffer(new byte[]{(byte) 0x7e}));

    // エスケープ処理を実行
    EscapeHandler escapeHandler = new EscapeHandler(rules);

    // カスタムユーザーオブジェクト変換
    ObjectDecoder customDecoder = new UserCodec();
    
    // ログ記録ハンドラー（NettyX 提供）
    LoggerHandler logHandler = new InboundLogger(log, Level.ERROR);

    // ハンドラ登録（逆順）
    pipeline.addLast(frameCodec);
    pipeline.addLast(escapeHandler);
    pipeline.addLast(customDecoder);
    pipeline.addLast(logHandler);

    return pipeline;
}

// ヘルパーメソッド：エスケープ規則の構築
private ByteEscapeStrategy createEscapeRules() {
    return new EscapeMap();
}

上記の構成では、パイプラインを通じて以下の変換フローを実現しています。最初にフレームデコーダが區切り位置を確認し、その前に存在するデータ（実際にはこの後になる処理だが論理的順序）の中でデリミタが発生している場合はエスケープハンドラによって安全な文字列に変換されます。

特に EscapeCodec（あるいは EscapeHandler）は、メッセージ本体に含まれる可能性がある制御文字を別の表現に置き換える役割を担います。これにより、0x7e というバイトが出現してもフレームの終わりと誤認識されることを防ぎます。