(十一)解码的原理

前面讲到了编码,那netty是怎么进行解码的?
其实也是类似的,既然有MessageToByteEncoder,也会有ByteToMessageDecoder.
所以重点还是在ByteToMessageDecoder这个类。
先看看这个类的结构体。


ByteToMessageDecoder

其实结构与MessageToByteEncoder类似。唯一的区别只是,ByteToMessageDecoder实现的是ChannelInboundHandler。

所以直接看一下ByteToMessageDecoder的源码吧。
为什么重点说到这个类的channelRead方法呢?
在前面说到netty是怎么样读数据的,最后ctx都会强转成ChannelInboundHandler,随后调用其channelRead方法。
我们自定义的解码器,由于继承了ByteToMessageDecoder(ByteToMessageDecoder是ChannelInboundHandler的子类)这个类,而这个类对于channelRead方法进行了覆写。
而ChannelInboundHandlerAdapter对于channelRead的实现,只是简单的做传播。

public abstract class ByteToMessageDecoder extends ChannelInboundHandlerAdapter {
    ByteBuf cumulation;
    private boolean first;

    @Override
    public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
        if (msg instanceof ByteBuf) {
             这其实是一个自定义的list
            CodecOutputList out = CodecOutputList.newInstance();
            try {
                ByteBuf data = (ByteBuf) msg;
                如果cumulation为空,则说明是第一次读取数据。
                first = cumulation == null;
                if (first) {
                    如果是第一次读取数据的话,cumulation就是当前传入的数据
                    cumulation = data;
                } else {
                    如果不是第一次读数据的话,要对之前的数据,以及本次读取到的数据进行合并。
                    cumulation = cumulator.cumulate(ctx.alloc(), cumulation, data);
                }
                合并完数据后,进行解码。
                callDecode(ctx, cumulation, out);
            } catch (DecoderException e) {
                throw e;
            } catch (Exception e) {
                throw new DecoderException(e);
            } finally {
                if (cumulation != null && !cumulation.isReadable()) {
                    数据已经读完,将cumulation置空
                    numReads = 0;
                    cumulation.release();
                    cumulation = null;
                } else if (++ numReads >= discardAfterReads) {
                    若干次之后,还还没有读完数据,就会舍弃一些数据。
                    清空cumulation的数据
                    numReads = 0;
                    discardSomeReadBytes();
                }
                int size = out.size();
                decodeWasNull = !out.insertSinceRecycled();
                最后进行传播。out是最后反序列化出来的对象集合,通过遍历的方式去传播。
                fireChannelRead(ctx, out, size);
                out.recycle();
            }
        } else {
            ctx.fireChannelRead(msg);
        }
    }
}

看完上述代码,估计流程也大概清楚了。
无非就是以下几步。
1.查看数据是否需要合并,如果需要合并则进行合并。
2.将数据进行反序列化,添加到out这个输出的集合中。
3.如果数据已经读完,再cumulation重置,如果若干次了,数据还木有读完,就会放弃一些数据。
4.最后就是将out这个输出的集合对象进行传播。一个对象就好像一个完整的数据包,所以以数据包为单位进行遍历传播。

如何进行数据合并

重点是在于以下这句代码

cumulator.cumulate(ctx.alloc(), cumulation, data);

下面来看看这个对象是如何生成的。

    public interface Cumulator {
        /**
         * Cumulate the given {@link ByteBuf}s and return the {@link ByteBuf} that holds the cumulated bytes.
         * The implementation is responsible to correctly handle the life-cycle of the given {@link ByteBuf}s and so
         * call {@link ByteBuf#release()} if a {@link ByteBuf} is fully consumed.
         */
        ByteBuf cumulate(ByteBufAllocator alloc, ByteBuf cumulation, ByteBuf in);
    }


public abstract class ByteToMessageDecoder extends ChannelInboundHandlerAdapter {
    public static final Cumulator MERGE_CUMULATOR = new Cumulator() {
        @Override
        public ByteBuf cumulate(ByteBufAllocator alloc, ByteBuf cumulation, ByteBuf in) {
            try {
                final ByteBuf buffer;
                其实转化一下  cumulation.writerIndex()  + in.readableBytes() > cumulation的容量,则说明cumulation需要扩容了。
                if (cumulation.writerIndex() > cumulation.maxCapacity() - in.readableBytes()
                    buffer = expandCumulation(alloc, cumulation, in.readableBytes());
                } else {
                    否则不需要扩容
                    buffer = cumulation;
                }
                将in里面的字节数据读取出来,并且写入到cumulation中
                buffer.writeBytes(in);
                return buffer;
            } finally {
                避免In没有被回收(切断引用,放到netty自己的回收站中),需要释放,重复利用。
                in.release();
            }
        }
    };

    static ByteBuf expandCumulation(ByteBufAllocator alloc, ByteBuf cumulation, int readable) {
        ByteBuf oldCumulation = cumulation;
        重新分配一个新的bytebuf
        cumulation = alloc.buffer(oldCumulation.readableBytes() + readable);
        写入数据,将旧的释放
        cumulation.writeBytes(oldCumulation);
        oldCumulation.release();
        return cumulation;
    }
}

数据合并完之后,就是如何序列化了

合并完数据之后,有一个方法callDecode,这个方法看名字就是进行反序列化的功能,具体还是看看代码。

public abstract class ByteToMessageDecoder extends ChannelInboundHandlerAdapter {
    protected void callDecode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out) {
        try {
            while (in.isReadable()) {
                int outSize = out.size();
                如果outSize已经大于0,说明已经有反序列的对象在集合里面了,说明其实数据包已经完整,
                所以对read事件发起传播,让各个ctx去处理read事件
                if (outSize > 0) {
                    fireChannelRead(ctx, out, outSize);
                    out.clear();
                    if (ctx.isRemoved()) {
                        break;
                    }
                    outSize = 0;
                }

                int oldInputLength = in.readableBytes();
                这里才是反序列化的实现,反序列化之后会将对象放到out集合中
                ========================================================================
                decodeRemovalReentryProtection(ctx, in, out);
                if (ctx.isRemoved()) {
                    break;
                }
                如果一开始out的大小,跟反序列化完之后一样,读数据的过程中bytebuf的readIndex会一直移动。
                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 (Exception cause) {
            throw new DecoderException(cause);
        }
    }
}

从上面例子,大概看得出整个反序列化的过程,其实就是把数据一点一点读出来,直到读完数据,在读数据的过程中,会将字节数据反序列,添加到out的集合中。

public abstract class ByteToMessageDecoder extends ChannelInboundHandlerAdapter {
    final void decodeRemovalReentryProtection(ChannelHandlerContext ctx, ByteBuf in, List<Object> out)
            throws Exception {
        decodeState = STATE_CALLING_CHILD_DECODE;
        try {
            这个方法就是留给我们自己去实现的方法。
            decode(ctx, in, out);
        } finally {
            boolean removePending = decodeState == STATE_HANDLER_REMOVED_PENDING;
            decodeState = STATE_INIT;
            if (removePending) {
                handlerRemoved(ctx);
            }
        }
    }
}

所以怎么用呢?

自己定义一个解码器,将字节反序列后,加入到输出集合即可。
其实这个方法有问题,应该要判断是不是一个完整的数据包,再决定要不要读取,而不是直接读取。以上只是一个使用的例子。

public class CustomDecoder extends ByteToMessageDecoder{

    @Override
    protected void decode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out) throws Exception {
        int readbytes = in.readableBytes();
        byte[] bytes = new byte[readbytes];
        in.readBytes(bytes);
        String json = new String(bytes);
        CustomSystemInfo csi = JSONObject.parseObject(json, CustomSystemInfo.class);
        out.add(csi);
    }
}

这里需要注意的点,就是解码器,应该排在需要去处理业务对象的channelHandler之前,否则处理业务数据的channelHandler拿到的则是未经过反序列的bytebuf。直接转成业务对象就会出现类型转化错误。
以上就是netty反序列化的原理。

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

推荐阅读更多精彩内容