Netty实战——常用的编解码器和自定义编解码器

Netty提供了丰富的编解码器支持，用于处理各种协议的编解码，其中一些常用的编解码器包括：

1. ByteToMessageCodec：将字节数据解码为消息对象，或将消息对象编码为字节数据。
2. StringEncoder/StringDecoder：用于处理字符串的编解码。
3. LineBasedFrameDecoder：按行切分数据帧。
4. DelimiterBasedFrameDecoder：按照特定的分隔符切分数据帧。
5. LengthFieldBasedFrameDecoder：根据长度字段切分数据帧。
6. ProtobufEncoder/ProtobufDecoder：用于处理Google Protocol Buffers格式的编解码。
7. ObjectEncoder/ObjectDecoder：将Java对象编码为字节数据，或将字节数据解码为Java对象。

下面通过代码看看如何使用Netty提供的编解码器来处理自定义协议的消息。

public class CustomProtocolServer {
    public static void main(String[] args) throws Exception {
        EventLoopGroup group = new NioEventLoopGroup();
        
        try {
            ServerBootstrap bootstrap = new ServerBootstrap();
            bootstrap.group(group)
                     .channel(NioServerSocketChannel.class)
                     .childHandler(new ChannelInitializer<SocketChannel>() {
                         @Override
                         protected void initChannel(SocketChannel ch) throws Exception {
                             ChannelPipeline pipeline = ch.pipeline();
                             pipeline.addLast(new LengthFieldBasedFrameDecoder(1024, 0, 4, 0, 4));
                             pipeline.addLast(new CustomProtocolDecoder());
                             pipeline.addLast(new CustomProtocolEncoder());
                             pipeline.addLast(new CustomProtocolServerHandler());
                         }
                     });
            
            ChannelFuture future = bootstrap.bind(8888).sync();
            System.out.println("Server started and listening on port 8888");

            future.channel().closeFuture().sync();
        } finally {
            group.shutdownGracefully();
        }
    }
}

上面代码中，创建了一个自定义协议的服务器，通过使用 LengthFieldBasedFrameDecoder 对数据进行帧的切分，然后使用 CustomProtocolDecoder 和 CustomProtocolEncoder 来处理自定义协议的编解码，最后在 CustomProtocolServerHandler 中处理解码后的消息。通过使用Netty提供的编解码器，我们可以方便地处理各种协议的消息编解码。Netty允许用户实现自定义的编解码器来支持特定协议。通过自定义编解码器，可以灵活地处理特定协议的消息格式，实现消息的编码和解码。实现自定义编解码器一般需要继承Netty提供的相关编解码器类，并重写相应的方法来实现协议的编解码逻辑。

下面使用代码看看如何实现自定义编解码器来支持特定协议的消息格式：

首先，定义一个自定义的消息对象。

public class CustomMessage {
    private int id;
    private String content;

    // 省略构造方法、getter和setter
}

然后，实现自定义的编解码器 CustomProtocolDecoder 和 CustomProtocolEncoder ：

public class CustomProtocolDecoder extends ByteToMessageDecoder {
    @Override
    protected void decode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out) throws Exception {
        if (in.readableBytes() < 8) {
            return; // 数据不足时等待
        }

        int id = in.readInt();
        int contentLength = in.readInt();
        if (in.readableBytes() < contentLength) {
            in.resetReaderIndex(); // 重置读指针
            return; // 数据不完整时等待
        }

        byte[] contentBytes = new byte[contentLength];
        in.readBytes(contentBytes);
        String content = new String(contentBytes, StandardCharsets.UTF_8);

        CustomMessage message = new CustomMessage(id, content);
        out.add(message);
    }
}

public class CustomProtocolEncoder extends MessageToByteEncoder<CustomMessage> {
    @Override
    protected void encode(ChannelHandlerContext ctx, CustomMessage message, ByteBuf out) throws Exception {
        out.writeInt(message.getId());
        byte[] contentBytes = message.getContent().getBytes(StandardCharsets.UTF_8);
        out.writeInt(contentBytes.length);
        out.writeBytes(contentBytes);
    }
}

最后，在Netty服务器的 ChannelInitializer 中添加自定义编解码器：

ChannelPipeline pipeline = ch.pipeline();
pipeline.addLast(new CustomProtocolDecoder());
pipeline.addLast(new CustomProtocolEncoder());
pipeline.addLast(new CustomProtocolServerHandler());

这样就实现了自定义的编解码器来支持特定协议的消息格式。在 CustomProtocolDecoder 中实现了对消息的解码逻辑，将字节数据解析为 CustomMessage 对象；在 CustomProtocolEncoder 中实现了对消息的编码逻辑，将 CustomMessage 对象编码为字节数据。通过这种方式，就可以灵活地处理特定协议的消息格式。