netty之ByteBuf引用计数使用

在netty中,ByteBuf是对字节的封装,对nio的ByteBuffer的增强,用于从socket缓冲区读取和写入数据的。

ByteBuf有基于堆内存和直接内存的,若是堆内存的,应用程序无需考虑什么时候去释放,因为GC会帮助做了;若是直接内存的,那么应用程序不用的时候,需要主动释放。

在netty中,是通过引用计数来实现的,接口形式表现为ReferenceCounted,ByteBuf会继承这个接口,每个ByteBuf对象都会有一个引用计数,当这个数值为0时,那么这个对象的方法便无法使用了,新创建的ByteBuf对象引用计数值为1,可通过对象retain和release对这个值进行增加和减少。所以应用程序中,将ByteBuf的引用计数减为0后,netty就会完成内存释放

如果ByteBuf的引用计数变为0了,调用该对象的相关方法都会抛出异常。

ByteBuf buffer = ByteBufAllocator.DEFAULT.buffer();
System.out.println(buffer.refCnt());//初始值为1
buffer.release();//将引用计数-1
System.out.println(buffer.refCnt());//此时引用计数变为0
//buffer.writeBytes("hello world".getBytes());//这行代码会抛异常
buffer.retain();//将引用计数+1
System.out.println(buffer.refCnt());
buffer.writeByte(0);//可以对ByteBuf对象进行正常的操作

在应用程序中一般如何使用呢,我们看如下这个例子

new ServerBootstrap()
    .group(new NioEventLoopGroup(), new NioEventLoopGroup())
    .channel(NioServerSocketChannel.class)
    .childHandler(new ChannelInitializer<NioSocketChannel>() {
        @Override
        protected void initChannel(NioSocketChannel ch) throws Exception {
            ChannelPipeline pipeline = ch.pipeline();
            pipeline.addLast(new LoggingHandler(LogLevel.DEBUG));
            pipeline.addLast("inboundHandler1", new ChannelInboundHandlerAdapter() {
                @Override
                public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
                    ByteBuf buf = (ByteBuf) msg;
                                    buf.release();
                    log.info("inboundHandler1 referenceCount {}", buf.refCnt());
                    ctx.fireChannelRead(msg);
                }
            });
            pipeline.addLast("outboundHandler1", new ChannelOutboundHandlerAdapter() {
                @Override
                public void write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise) throws Exception {
                    ByteBuf buf = (ByteBuf) msg;
                    log.info("outboundHandler1 referenceCount {}", buf.refCnt());
                    super.write(ctx, msg, promise);
                }
            });
            pipeline.addLast("inboundHandler2", new ChannelInboundHandlerAdapter() {
                @Override
                public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
                    ByteBuf buf = (ByteBuf) msg;
                    log.info("inboundHandler2 referenceCount {}", buf.refCnt());
                    byte readByte = buf.readByte();
                                        System.out.println(readByte);
                    ctx.writeAndFlush("hello world");
                }
            });
            pipeline.addLast("outboundHandler2", new ChannelOutboundHandlerAdapter() {
                @Override
                public void write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise) throws Exception {
                    ByteBuf buf = (ByteBuf) msg;
                    log.info("outboundHandler2 referenceCount {}", buf.refCnt());
                    super.write(ctx, msg, promise);
                }
            });
        }
    })
    .bind(8899);

在这个例子中,创建了两个入站处理器和两个出站处理器。在inboundHandler1中接收到msg后,调用release方法,将其引用计数变为0,然后就传递给下一个inboundHandler,这样在inboundHandler2中要使用这个byteBuf对象的方法时就会抛异常。

因此,若是ByteBuf对象不会再传递给下一个handler了,才可以release,或者是每个handler不对引用计数做变化,每个方法调用后将其传递给下一个handler,这样pipeline的TailContext最终也会帮助我们进行release

写入数据也一样,出站处理器尽量不对ByteBuf的引用计数做变化,只需一直往后传递即可,pipeline的HeadContext最终也会确保ByteBuf对象释放。若是HeadContext在接收到ByteBuf对象时,引用计数已经是0了,那么无法将数据传输出去。

//TailContext的channelRead方法逻辑
protected void onUnhandledInboundMessage(Object msg) {
        try {
            logger.debug(
                    "Discarded inbound message {} that reached at the tail of the pipeline. " +
                            "Please check your pipeline configuration.", msg);
        } finally {
            ReferenceCountUtil.release(msg);
        }
    }

//HeadContext的channelRead方法逻辑
public final void write(Object msg, ChannelPromise promise) {
    assertEventLoop();

    ChannelOutboundBuffer outboundBuffer = this.outboundBuffer;
    if (outboundBuffer == null) {
        // If the outboundBuffer is null we know the channel was closed and so
        // need to fail the future right away. If it is not null the handling of the rest
        // will be done in flush0()
        // See https://github.com/netty/netty/issues/2362
        safeSetFailure(promise, newClosedChannelException(initialCloseCause, "write(Object, ChannelPromise)"));
        // release message now to prevent resource-leak
        ReferenceCountUtil.release(msg);
        return;
    }

    int size;
    try {
        msg = filterOutboundMessage(msg);
        size = pipeline.estimatorHandle().size(msg);
        if (size < 0) {
            size = 0;
        }
    } catch (Throwable t) {
        safeSetFailure(promise, t);
        ReferenceCountUtil.release(msg);
        return;
    }

    outboundBuffer.addMessage(msg, size, promise);
}

如果在一个handler中,对ByteBuf处理完了,并转换为其他对象传递给下一个handler,那么这个handler的方法中就可以将ByteBuf释放掉。

当然了,具体的情况要具体分析,总之一句话,确保在使用ByteBuf对象时,其引用计数值不能为0,不再使用ByteBuf时,引用计数要改为0

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

推荐阅读更多精彩内容