Netty编解码器

概述

网络中数据是以二进制字节流进行传输,编码器的作用是将数据编码为二进制字节流,而解码器的作用是将二进制字节流解码为程序能处理的数据格式,本章节将对Netty编解码器实现原理进行分析。

编码器

Netty编码器有两个抽象基类:MessageToByteEncoder与MessageToMessageEncoder,MessageToByteEncoder会将消息编码为字节,MessageToMessageEncode会将消息编码为另一种消息。通过继承这两个基类可以实现自定义编码器,如Netty内置的编码器:StringEncoder、ObjectEncoder、ProtobufEncoder等。

从类图可以看出MessageToByteEncoder与MessageToMessageEncoder均实现了ChannelOutboundHandler接口,也就是说编码器是一个出站事件处理器,其会处理并传播出站事件。以MessageToByteEncoder为例,分析下其实现原理:

public void write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise) throws Exception {
    ByteBuf buf = null;
    try {
        // 判断编码器是否能处理该消息
        if (acceptOutboundMessage(msg)) {
            @SuppressWarnings("unchecked")
            // 将Object消息类型转换为实际类型
            I cast = (I) msg;
            // 分配内存
            buf = allocateBuffer(ctx, cast, preferDirect);
            try {
                // 调用子类方法进行编码
                encode(ctx, cast, buf);
            } finally {
                // 如果消息是ByteBuf类型则释放内存
                ReferenceCountUtil.release(cast);
            }

            if (buf.isReadable()) {
                // 传播写事件
                ctx.write(buf, promise);
            } else {
                buf.release();
                ctx.write(Unpooled.EMPTY_BUFFER, promise);
            }
            buf = null;
        } else {
            ctx.write(msg, promise);
        }
    } catch (EncoderException e) {
        throw e;
    } catch (Throwable e) {
        throw new EncoderException(e);
    } finally {
        if (buf != null) {
            buf.release();
        }
    }
}

write方法首先会调用acceptOutboundMessage方法判断是否能处理传入的消息,如果不能处理则将该事件向下传播。acceptOutboundMessage通过TypeParameterMatcher#match方法来进行判断。其中TypeParameterMatcher是在实例化编码器时初始化的,具体判断方法在其内部类ReflectiveMatcher中,其中type为编码器中的泛型:

private static final class ReflectiveMatcher extends TypeParameterMatcher {
    private final Class<?> type;

    ReflectiveMatcher(Class<?> type) {
        this.type = type;
    }

    @Override
    public boolean match(Object msg) {
        return type.isInstance(msg);
    }
}

编码器的核心方法为encode,该方法会将消息编码为ByteBuf。基类MessageToMessageEncode中的encode方法为抽象方法,这里使用了模版方法设计模式,需要由子类实现具体的编码逻辑:

protected abstract void encode(ChannelHandlerContext ctx, I msg, ByteBuf out) throws Exception;

以ObjectEncoder为例,看下ObjectEncoder这个编码器是怎么编码的:

protected void encode(ChannelHandlerContext ctx, Serializable msg, ByteBuf out) throws Exception {
  // 获取ByteBuf对象写指针索引位置  
  int startIdx = out.writerIndex();

    // 创建输出流
    ByteBufOutputStream bout = new ByteBufOutputStream(out);
    // 写入4个字节进行占位
    bout.write(LENGTH_PLACEHOLDER);
    ObjectOutputStream oout = new CompactObjectOutputStream(bout);
    // 将消息写入到输出流
    oout.writeObject(msg);
    oout.flush();
    oout.close();

    int endIdx = out.writerIndex();
        // 在输入流开始位置写入int类型的消息长度,即前四个字节
    out.setInt(startIdx, endIdx - startIdx - 4);
}

解码器

Netty解码器同样有两个抽象基类:MessageToByteDecoder与MessageToMessageDecoder,MessageToByteDecoder会将字节解码为消息,MessageToMessageDecoder会将消息解码为另一种消息。以MessageToByteDecoder为例,看下具体实现:

public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
    if (msg instanceof ByteBuf) {
        // 获取CodecOutputList,用于存放解码后的消息
        CodecOutputList out = CodecOutputList.newInstance();
        try {
            ByteBuf data = (ByteBuf) msg;
            first = cumulation == null;
            if (first) {
                // 第一次解码将数据赋值给cumulation
                cumulation = data;
            } else {
                // 不是第一次解码则将数据进行累加到cumulation
                cumulation = cumulator.cumulate(ctx.alloc(), cumulation, data);
            }
            // 解码
            callDecode(ctx, cumulation, out);
        } catch (DecoderException e) {
            throw e;
        } catch (Throwable t) {
            throw new DecoderException(t);
        } finally {
            // 如果cumulation不可读则,则释放cumulation
            if (cumulation != null && !cumulation.isReadable()) {
                numReads = 0;
                cumulation.release();
                cumulation = null;
            } else if (++ numReads >= discardAfterReads) {
                // 如果读次数超过16,则尝试丢弃一些字节
                // We did enough reads already try to discard some bytes so we not risk to see a OOME.
                // See https://github.com/netty/netty/issues/4275
                numReads = 0;
                discardSomeReadBytes();
            }

            int size = out.size();
            decodeWasNull = !out.insertSinceRecycled();
            // 传播事件
            fireChannelRead(ctx, out, size);
            out.recycle();
        }
    } else {
        ctx.fireChannelRead(msg);
    }
}

CodecOutputList是一个可复用的List,内部维护了一个长度为16的对象数组,用来缓存解码后的消息。CodecOutputList#newInstance方法首先会从对象池中获取,如果获取不到会进行创建。

读取到消息后,首先会将其放入到cumulation这个ByteBuf中,然后尝试解码,每次解码成功就会传播channelRead事件,将消息向下传播。如果消息不能解码,比如出现半包,或者出现粘包(一些字节不足以解码为一条消息),则会被累加到cumulation中等待下次接收到消息后处理。

解码的核心逻辑在callDecode中,该方法会将cumulation中累加的消息进行解码:

protected void callDecode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out) {
    try {
        while (in.isReadable()) {
            int outSize = out.size();

            if (outSize > 0) {
                fireChannelRead(ctx, out, outSize);
                out.clear();

                // Check if this handler was removed before continuing with decoding.
                // If it was removed, it is not safe to continue to operate on the buffer.
                //
                // See:
                // - https://github.com/netty/netty/issues/4635
                if (ctx.isRemoved()) {
                    break;
                }
                outSize = 0;
            }

            int oldInputLength = in.readableBytes();
            decode(ctx, in, out);

            // Check if this handler was removed before continuing the loop.
            // If it was removed, it is not safe to continue to operate on the buffer.
            //
            // See https://github.com/netty/netty/issues/1664
            if (ctx.isRemoved()) {
                break;
            }

            if (outSize == out.size()) {
                if (oldInputLength == in.readableBytes()) {
                    break;
                } else {
                    continue;
                }
            }

            if (oldInputLength == in.readableBytes()) {
                throw new DecoderException(
                        StringUtil.simpleClassName(getClass()) +
                        ".decode() did not read anything but decoded a message.");
            }

            if (isSingleDecode()) {
                break;
            }
        }
    } catch (DecoderException e) {
        throw e;
    } catch (Throwable cause) {
        throw new DecoderException(cause);
    }
}

其中decode是一个模版方法,需要由子类解码器实现具体的解码逻辑,解码后的消息会放入到CodecOutputList中。

解码后会调用fireChannelRead方法传播事件,该方法内部会遍历CodecOutputList集合中解码后的消息,将消息传播给下一个处理器:

static void fireChannelRead(ChannelHandlerContext ctx, CodecOutputList msgs, int numElements) {
    for (int i = 0; i < numElements; i ++) {
        ctx.fireChannelRead(msgs.getUnsafe(i));
    }
}
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,456评论 5 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,370评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,337评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,583评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,596评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,572评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,936评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,595评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,850评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,601评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,685评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,371评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,951评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,934评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,167评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,636评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,411评论 2 342

推荐阅读更多精彩内容