HttpObjectDecoder (Netty API Reference (4.1.22.Final))

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

All Implemented Interfaces:

ChannelHandler ， ChannelInboundHandler

已知直接子类：

HttpRequestDecoder ， HttpResponseDecoder ， RtspDecoder ， RtspObjectDecoder
```
public abstract class HttpObjectDecoder
extends ByteToMessageDecoder
```
将ByteBuf s解码为HttpMessage s和HttpContent s。
防止内存消耗过多的参数
Name Meaning maxInitialLineLength The maximum length of the initial line (e.g. "GET / HTTP/1.0" or "HTTP/1.0 200 OK") If the length of the initial line exceeds this value, a TooLongFrameException will be raised. maxHeaderSize The maximum length of all headers. If the sum of the length of each header exceeds this value, a TooLongFrameException will be raised. maxChunkSize The maximum length of the content or each chunk. If the content length (or the length of each chunk) exceeds this value, the content or chunk will be split into multiple HttpContents whose length is maxChunkSize at maximum.

分块内容
如果HTTP消息的内容大于maxChunkSize或者HTTP消息的传输编码是“分块”，则该解码器将为每个HTTP消息生成一个HttpMessage实例及其后续HttpContent个实例，以避免过多的内存消耗。例如，下面的HTTP消息：
```
  GET / HTTP/1.1
 Transfer-Encoding: chunked

 1a
 abcdefghijklmnopqrstuvwxyz
 10
 1234567890abcdef
 0
 Content-MD5: ...
 [blank line] 
```
触发HttpRequestDecoder以生成3个对象：
1. 一种HttpRequest ，
2. 第一个HttpContent，其内容是'abcdefghijklmnopqrstuvwxyz' ，
3. 第二个LastHttpContent，其内容是'1234567890abcdef' ，标志着内容的结束。
如果您不想为了方便您自己处理HttpContent ，请在ChannelPipeline的此解码器后插入HttpObjectAggregator 。但是，请注意，您的服务器可能没有聚合器的内存效率。
可扩展性
请注意，此解码器旨在进行扩展以实现源自HTTP的协议，如RTSP和ICAP 。为了实现这种衍生协议的解码器，扩展这个类并适当地实现所有的抽象方法。

Nested Class Summary
- Nested classes/interfaces inherited from class io.netty.handler.codec.ByteToMessageDecoder
  ByteToMessageDecoder.Cumulator
- Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler
  ChannelHandler.Sharable

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`validateHeaders`

Fields inherited from class io.netty.handler.codec.ByteToMessageDecoder
COMPOSITE_CUMULATOR, MERGE_CUMULATOR

构造方法摘要

构造方法
Modifier	Constructor and Description
`protected`	`HttpObjectDecoder()` 使用默认值 `maxInitialLineLength (4096` }， `maxHeaderSize (8192)`和 `maxChunkSize (8192)`创建一个新实例。
`protected`	`HttpObjectDecoder(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean chunkedSupported)` 用指定的参数创建一个新的实例。
`protected`	`HttpObjectDecoder(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean chunkedSupported, boolean validateHeaders)` 用指定的参数创建一个新的实例。
`protected`	`HttpObjectDecoder(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean chunkedSupported, boolean validateHeaders, int initialBufferSize)`

方法摘要

所有方法接口方法抽象方法具体的方法
Modifier and Type	Method and Description
`protected abstract HttpMessage`	`createInvalidMessage()`
`protected abstract HttpMessage`	`createMessage(java.lang.String[] initialLine)`
`protected void`	`decode(ChannelHandlerContext ctx, ByteBuf buffer, java.util.List<java.lang.Object> out)` 解码从一个`ByteBuf`到另一个。
`protected void`	`decodeLast(ChannelHandlerContext ctx, ByteBuf in, java.util.List<java.lang.Object> out)` 最后一次被称为`ChannelHandlerContext`无效时。
`protected boolean`	`isContentAlwaysEmpty(HttpMessage msg)`
`protected abstract boolean`	`isDecodingRequest()`
`protected boolean`	`isSwitchingToNonHttp1Protocol(HttpResponse msg)` 如果服务器切换到不同于HTTP / 1.0或HTTP / 1.1的协议，则返回true，例如
`void`	`reset()` 重置解码器的状态，以便它可以解码新消息。
`void`	`userEventTriggered(ChannelHandlerContext ctx, java.lang.Object evt)` 致电`ChannelHandlerContext.fireUserEventTriggered(Object)`转发到`ChannelPipeline`中的下一个`ChannelInboundHandler` 。

Methods inherited from class io.netty.handler.codec.ByteToMessageDecoder
actualReadableBytes, callDecode, channelInactive, channelRead, channelReadComplete, discardSomeReadBytes, handlerRemoved, handlerRemoved0, internalBuffer, isSingleDecode, setCumulator, setDiscardAfterReads, setSingleDecode

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

- 字段详细信息
  - validateHeaders
```
protected final boolean validateHeaders
```
- 构造方法详细信息
  - HttpObjectDecoder
```
protected HttpObjectDecoder()
```
    使用默认值 maxInitialLineLength (4096 }， maxHeaderSize (8192)和 maxChunkSize (8192)创建一个新实例。
  - HttpObjectDecoder
```
protected HttpObjectDecoder(int maxInitialLineLength,
                            int maxHeaderSize,
                            int maxChunkSize,
                            boolean chunkedSupported)
```
    用指定的参数创建一个新的实例。
  - HttpObjectDecoder
```
protected HttpObjectDecoder(int maxInitialLineLength,
                            int maxHeaderSize,
                            int maxChunkSize,
                            boolean chunkedSupported,
                            boolean validateHeaders)
```
    用指定的参数创建一个新的实例。
  - HttpObjectDecoder
```
protected HttpObjectDecoder(int maxInitialLineLength,
                            int maxHeaderSize,
                            int maxChunkSize,
                            boolean chunkedSupported,
                            boolean validateHeaders,
                            int initialBufferSize)
```
- 方法详细信息
  - decode
```
protected void decode(ChannelHandlerContext ctx,
                      ByteBuf buffer,
                      java.util.List<java.lang.Object> out)
               throws java.lang.Exception
```
    从类复制的描述： ByteToMessageDecoder
    
    解码从一个ByteBuf到另一个。该方法将被调用，直到输入ByteBuf在从此方法返回时没有任何可读的内容或直到从输入ByteBuf中没有读取任何内容。
    
    Specified by:
    
    decode在课程 ByteToMessageDecoder
    
    参数
    
    ctx - 这ByteToMessageDecoder所属的ChannelHandlerContext
    
    buffer - 从中读取数据的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
```
    从类复制的描述： ByteToMessageDecoder
    
    当ChannelHandlerContext处于非活动状态时称为最后一次。这意味着ByteToMessageDecoder.channelInactive(ChannelHandlerContext)被触发。默认情况下，这只会调用ByteToMessageDecoder.decode(ChannelHandlerContext, ByteBuf, List)，但子类可能会覆盖这个对于一些特殊的清理操作。
    
    重写：
    
    decodeLast在课堂上 ByteToMessageDecoder
    
    异常
    
    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在课堂上 ByteToMessageDecoder
    
    异常
    
    java.lang.Exception
  - isContentAlwaysEmpty
```
protected boolean isContentAlwaysEmpty(HttpMessage msg)
```
  - isSwitchingToNonHttp1Protocol
```
protected boolean isSwitchingToNonHttp1Protocol(HttpResponse msg)
```
    如果服务器切换到与HTTP / 1.0或HTTP / 1.1不同的协议（例如HTTP / 2或Websocket），则返回true。如果升级发生在不同的层中，则返回false，例如，通过TLS从HTTP / 1.1升级到HTTP / 1.1。
  - reset
```
public void reset()
```
    重置解码器的状态，以便它可以解码新消息。此方法对于使用Expect: 100-continue标头处理拒绝的请求很有用。
  - isDecodingRequest
```
protected abstract boolean isDecodingRequest()
```
  - createMessage
```
protected abstract HttpMessage createMessage(java.lang.String[] initialLine)
                                      throws java.lang.Exception
```
    异常
    
    java.lang.Exception
  - createInvalidMessage
```
protected abstract HttpMessage createInvalidMessage()
```

Class HttpObjectDecoder

防止内存消耗过多的参数

分块内容

可扩展性

Nested Class Summary

Nested classes/interfaces inherited from class io.netty.handler.codec.ByteToMessageDecoder

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

Field Summary

Fields inherited from class io.netty.handler.codec.ByteToMessageDecoder

构造方法摘要

方法摘要

Methods inherited from class io.netty.handler.codec.ByteToMessageDecoder

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

字段详细信息

validateHeaders

构造方法详细信息

HttpObjectDecoder

HttpObjectDecoder

HttpObjectDecoder

HttpObjectDecoder

方法详细信息

decode

decodeLast

userEventTriggered

isContentAlwaysEmpty

isSwitchingToNonHttp1Protocol

reset

isDecodingRequest

createMessage

createInvalidMessage