ByteToMessageDecoder (Netty API Reference (4.1.22.Final))

java.lang.Object
- io.netty.channel.ChannelHandlerAdapter
- - io.netty.channel.ChannelInboundHandlerAdapter
  - - io.netty.handler.codec.ByteToMessageDecoder

All Implemented Interfaces:

ChannelHandler ， ChannelInboundHandler

已知直接子类：

AbstractMemcacheObjectDecoder ， AbstractSniHandler ， Bzip2Decoder ， DelimiterBasedFrameDecoder ， FastLzFrameDecoder ， FixedLengthFrameDecoder ， HAProxyMessageDecoder ， Http2ConnectionHandler ， HttpObjectDecoder ， JsonObjectDecoder ， LengthFieldBasedFrameDecoder ， LineBasedFrameDecoder ， Lz4FrameDecoder ， LzfDecoder ， OptionalSslHandler ， ProtobufVarint32FrameDecoder ， RedisDecoder ， ReplayingDecoder ， SnappyFrameDecoder ， SocksPortUnificationServerHandler ， SpdyFrameCodec ， SslHandler ， WebSocket08FrameDecoder ， XmlDecoder ， XmlFrameDecoder ， ZlibDecoder
```
public abstract class ByteToMessageDecoder
extends ChannelInboundHandlerAdapter
```
ChannelInboundHandlerAdapter ，它以类似流的方式将字节从一个ByteBuf解码为另一个消息类型。例如，这里是一个实现，它从输入ByteBuf中读取所有可读的字节并创建一个新的ByteBuf 。
```
  public class SquareDecoder extends ByteToMessageDecoder {
          @Override
         public void decode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out)
                 throws 异常 {
             out.add(in.readBytes(in.readableBytes()));
         }
     } 
```
帧检测

一般帧检测应通过加入先前在管道处理DelimiterBasedFrameDecoder ， FixedLengthFrameDecoder ， LengthFieldBasedFrameDecoder ，或LineBasedFrameDecoder 。

如果需要自定义帧解码器，那么在用ByteToMessageDecoder实现一个时需要小心。通过检查ByteBuf.readableBytes()，确保缓冲区中有足够的字节用于完整帧。如果完整帧没有足够的字节，则返回而不修改阅读器索引以允许更多字节到达。

要在不修改阅读器索引的情况下检查完整帧，请使用ByteBuf.getInt(int)之类的方法。当使用ByteBuf.getInt(int)等方法时，必须使用阅读器索引。例如，调用in.getInt(0)假定帧在缓冲区的开始处开始，但情况并非总是如此。改为使用in.getInt(in.readerIndex()) 。

陷阱

请注意， ByteToMessageDecoder的子类不能用@Sharable注释。

如果返回的缓冲区未释放或添加到out List某些方法（如ByteBuf.readBytes(int)）将导致内存泄漏。使用衍生缓冲区，如ByteBuf.readSlice(int)以避免内存泄漏。

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ByteToMessageDecoder.Cumulator` 累积`ByteBuf` s。

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler
ChannelHandler.Sharable

Field Summary

Fields
Modifier and Type	Field and Description
`static ByteToMessageDecoder.Cumulator`	`COMPOSITE_CUMULATOR` 通过将它们添加到`CompositeByteBuf`来累积`ByteBuf` ，所以尽可能不要复制存储器。
`static ByteToMessageDecoder.Cumulator`	`MERGE_CUMULATOR` 累积`ByteBuf` s通过合并成一个`ByteBuf` s，使用内存拷贝。

构造方法摘要

构造方法
Modifier	Constructor and Description
`protected`	`ByteToMessageDecoder()`

方法摘要

所有方法接口方法抽象方法具体的方法
Modifier and Type	Method and Description
`protected int`	`actualReadableBytes()` 返回此解码器的内部累积缓冲区中的可读字节的实际数量。
`protected void`	`callDecode(ChannelHandlerContext ctx, ByteBuf in, java.util.List<java.lang.Object> out)` 一旦数据应该从给定的`ByteBuf`解码，则调用。
`void`	`channelInactive(ChannelHandlerContext ctx)` 致电`ChannelHandlerContext.fireChannelInactive()`转发至`ChannelPipeline`中的下一个`ChannelInboundHandler` 。
`void`	`channelRead(ChannelHandlerContext ctx, java.lang.Object msg)` 致电`ChannelHandlerContext.fireChannelRead(Object)`转发到`ChannelPipeline`中的下一个`ChannelInboundHandler` 。
`void`	`channelReadComplete(ChannelHandlerContext ctx)` 致电`ChannelHandlerContext.fireChannelReadComplete()`转发至`ChannelPipeline`中的下一个`ChannelInboundHandler` 。
`protected abstract void`	`decode(ChannelHandlerContext ctx, ByteBuf in, java.util.List<java.lang.Object> out)` 解码从一个`ByteBuf`到另一个。
`protected void`	`decodeLast(ChannelHandlerContext ctx, ByteBuf in, java.util.List<java.lang.Object> out)` 当`ChannelHandlerContext`处于非活动状态时称为最后一次。
`protected void`	`discardSomeReadBytes()`
`void`	`handlerRemoved(ChannelHandlerContext ctx)` 子类可以忽略这个方法。
`protected void`	`handlerRemoved0(ChannelHandlerContext ctx)` 在`ByteToMessageDecoder`从实际上下文中移除之后调用，它不再处理事件。
`protected ByteBuf`	`internalBuffer()` 返回此解码器的内部累积缓冲区。
`boolean`	`isSingleDecode()` 如果 `true`则每个 `channelRead(ChannelHandlerContext, Object)`呼叫仅解码一条消息。
`void`	`setCumulator(ByteToMessageDecoder.Cumulator cumulator)` 设置`ByteToMessageDecoder.Cumulator`用于累计收到的`ByteBuf` 。
`void`	`setDiscardAfterReads(int discardAfterReads)` 设置 `ByteBuf.discardSomeReadBytes()`之后的读取次数，释放内存。
`void`	`setSingleDecode(boolean singleDecode)` 如果设置，则每个 `channelRead(ChannelHandlerContext, Object)`呼叫仅解码一条消息。
`void`	`userEventTriggered(ChannelHandlerContext ctx, java.lang.Object evt)` 致电`ChannelHandlerContext.fireUserEventTriggered(Object)`转发到`ChannelPipeline`中的下一个`ChannelInboundHandler` 。

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter
channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught

Methods inherited from class io.netty.channel.ChannelHandlerAdapter
ensureNotSharable, handlerAdded, isSharable

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.netty.channel.ChannelHandler
handlerAdded

- 字段详细信息
  - MERGE_CUMULATOR
```
public static final ByteToMessageDecoder.Cumulator MERGE_CUMULATOR
```
    累积ByteBuf s合并成一个ByteBuf s，使用内存拷贝。
  - COMPOSITE_CUMULATOR
```
public static final ByteToMessageDecoder.Cumulator COMPOSITE_CUMULATOR
```
    通过将它们添加到CompositeByteBuf来累积ByteBuf s，所以尽可能不要复制存储器。请注意， CompositeByteBuf使用更复杂的索引实现，因此取决于您的使用情况和解码器实现，这可能会比使用MERGE_CUMULATOR更慢。
- 构造方法详细信息
  - ByteToMessageDecoder
```
protected ByteToMessageDecoder()
```
- 方法详细信息
  - setSingleDecode
```
public void setSingleDecode(boolean singleDecode)
```
    如果设置，则每个channelRead(ChannelHandlerContext, Object)呼叫仅解码一条消息。如果你需要做一些协议升级，并且要确保没有任何混淆，这可能很有用。默认值为false因为这会影响性能。
  - isSingleDecode
```
public boolean isSingleDecode()
```
    如果true则每个channelRead(ChannelHandlerContext, Object)呼叫仅解码一条消息。默认值为false因为这会影响性能。
  - setCumulator
```
public void setCumulator(ByteToMessageDecoder.Cumulator cumulator)
```
    设置ByteToMessageDecoder.Cumulator用于累计收到的ByteBuf 。
  - setDiscardAfterReads
```
public void setDiscardAfterReads(int discardAfterReads)
```
    设置ByteBuf.discardSomeReadBytes()之后的读取次数，从而释放内存。默认值是16 。
  - actualReadableBytes
```
protected int actualReadableBytes()
```
    返回此解码器的内部累积缓冲区中的可读字节的实际数量。您通常不需要依赖此值来编写解码器。只有在您必须自担风险使用它时才使用它。此方法是internalBuffer().readableBytes()的快捷方式。
  - internalBuffer
```
protected ByteBuf internalBuffer()
```
    返回此解码器的内部累积缓冲区。您通常不需要直接访问内部缓冲区来编写解码器。只有在您必须自担风险使用它时才使用它。
  - handlerRemoved
```
public final void handlerRemoved(ChannelHandlerContext ctx)
                          throws java.lang.Exception
```
    从类复制的描述： ChannelHandlerAdapter
    
    子类可以忽略这个方法。
    
    Specified by:
    
    handlerRemoved ，界面 ChannelHandler
    
    重写：
    
    handlerRemoved在课程 ChannelHandlerAdapter
    
    异常
    
    java.lang.Exception
  - handlerRemoved0
```
protected void handlerRemoved0(ChannelHandlerContext ctx)
                        throws java.lang.Exception
```
    在ByteToMessageDecoder已从实际上下文中移除并且不再处理事件之后调用。
    
    异常
    
    java.lang.Exception
  - channelRead
```
public void channelRead(ChannelHandlerContext ctx,
                        java.lang.Object msg)
                 throws java.lang.Exception
```
    从类复制的描述： ChannelInboundHandlerAdapter
    
    致电ChannelHandlerContext.fireChannelRead(Object)转发到ChannelPipeline中的下一个ChannelInboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    channelRead在界面 ChannelInboundHandler
    
    重写：
    
    channelRead在课程 ChannelInboundHandlerAdapter
    
    异常
    
    java.lang.Exception
  - channelReadComplete
```
public void channelReadComplete(ChannelHandlerContext ctx)
                         throws java.lang.Exception
```
    从类复制的描述： ChannelInboundHandlerAdapter
    
    致电ChannelHandlerContext.fireChannelReadComplete()转发到ChannelPipeline中的下一个ChannelInboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    channelReadComplete在界面 ChannelInboundHandler
    
    重写：
    
    channelReadComplete在班级 ChannelInboundHandlerAdapter
    
    异常
    
    java.lang.Exception
  - discardSomeReadBytes
```
protected final void discardSomeReadBytes()
```
  - channelInactive
```
public void channelInactive(ChannelHandlerContext ctx)
                     throws java.lang.Exception
```
    从类复制的描述： ChannelInboundHandlerAdapter
    
    致电ChannelHandlerContext.fireChannelInactive()转发至ChannelPipeline中的下一个ChannelInboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    channelInactive在界面 ChannelInboundHandler
    
    重写：
    
    channelInactive在课堂上 ChannelInboundHandlerAdapter
    
    异常
    
    java.lang.Exception
  - userEventTriggered
```
public void userEventTriggered(ChannelHandlerContext ctx,
                               java.lang.Object evt)
                        throws java.lang.Exception
```
    从类复制的描述： ChannelInboundHandlerAdapter
    
    致电ChannelHandlerContext.fireUserEventTriggered(Object)转发到ChannelPipeline中的下一个ChannelInboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    userEventTriggered ，界面 ChannelInboundHandler
    
    重写：
    
    userEventTriggered在课程 ChannelInboundHandlerAdapter
    
    异常
    
    java.lang.Exception
  - callDecode
```
protected void callDecode(ChannelHandlerContext ctx,
                          ByteBuf in,
                          java.util.List<java.lang.Object> out)
```
    调用一次数据应该从给定的ByteBuf解码。只要解码应该发生，该方法将调用decode(ChannelHandlerContext, ByteBuf, List) 。
    
    参数
    
    ctx - ByteToMessageDecoder所属的ChannelHandlerContext
    
    in - 从中读取数据的ByteBuf
    
    out - 应该添加解码消息的 List
  - decode
```
protected abstract void decode(ChannelHandlerContext ctx,
                               ByteBuf in,
                               java.util.List<java.lang.Object> out)
                        throws java.lang.Exception
```
    解码从一个ByteBuf到另一个。该方法将被调用，直到输入ByteBuf在从此方法返回时没有任何可读的内容或直到从输入ByteBuf没有读到任何内容。
    
    参数
    
    ctx - ByteToMessageDecoder属于的ChannelHandlerContext
    
    in - 从中读取数据的ByteBuf
    
    out - 应该添加解码消息的 List
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - decodeLast
```
protected void decodeLast(ChannelHandlerContext ctx,
                          ByteBuf in,
                          java.util.List<java.lang.Object> out)
                   throws java.lang.Exception
```
    当ChannelHandlerContext处于非活动状态时称为最后一次。这意味着channelInactive(ChannelHandlerContext)被触发。默认情况下，这只会调用decode(ChannelHandlerContext, ByteBuf, List)，但子类可能会覆盖这个对于一些特殊的清理操作。
    
    异常
    
    java.lang.Exception

Class ByteToMessageDecoder

帧检测

陷阱

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

Field Summary

构造方法摘要

方法摘要

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

Methods inherited from class java.lang.Object

Methods inherited from interface io.netty.channel.ChannelHandler

字段详细信息

MERGE_CUMULATOR

COMPOSITE_CUMULATOR

构造方法详细信息

ByteToMessageDecoder

方法详细信息

setSingleDecode

isSingleDecode

setCumulator

setDiscardAfterReads

actualReadableBytes

internalBuffer

handlerRemoved

handlerRemoved0

channelRead

channelReadComplete

discardSomeReadBytes

channelInactive

userEventTriggered

callDecode

decode

decodeLast