Netty 消息转义

Netty 消息转义实践

原创已于 2025-05-23 21:05:11 修改 · 447 阅读

3 ·

CC 4.0 BY-SA版权

文章标签：

#java #nio

于 2024-02-26 15:42:59 首次发布

本文介绍了如何使用Nettyx库中的EscapeCodec和EscapeMap组件实现网络消息的转义，以解决特殊字符导致的消息分割问题。通过示例展示了如何配置ChannelInitializer以确保消息的正确性和完整性。

概要

众所周知, TCP面向流的特性导致在传输应用层消息字节流时,都会使用分隔符定义消息的边界,分隔符的本质为 固定的字节数组,消息分割完整之后,我们才称之为 消息帧,才能进行处理
但是如果业务数据中如果出现 消息分隔符, 这将会导致消息被 提前分割, 而使对端无法收到完整的消息.
此次将介绍如何使用nettyx对消息进行转义

先引入依赖

请从maven中央仓获取{lastest.version},最新版本号
<dependency>
    <groupId>io.github.fbbzl</groupId>
    <artifactId>nettyx</artifactId>
    <version>{lastest.version}</version>
</dependency>

EscapeCodec

Nettyx提供了EscapeCodec来对转义提供支持, EscapeCodec的构造函数需要你传入一个EscapeMapping实例, EscapeMapping用来指定 转义映射关系, 内部做了一些常规的转义校验
EscapeMapping包含了一组mapXxx方法, 用来映射原文和义文之间的转义关系

以下将展示一个简单PPP协议的的转义器, 为了简化示例, 我们直接展示ChannelInitializer

    private ChannelInitializer<NioSocketChannel> channelInitializer() {
        InboundAdvice inboundAdvice = new InboundAdvice();
		// key是真实数据, value为替换数据
        EscapeMap escapeMap = new EscapeMap();
        // 此例中7e是真实的业务数据, "7d5e"为转义后的非业务数据,
        escapeMap.putHex("7e", "7d5e");

        return new ChannelInitializer<NioSocketChannel>() {
            @Override
            protected void initChannel(NioSocketChannel channel) {
                channel.pipeline().addLast(
                        // in  out
                        // ▼   ▲  7e为起止符, 也就是消息分隔符, 此时业务数据中不允许存在7e!!!
                        new StartEndFlagFrameCodec(1024 * 1024, false, Unpooled.wrappedBuffer(new byte[]{(byte) 0x7e})),
                         // 此处我们将7e转成7d5e, 因为如果业务数据中存在7e, 将会扰乱消息的分割
                         // 所以我们将业务数据中的7e转成了7d5e, 这样就不会参与消息分割了
                        new EscapeCodec(escapeMap),
                        // 转换成业务对象
                        new UserCodec(),
                        // 通用日志处理器, 也是由nettyx提供, 后续会进行讲解
                        new LoggerHandler.InboundLogger(log, LoggerHandler.Sl4jLevel.ERROR)
                        );
            }
        };
    }