Netty ChannelHandlerContext与Channel

当我们在一个Handler中时，我们要想写数据，有两种方式。一种是调用ChannelHandlerContext的相关的写数据的方法，一种是调用ChannelHandlerContext.channel()的相关的写数据的方法。

这两种方法，差别不小。如果不注意，就会踩坑。

我们有如下代码:

package com.hypers.TestNetty;

import io.netty.bootstrap.ServerBootstrap;
import io.netty.buffer.ByteBuf;
import io.netty.channel.*;
import io.netty.channel.nio.NioEventLoopGroup;
import io.netty.channel.socket.nio.NioServerSocketChannel;
import io.netty.channel.socket.nio.NioSocketChannel;
import io.netty.handler.codec.string.StringDecoder;
import io.netty.handler.codec.string.StringEncoder;
import io.netty.util.concurrent.Future;
import io.netty.util.concurrent.GenericFutureListener;

import java.nio.charset.Charset;
import java.util.concurrent.BlockingQueue;
import java.util.concurrent.LinkedBlockingQueue;

public class NettyServerForString {

    private static BlockingQueue<ChannelHandlerContext> queue = new LinkedBlockingQueue<ChannelHandlerContext>();

    public static void main(String[] args) {

        new Thread(new Runnable() {
            @Override
            public void run() {

                ChannelHandlerContext ctx = null;
                while (true) {
                    try {
                        if ((ctx = queue.take()) != null) {
                            String str = "Response " + System.currentTimeMillis();
                            byte[] bytes = str.getBytes(Charset.forName("utf-8"));
                            ByteBuf byteBuf = ctx.alloc().buffer();
                            byteBuf.writeBytes(bytes);
                            ctx.writeAndFlush(byteBuf);
                        }
                    } catch (InterruptedException e) {
                        e.printStackTrace();
                    }
                }
            }
        }).start();

        ServerBootstrap serverBootstrap = new ServerBootstrap();

        NioEventLoopGroup boss = new NioEventLoopGroup();
        NioEventLoopGroup worker = new NioEventLoopGroup();

        serverBootstrap
                .group(boss, worker)
                .channel(NioServerSocketChannel.class)
                .option(ChannelOption.SO_BACKLOG, 1024)
                .childOption(ChannelOption.SO_KEEPALIVE, true)
                .childOption(ChannelOption.TCP_NODELAY, true)
                .childHandler(new ChannelInitializer<NioSocketChannel>() {
                    @Override
                    protected void initChannel(NioSocketChannel ch) throws Exception {
                        ch.pipeline().addLast(new StringDecoder());
                        ch.pipeline().addLast(new SimpleChannelInboundHandler<String>() {
                            @Override
                            protected void channelRead0(ChannelHandlerContext ctx, String msg) throws Exception {
                                System.out.println("------ Received: " + msg);
                                queue.put(ctx);
                            }
                        });
                        ch.pipeline().addLast(new StringEncoder());
                    }
                });
        bind(serverBootstrap, 8000);
    }

    private static void bind(final ServerBootstrap serverBootstrap, final int port) {
        serverBootstrap.bind(port).addListener(new GenericFutureListener<Future<? super Void>>() {
            @Override
            public void operationComplete(Future<? super Void> future) throws Exception {
                if (!future.isSuccess()) {
                    System.out.println("Try to bind " + (port + 1) + "...");
                    bind(serverBootstrap, port + 1);
                }
            }
        });
    }

}

这段代码会接收客户端的消息，并给它一个回应。

看起来很简单，其实暗流涌动。

我们可以看到，上面给客户端回消息的时候，我们写的是ByteBuf。但是我只是想回一个字符串而已，那我改成这样子好不好?

package com.hypers.TestNetty;

import io.netty.bootstrap.ServerBootstrap;
import io.netty.buffer.ByteBuf;
import io.netty.channel.*;
import io.netty.channel.nio.NioEventLoopGroup;
import io.netty.channel.socket.nio.NioServerSocketChannel;
import io.netty.channel.socket.nio.NioSocketChannel;
import io.netty.handler.codec.string.StringDecoder;
import io.netty.handler.codec.string.StringEncoder;
import io.netty.util.concurrent.Future;
import io.netty.util.concurrent.GenericFutureListener;

import java.nio.charset.Charset;
import java.util.concurrent.BlockingQueue;
import java.util.concurrent.LinkedBlockingQueue;

public class NettyServerForString {

    private static BlockingQueue<ChannelHandlerContext> queue = new LinkedBlockingQueue<ChannelHandlerContext>();

    public static void main(String[] args) {

        new Thread(new Runnable() {
            @Override
            public void run() {

                ChannelHandlerContext ctx = null;
                while (true) {
                    try {
                        if ((ctx = queue.take()) != null) {
                            String str = "Response " + System.currentTimeMillis();                                
                            ctx.writeAndFlush(str);
                        }
                    } catch (InterruptedException e) {
                        e.printStackTrace();
                    }
                }
            }
        }).start();

        ServerBootstrap serverBootstrap = new ServerBootstrap();

        NioEventLoopGroup boss = new NioEventLoopGroup();
        NioEventLoopGroup worker = new NioEventLoopGroup();

        serverBootstrap
                .group(boss, worker)
                .channel(NioServerSocketChannel.class)
                .option(ChannelOption.SO_BACKLOG, 1024)
                .childOption(ChannelOption.SO_KEEPALIVE, true)
                .childOption(ChannelOption.TCP_NODELAY, true)
                .childHandler(new ChannelInitializer<NioSocketChannel>() {
                    @Override
                    protected void initChannel(NioSocketChannel ch) throws Exception {
                        ch.pipeline().addLast(new StringDecoder());
                        ch.pipeline().addLast(new SimpleChannelInboundHandler<String>() {
                            @Override
                            protected void channelRead0(ChannelHandlerContext ctx, String msg) throws Exception {
                                System.out.println("------ Received: " + msg);
                                queue.put(ctx);
                            }
                        });
                        ch.pipeline().addLast(new StringEncoder());
                    }
                });
        bind(serverBootstrap, 8000);
    }

    private static void bind(final ServerBootstrap serverBootstrap, final int port) {
        serverBootstrap.bind(port).addListener(new GenericFutureListener<Future<? super Void>>() {
            @Override
            public void operationComplete(Future<? super Void> future) throws Exception {
                if (!future.isSuccess()) {
                    System.out.println("Try to bind " + (port + 1) + "...");
                    bind(serverBootstrap, port + 1);
                }
            }
        });
    }

}

不好意思，不好。

不仅不好，你还会连不好的原因都不知道。不会给你报异常，这条消息就会被静悄悄的扔掉了。

我在调试这个问题的时候，不知道到底是服务器端没有给客户端发送消息，还是客户端收到了以后，由于不是不对，而给扔掉了，最后通过Wireshark抓包，才确定了是服务器端压根就没有给客户端发送消息。

嗯，知道了是服务器端压根就没有给客户端发送消息以后，通过打断点一点点调试，我们会发现错误其实是java.lang.UnsupportedOperationException: unsupported message type: String (expected: ByteBuf, FileRegion)

咦？丫的。我们下面定义的handler的顺序明明是StringDecoder -> SimpleChannelInboundHandler -> StringEncoder。那我拿到的是SimpleChannelInboundHandler的ChannelHandlerContext，那发送消息的时候，接下来不久应该是StringEncoder进行处理了么？而且它不就是把String转换成ByteBuf么？有错么？

有错。为啥？

因为ChannelHandlerContext.writeAndFlush()在写数据时，实际上，会从后往前(从当前位置)寻找第一个OutboundHandler，然后开始输出。在上面的这个例子里，就是从SimpleChannelInboundHandler开始，从后往前找OutputboundHandler。而它前面并没有OutputboundHandler。所以最后就找到了DefaultChannelPipeline.HeadContext。这个是Netty中Channel的Pipeline的第一个Handler。

然后，将String传递给它，让它进行处理，就会报上面那个错误。

Netty中相关代码如下:

那么，如何改正呢？只需要将StringEncoder放到SimpleChannelInboundHandler前面就可以了。

但是这样感觉有点奇怪，对吧? StringEncoder明明就应该在SimpleChannelInboundHandler后面，凭啥提到前面去。

还有一种不需要更改顺序也能跑通的方式，就是使用ChannelHandlerContext.channel()的写方法。

package com.hypers.TestNetty;

import io.netty.bootstrap.ServerBootstrap;
import io.netty.buffer.ByteBuf;
import io.netty.channel.*;
import io.netty.channel.nio.NioEventLoopGroup;
import io.netty.channel.socket.nio.NioServerSocketChannel;
import io.netty.channel.socket.nio.NioSocketChannel;
import io.netty.handler.codec.string.StringDecoder;
import io.netty.handler.codec.string.StringEncoder;
import io.netty.util.concurrent.Future;
import io.netty.util.concurrent.GenericFutureListener;

import java.nio.charset.Charset;
import java.util.concurrent.BlockingQueue;
import java.util.concurrent.LinkedBlockingQueue;

public class NettyServerForString {

    private static BlockingQueue<ChannelHandlerContext> queue = new LinkedBlockingQueue<ChannelHandlerContext>();

    public static void main(String[] args) {

        new Thread(new Runnable() {
            @Override
            public void run() {

                ChannelHandlerContext ctx = null;
                while (true) {
                    try {
                        if ((ctx = queue.take()) != null) {
                            String str = "Response " + System.currentTimeMillis();                                
                            ctx.channel().writeAndFlush(str);
                        }
                    } catch (InterruptedException e) {
                        e.printStackTrace();
                    }
                }
            }
        }).start();

        ServerBootstrap serverBootstrap = new ServerBootstrap();

        NioEventLoopGroup boss = new NioEventLoopGroup();
        NioEventLoopGroup worker = new NioEventLoopGroup();

        serverBootstrap
                .group(boss, worker)
                .channel(NioServerSocketChannel.class)
                .option(ChannelOption.SO_BACKLOG, 1024)
                .childOption(ChannelOption.SO_KEEPALIVE, true)
                .childOption(ChannelOption.TCP_NODELAY, true)
                .childHandler(new ChannelInitializer<NioSocketChannel>() {
                    @Override
                    protected void initChannel(NioSocketChannel ch) throws Exception {
                        ch.pipeline().addLast(new StringDecoder());
                        ch.pipeline().addLast(new SimpleChannelInboundHandler<String>() {
                            @Override
                            protected void channelRead0(ChannelHandlerContext ctx, String msg) throws Exception {
                                System.out.println("------ Received: " + msg);
                                queue.put(ctx);
                            }
                        });
                        ch.pipeline().addLast(new StringEncoder());
                    }
                });
        bind(serverBootstrap, 8000);
    }

    private static void bind(final ServerBootstrap serverBootstrap, final int port) {
        serverBootstrap.bind(port).addListener(new GenericFutureListener<Future<? super Void>>() {
            @Override
            public void operationComplete(Future<? super Void> future) throws Exception {
                if (!future.isSuccess()) {
                    System.out.println("Try to bind " + (port + 1) + "...");
                    bind(serverBootstrap, port + 1);
                }
            }
        });
    }

}

这样子也可以正确输出。因为ChannelHandlerContext.channel()会获取到一个Channel，而Channel的writeAndFlush()方法的定义如下:

tail是固定的，就是TailContext。它是Pipeline中的最后一个Handler。然后，它也会从后往前寻找第一个OutputboundHandler，找到了StringEncoder，然后将String传给它。这样就能给客户端正确的发送消息。

如果你把最后的那个StringEncoder去掉，那么还是会出现跟上面类似的错误，导致不能给客户端发送消息。

短短的几行代码，需要注意这么多事情。也是有点醉。

©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 159,716评论 4赞 364
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 67,558评论 1赞 294
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 109,431评论 0赞 244
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 44,127评论 0赞 209
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 52,511评论 3赞 287
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 40,692评论 1赞 222
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 31,915评论 2赞 313
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 30,664评论 0赞 202
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 34,412评论 1赞 246
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,616评论 2赞 245
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,105评论 1赞 260
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 28,424评论 2赞 254
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 33,098评论 3赞 238
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,096评论 0赞 8
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,869评论 0赞 197
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 35,748评论 2赞 276
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 35,641评论 2赞 271

推荐阅读更多精彩内容