「Netty核心技术」8-自定义一个Json编解码器

在讲解netty编解码MessageToByteEncoder类和ByteToMessageDecoder类之前，我想先讲解一个例子，如何使用这两个类。

需求：

利用Netty的MessageToByteEncoder类和ByteToMessageDecoder类这两个编解码器，来定义一个Json的编解码器。

编码：Json对象转化成ByteBuf

解码：ByteBuf转化成Json字符串。

定义编码器JsonEncoder

public class JsonEncoder extends MessageToByteEncoder<Object>{
    Gson gson = new Gson();
    @Override
    protected void encode(ChannelHandlerContext ctx, Object msg, ByteBuf out) throws Exception {
        out.writeBytes(gson.toJson(msg).getBytes());
    }
}

编码器JsonEncoder是继承了MessageToByteEncoder，实现了抽象类encode方法。out.writeBytes就是将msg对象转化成Json字符串并且获得bytes。

定义解码器JsonDecoder

public class JsonDecoder extends ByteToMessageDecoder {
    @Override
    protected void decode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out) throws Exception {
        byte[] data = new byte[in.readableBytes()];
        in.readBytes(data);
        out.add(new String(data,"utf-8"));
    }
}

解码器JsonDecoder继承了ByteToMessageDecoder，实现了抽象类decode。读取ByteBuf的字节流，然后转化成字符串。

定义服务端事件处理器BitServerJsonHandler

public class BitServerJsonHandler extends ChannelInboundHandlerAdapter {

    Gson gson = new Gson();
    @Override
    public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
        try {
            MyData myData = gson.fromJson(String.valueOf(msg),MyData.class);
            System.out.println(myData.toString());
        }catch (Exception e){
            e.printStackTrace();
        }
        super.channelRead(ctx, msg);
    }
}

服务端读取数据的时候，msg已经是一个Json字符串了，所以直接解析成对应的对象即可。

定义客户端事件处理器BitClientJsonHandler

public class BitClientJsonHandler extends ChannelInboundHandlerAdapter {

    @Override
    public void channelActive(ChannelHandlerContext ctx) throws Exception {
        MyData myData = new MyData();
        myData.setUserName("1024bit");
        myData.setAge(18);
        ctx.writeAndFlush(myData);
        super.channelActive(ctx);
    }
}

客户端事件，TCP连接建立的时候，像服务端发送一个消息，MyData对象。

其中实体类MyData

public class MyData {

    private String userName;
    private int age;
    public String getUserName() {
        return userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }
    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    @Override
    public String toString() {
        return "MyData{" +
                "userName='" + userName + '\'' +
                ", age=" + age +
                '}';
    }
}

定义服务端启动器BitServer

public class BitServer {

    public void bind(int port){

        //两个NIO线程池，每一个NioEventLoopGroup会生成多个NioEventLoop
        //，每个NIoEventLoop对应一个Reactor线程

        //Boss线程用来接收客户端TCP连接
        EventLoopGroup bossGroup = new NioEventLoopGroup();

        //work线程用来处理I/O相关的读写操作，或者执行系统Task、定时任务等等
        EventLoopGroup workGroup = new NioEventLoopGroup();

        //启动辅助类
        ServerBootstrap bootstrap = new ServerBootstrap();
        bootstrap.group(bossGroup,workGroup)
                //设置Channel处理类型为NioServerSocketChannel
                .channel(NioServerSocketChannel.class)
                //配置tcp参数
                .option(ChannelOption.SO_BACKLOG,1024)
                //设置I/O事件处理类
                .childHandler(new ChannelInitializer<SocketChannel>() {
                    @Override
                    protected void initChannel(SocketChannel ch) throws Exception {
                        //添加事件处理
                        ch.pipeline().addLast(new JsonDecoder());
                        ch.pipeline().addLast(new JsonEncoder());
                        ch.pipeline().addLast(new BitServerJsonHandler());
                    }
                });
        try {
            //绑定端口等待服务启动完毕
            ChannelFuture ch = bootstrap.bind(port).sync();
            System.out.println("Bit Server start port :" + port);
            //阻塞，等待服务端链路关闭之后main才能退出，服务在此就已经启动。
            ch.channel().closeFuture().sync();
        } catch (InterruptedException e) {
            e.printStackTrace();
        }finally {
            //NIO线程池优雅退出，释放相关的资源
            bossGroup.shutdownGracefully();
            workGroup.shutdownGracefully();
        }
    }

    public static void main(String[] args) {
        new BitServer().bind(8080);
    }
}

定义客户端启动器

public class BitClient {

    public void connect(String host,int port){
        EventLoopGroup group = new NioEventLoopGroup();
        Bootstrap bootstrap = new Bootstrap();
        bootstrap.group(group)
                .channel(NioSocketChannel.class)
                .option(ChannelOption.TCP_NODELAY,true)
                .handler(new ChannelInitializer<SocketChannel>() {
                    @Override
                    protected void initChannel(SocketChannel ch) throws Exception {
                            ch.pipeline().addLast(new JsonDecoder());
                            ch.pipeline().addLast(new JsonEncoder());
                            ch.pipeline().addLast(new BitClientJsonHandler());
                    }
                });

        try {
            ChannelFuture ch = bootstrap.connect(host, port).sync();
            System.out.println("client start success");
            ch.channel().closeFuture().sync();
        } catch (InterruptedException e) {
            e.printStackTrace();
        }finally {
            group.shutdownGracefully();
        }
    }

    public static void main(String[] args) {
        new BitClient().connect("localhost",8080);
    }
}

先启动BitServer

显示

Bit Server start port :8080

再启动BitClient

客户端显示

client start success

服务端显示

Bit Server start port :8080

MyData{userName='1024bit', age=18}

程序运行正常！

整体流程

1.服务端启动，端口绑定8080端口。

2.客户端连接服务端，TCP连接建立成功，触发BitClientJsonHandler.channelActive事件。发送一个myData数据。

3.myData数据通过编码器JsonEncoder，将对象转化成Json字符串，并且获得它的字节流，传入ByteBuf。最终调用Socket.write。

3.服务端收到收据的时候，触发Socket.read。然后经过ChannelHandler处理。解码器JsonDecoder将ByteBuf对象转化成了Json字符串。最终到ChannelHandlerContext事件。

4.服务端收到读取数据事件，触发BitServerJsonHandler.channelRead，将解码后的json字符串转化成MyData对象。打印。

总结

本篇主要是讲解了一个例子，如何使用netty编解码MessageToByteEncoder类和ByteToMessageDecoder类，以及简单的描述了，这个程序运行时候的，数据流向。

下篇深入，MessageToByteEncoder类和ByteToMessageDecoder类源码去分析。

推荐阅读

「Netty核心技术」7-ChannelHandler源码

「Netty核心技术」-ChannelPipeline源码2

「Netty核心技术」6-ChannelPipeline源码

「Netty核心技术」5-客户端启动

「Netty核心技术」4-服务端启动

「Netty核心技术」3-AbstractBootStrap

「Netty核心技术」2-HelloWorld

「Netty核心技术」1-序言