Netty如何自定义编码解码器

 更新时间:2025年03月06日 10:35:31   作者:帅气的人123  
Netty自定义编码解码器:InboundHandler处理入栈数据,OutboundHandler处理出栈数据,解码器继承ByteToMessageDecoder,编码器继承MessageToByteEncoder,ReplayingDecoder简化了解码逻辑,但可能因异常重试导致性能下降

Netty 自定义编码解码器

入栈:InboundHandler ,出栈:OutboundHandler。Netty 构建 chain 来处理业务。

自定义一个解码器

解码器主要是对客户端发送的消息进行解码处理,所以他是一个入栈的处理器,因此他会有一个入栈的标识ibound=true;

解码器一般我都们都会基层 Netty 提供给的一个实现类来实现自己的解码逻辑 -> io.netty.handler.codec.ByteToMessageDecoder 这就是解码的抽象类,默认我们要实现一个抽象方法

com.netty.codec.custom.InboundAndOutboundHandler#decode 

这个方法有大概三个参数;

  • ChannelHandlerContext channelHandlerContext 这个是上下文信息,可以获取通道管道等信息。
  • ByteBuf byteBuf 客户端发送的消息就是存在这个参数的对象里面我们要通过这个对象的read***方法读取我们需要的数据类型,可以是 LongByte 等类型的数据然后我们可以就可以转换成为我们需要的格式。
  • List<Object> list 集合,将解码后的数据传递给下一个inboundHandler 处理类。

代码示例

@Override
protected void decode(ChannelHandlerContext channelHandlerContext, ByteBuf byteBuf, List<Object> list) {
    // Long => 8 byte
    if (byteBuf.readableBytes() >= 8) {
        list.add(byteBuf.readLong());
    } else log.warn("字节数异常 => {}", byteBuf.readableBytes());
}

这样我们就实现了一个简单的解码器。

自定义一个编码器

解码器主要是对服务端将要发送给客户端的消息进行编码处理,所以他是一个出栈的处理器,因此他会有一个入栈的标识outbound=true;

使用 Netty 提供的抽象类 => io.netty.handler.codec.MessageToByteEncoder<T> 泛型 T 表示你要发送的消息的类型,实现抽象方法 => com.netty.codec.custom.OutboundHandler#encode 方法的参数有三个:

  • ChannelHandlerContext channelHandlerContext 这个是上下文信息,可以获取通道管道等信息。
  • Long msg 服务端要发送给客户端的消息
  • ByteBuf byteBuf

代码示例

@Override
protected void encode(ChannelHandlerContext channelHandlerContext, Long msg, ByteBuf byteBuf) {
    byteBuf.writeLong(msg);
    log.info("发送消息成功");
}

后续 -> io.netty.handler.codec.ReplayingDecoder

ByteToMessage 其实在使用过程中会遇到一些问题,例如:

当我们的解码器中想要将字节转换为一个 Integer ,我们知道 Integer 是四个字节的,但是如果在读取的时候不够四个字节,这个时候我们就需要做一些判断逻辑 => if (byteBuf.readableBytes() >= 4) 当这个返回值为 true 的时候我么就可以继续执行解码的逻辑。

那我们怎么可以跳过这一步不判断直接进行我们的转换逻辑呢?

这个时候就可以使用 Netty 的

io.netty.handler.codec.ReplayingDecoder

可以不用判断可读字节数的原理:

ReplayingDecoderByteToMessage 的子类,源码如下:

public abstract class ReplayingDecoder<S> extends ByteToMessageDecoder {
    ...
}

ReplayingDecoder 的秘密就是对 ByteToMessageCallDecode(...) 方法的重写,观摩一下具体实现:

@Override
protected void callDecode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out) {
    replayable.setCumulation(in);
    try {
        while (in.isReadable()) {
            int oldReaderIndex = checkpoint = in.readerIndex();
            int outSize = out.size();

            if (outSize > 0) {
                fireChannelRead(ctx, out, outSize);
                out.clear();

                // Check if this handler was removed before continuing with decoding.
                // If it was removed, it is not safe to continue to operate on the buffer.
                //
                // See:
                // - https://github.com/netty/netty/issues/4635
                if (ctx.isRemoved()) {
                    break;
                }
                outSize = 0;
            }

            S oldState = state;
            int oldInputLength = in.readableBytes();
            try {
                decodeRemovalReentryProtection(ctx, replayable, out);

                // Check if this handler was removed before continuing the loop.
                // If it was removed, it is not safe to continue to operate on the buffer.
                //
                // See https://github.com/netty/netty/issues/1664
                if (ctx.isRemoved()) {
                    break;
                }

                if (outSize == out.size()) {
                    if (oldInputLength == in.readableBytes() && oldState == state) {
                        throw new DecoderException(
                                StringUtil.simpleClassName(getClass()) + ".decode() must consume the inbound " +
                                "data or change its state if it did not decode anything.");
                    } else {
                        // Previous data has been discarded or caused state transition.
                        // Probably it is reading on.
                        continue;
                    }
                }
            } catch (Signal replay) {
                replay.expect(REPLAY);

                // Check if this handler was removed before continuing the loop.
                // If it was removed, it is not safe to continue to operate on the buffer.
                //
                // See https://github.com/netty/netty/issues/1664
                if (ctx.isRemoved()) {
                    break;
                }

                // Return to the checkpoint (or oldPosition) and retry.
                int checkpoint = this.checkpoint;
                if (checkpoint >= 0) {
                    in.readerIndex(checkpoint);
                } else {
                    // Called by cleanup() - no need to maintain the readerIndex
                    // anymore because the buffer has been released already.
                }
                break;
            }

            if (oldReaderIndex == in.readerIndex() && oldState == state) {
                throw new DecoderException(
                       StringUtil.simpleClassName(getClass()) + ".decode() method must consume the inbound data " +
                       "or change its state if it decoded something.");
            }
            if (isSingleDecode()) {
                break;
            }
        }
    } catch (DecoderException e) {
        throw e;
    } catch (Exception cause) {
        throw new DecoderException(cause);
    }
}

实现不需要判断的逻辑就是因为

int oldReaderIndex = checkpoint = in.readerIndex(); 

如果在执行过程中出现异常就会在代码中重置 index

总结

虽然 ReplayingDecoder节约了判断的逻辑,但是从他的代码实现逻辑看到是通过抛出异常来不断的重试,所以在某些特殊的情况下会造成性能的下降。所以还是再选择的时候要根据自己的实际需求来判断是使用 ByteToMessage 还是使用 ReplayingDecoder

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • Java如何获取数组和字符串的长度(length还是length())

    Java如何获取数组和字符串的长度(length还是length())

    这篇文章主要介绍了Java如何获取数组和字符串的长度(length还是length()),文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-12-12
  • Spring MVC的web.xml配置详解

    Spring MVC的web.xml配置详解

    这篇文章主要介绍了Spring MVC的web.xml配置详解,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-06-06
  • java教程之java注解annotation使用方法

    java教程之java注解annotation使用方法

    这篇文章主要介绍了java注解annotation使用方法,注解可以定义到方法上,类上,一个注解相当与一个类,就相当于实例了一个对象,加上了注解,就相当于加了一个标志
    2014-01-01
  • Java 设计模式原则之迪米特法则详解

    Java 设计模式原则之迪米特法则详解

    这篇文章主要介绍了Java 设计模式原则之迪米特法则详解,本篇文章通过简要的案例,讲解了该项技术的了解与使用,以下就是详细内容,需要的朋友可以参考下
    2021-08-08
  • 通过JDK源码角度分析Long类详解

    通过JDK源码角度分析Long类详解

    这篇文章主要给大家介绍了关于通过JDK源码角度分析Long类的相关资料,文中通过示例代码介绍的非常详细,对大家学习或者使用long类具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧。
    2017-11-11
  • IDEA整合SSM框架实现网页上显示数据

    IDEA整合SSM框架实现网页上显示数据

    最近做了个小项目,该项目包在intellij idea中实现了ssm框架的整合以及实现访问,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-05-05
  • JAVA实现长连接(含心跳检测Demo)

    JAVA实现长连接(含心跳检测Demo)

    这篇文章主要介绍了JAVA实现长连接(含心跳检测Demo),文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-10-10
  • idea插件之如何使用JarEditor编辑Java JAR文件

    idea插件之如何使用JarEditor编辑Java JAR文件

    JarEditor是一款用于在IntelliJIDEA中直接编辑JAR文件的插件,支持反编译查看和编辑.class文件,并提供即时编译与保存功能,通过JarEditor,用户可以在IDE内一站式完成JAR文件的编辑、管理和打包操作,提高开发效率,但在生产环境中使用前,请确保备份并测试修改
    2025-01-01
  • eclipse配置javap命令的方法

    eclipse配置javap命令的方法

    本篇文章主要介绍了如何为eclipse配置javap命令,在配置过程中会出现的小问题的解决方法,非常实用,需要的朋友可以参考下
    2015-07-07
  • java方法实现简易ATM功能

    java方法实现简易ATM功能

    这篇文章主要为大家详细介绍了用java方法实现简易ATM功能,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-04-04

最新评论