HttpObjectAggregator (Netty API Reference (4.1.22.Final))

java.lang.Object
- io.netty.channel.ChannelHandlerAdapter
- - io.netty.channel.ChannelInboundHandlerAdapter
  - - io.netty.handler.codec.MessageToMessageDecoder<I>
    - - io.netty.handler.codec.MessageAggregator<HttpObject,HttpMessage,HttpContent,FullHttpMessage>
      - io.netty.handler.codec.http.HttpObjectAggregator

All Implemented Interfaces:

ChannelHandler ， ChannelInboundHandler

已知直接子类：

HttpClientUpgradeHandler ， HttpServerUpgradeHandler
```
public class HttpObjectAggregator
extends MessageAggregator<HttpObject,HttpMessage,HttpContent,FullHttpMessage>
```
A ChannelHandler ，其将HttpMessage及其后续的HttpContent汇总为单个FullHttpRequest或FullHttpResponse （取决于是否用于处理请求或响应）而没有以下HttpContent 。当您不想处理传输编码为“分块”的HTTP消息时，它非常有用。插入后，该处理器HttpResponseDecoder在ChannelPipeline如果被用来处理响应，或之后HttpRequestDecoder和HttpResponseEncoder在ChannelPipeline如果被用来处理请求。
```
  ChannelPipeline p = ...;
  ...
  p.addLast("decoder", new HttpRequestDecoder());
  p.addLast("encoder", new HttpResponseEncoder());
  p.addLast("aggregator", new HttpObjectAggregator(1048576));
  ...
  p.addLast("handler", new HttpRequestHandler());
  
```
为了方便起见，可以考虑把一个HttpServerCodec的前HttpObjectAggregator ，因为它的功能既是HttpRequestDecoder和HttpResponseEncoder 。
请注意， HttpObjectAggregator最终可能会发送HttpResponse ： Response Status Condition When Sent 100 Continue A '100-continue' expectation is received and the 'content-length' doesn't exceed maxContentLength 417 Expectation Failed A '100-continue' expectation is received and the 'content-length' exceeds maxContentLength 413 Request Entity Too Large Either the 'content-length' or the bytes received so far exceed maxContentLength
另请参见：

FullHttpRequest ， FullHttpResponse ， HttpResponseDecoder ， HttpServerCodec

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

构造方法摘要

构造方法
Constructor and Description
`HttpObjectAggregator(int maxContentLength)` 创建一个新的实例。
`HttpObjectAggregator(int maxContentLength, boolean closeOnExpectationFailed)` 创建一个新的实例。

方法摘要

所有方法接口方法具体的方法
Modifier and Type	Method and Description
`protected void`	`aggregate(FullHttpMessage aggregated, HttpContent content)` 将指定内容消息提供的信息传输到指定的聚合消息。
`protected FullHttpMessage`	`beginAggregation(HttpMessage start, ByteBuf content)` 根据指定的开始消息和指定的内容创建新的聚合消息。
`protected boolean`	`closeAfterContinueResponse(java.lang.Object msg)` 在写入 `MessageAggregator.newContinueResponse(Object, int, ChannelPipeline)`的结果后，确定通道是否应该关闭。
`protected void`	`finishAggregation(FullHttpMessage aggregated)` 当指定的 `aggregated`消息即将传递给管道中的下一个处理程序时调用。
`protected void`	`handleOversizedMessage(ChannelHandlerContext ctx, HttpMessage oversized)` 当传入请求超过最大内容长度时调用。
`protected boolean`	`ignoreContentAfterContinueResponse(java.lang.Object msg)` 确定当前请求/响应的所有对象是否应该被忽略。
`protected boolean`	`isAggregated(HttpObject msg)` 当且仅当指定的消息已经聚合时返回 `true` 。
`protected boolean`	`isContentLengthInvalid(HttpMessage start, int maxContentLength)` 确定消息 `start`的内容长度是否已知，并且是否大于 `maxContentLength` 。
`protected boolean`	`isContentMessage(HttpObject msg)` 当且仅当指定的消息是内容消息时返回 `true` 。
`protected boolean`	`isLastContentMessage(HttpContent msg)` 当且仅当指定的消息是最后一个内容消息时才返回 `true` 。
`protected boolean`	`isStartMessage(HttpObject msg)` 当且仅当指定的消息是开始消息时返回 `true` 。
`protected java.lang.Object`	`newContinueResponse(HttpMessage start, int maxContentLength, ChannelPipeline pipeline)` 如有必要，返回指定开始消息的'continue response'。

Methods inherited from class io.netty.handler.codec.MessageAggregator
acceptInboundMessage, channelInactive, channelReadComplete, ctx, decode, handlerAdded, handlerRemoved, isHandlingOversizedMessage, maxContentLength, maxCumulationBufferComponents, setMaxCumulationBufferComponents

Methods inherited from class io.netty.handler.codec.MessageToMessageDecoder
channelRead

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

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

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

- 构造方法详细信息
  - HttpObjectAggregator
```
public HttpObjectAggregator(int maxContentLength)
```
    创建一个新的实例。
    
    参数
    
    maxContentLength - 聚合内容的最大长度（以字节为单位）。如果聚集内容的长度超过此值，则将调用handleOversizedMessage(ChannelHandlerContext, HttpMessage) 。
  - HttpObjectAggregator
```
public HttpObjectAggregator(int maxContentLength,
                            boolean closeOnExpectationFailed)
```
    创建一个新的实例。
    
    参数
    
    maxContentLength - 聚合内容的最大长度（以字节为单位）。如果聚合内容的长度超过此值，则将调用handleOversizedMessage(ChannelHandlerContext, HttpMessage) 。
    
    closeOnExpectationFailed - 如果检测到100连续响应但内容长度过大，则true表示关闭连接。否则连接将保持打开状态，数据将被消耗并丢弃，直到收到下一个请求。
- 方法详细信息
  - isStartMessage
```
protected boolean isStartMessage(HttpObject msg)
                          throws java.lang.Exception
```
    从类复制的描述： MessageAggregator
    当且仅当指定的消息是开始消息时返回true 。通常，这种方法是作为一个return声明与instanceof ：
```
  return msg instanceof MyStartMessage; 
```
    Specified by:
    
    isStartMessage在课堂上 MessageAggregator<HttpObject,HttpMessage,HttpContent,FullHttpMessage>
    
    异常
    
    java.lang.Exception
  - isContentMessage
```
protected boolean isContentMessage(HttpObject msg)
                            throws java.lang.Exception
```
    从类复制的描述： MessageAggregator
    当且仅当指定的消息是内容消息时返回true 。通常，这种方法是作为一个return声明与instanceof ：
```
  return msg instanceof MyContentMessage; 
```
    Specified by:
    
    isContentMessage类 MessageAggregator<HttpObject,HttpMessage,HttpContent,FullHttpMessage>
    
    异常
    
    java.lang.Exception
  - isLastContentMessage
```
protected boolean isLastContentMessage(HttpContent msg)
                                throws java.lang.Exception
```
    从类复制的描述： MessageAggregator
    当且仅当指定的消息是最后一个内容消息时返回true 。通常，此方法是作为一个return声明与instanceof ：
```
  return msg instanceof MyLastContentMessage; 
```
    或者用instanceof和布尔字段检查：
```
  return msg instanceof MyContentMessage && msg.isLastFragment(); 
```
    Specified by:
    
    isLastContentMessage在课堂上 MessageAggregator<HttpObject,HttpMessage,HttpContent,FullHttpMessage>
    
    异常
    
    java.lang.Exception
  - isAggregated
```
protected boolean isAggregated(HttpObject msg)
                        throws java.lang.Exception
```
    从类复制的描述： MessageAggregator
    
    当且仅当指定的消息已经聚合时才返回true 。如果此方法返回true ，则此处理程序将仅将消息按true转发给下一个处理程序。
    
    Specified by:
    
    isAggregated在类 MessageAggregator<HttpObject,HttpMessage,HttpContent,FullHttpMessage>
    
    异常
    
    java.lang.Exception
  - isContentLengthInvalid
```
protected boolean isContentLengthInvalid(HttpMessage start,
                                         int maxContentLength)
```
    从类复制的描述： MessageAggregator
    
    确定消息 start的内容长度是否已知，并且是否大于 maxContentLength 。
    
    Specified by:
    
    isContentLengthInvalid在课堂上 MessageAggregator<HttpObject,HttpMessage,HttpContent,FullHttpMessage>
    
    参数
    
    start - 可能指示内容长度的消息。
    
    maxContentLength - 允许的最大内容长度。
    
    结果
    
    true如果消息start的内容长度已知，并且它大于maxContentLength 。 false否则。
  - newContinueResponse
```
protected java.lang.Object newContinueResponse(HttpMessage start,
                                               int maxContentLength,
                                               ChannelPipeline pipeline)
```
    从类复制的描述： MessageAggregator
    
    如有必要，返回指定开始消息的'continue response'。例如，这个方法对于处理一个HTTP 100-continue头是很有用的。
    
    Specified by:
    
    newContinueResponse在课程 MessageAggregator<HttpObject,HttpMessage,HttpContent,FullHttpMessage>
    
    结果
    
    '继续回复'，或者 null如果没有消息要发送
  - closeAfterContinueResponse
```
protected boolean closeAfterContinueResponse(java.lang.Object msg)
```
    从类复制的描述： MessageAggregator
    
    在写入 MessageAggregator.newContinueResponse(Object, int, ChannelPipeline)的结果之后，确定通道是否应该关闭。
    
    Specified by:
    
    closeAfterContinueResponse在课堂上 MessageAggregator<HttpObject,HttpMessage,HttpContent,FullHttpMessage>
    
    参数
    
    msg -从返回值 MessageAggregator.newContinueResponse(Object, int, ChannelPipeline) 。
    
    结果
    
    true如果在写入MessageAggregator.newContinueResponse(Object, int, ChannelPipeline)的结果后关闭通道。 false否则。
  - ignoreContentAfterContinueResponse
```
protected boolean ignoreContentAfterContinueResponse(java.lang.Object msg)
```
    从类复制的描述： MessageAggregator
    
    确定当前请求/响应的所有对象是否应该被忽略。下次MessageAggregator.isContentMessage(Object)返回true时，消息将不再被忽略。
    
    Specified by:
    
    ignoreContentAfterContinueResponse在课堂上 MessageAggregator<HttpObject,HttpMessage,HttpContent,FullHttpMessage>
    
    参数
    
    msg -从返回值 MessageAggregator.newContinueResponse(Object, int, ChannelPipeline) 。
    
    结果
    
    true如果当前请求/响应的所有对象都应该被忽略。 false否则。
  - beginAggregation
```
protected FullHttpMessage beginAggregation(HttpMessage start,
                                           ByteBuf content)
                                    throws java.lang.Exception
```
    从类复制的描述： MessageAggregator
    
    根据指定的开始消息和指定的内容创建新的聚合消息。如果启动消息实现ByteBufHolder ，则其内容将附加到指定的content 。此聚合器将继续将收到的内容追加到指定的content 。
    
    Specified by:
    
    beginAggregation在类 MessageAggregator<HttpObject,HttpMessage,HttpContent,FullHttpMessage>
    
    异常
    
    java.lang.Exception
  - aggregate
```
protected void aggregate(FullHttpMessage aggregated,
                         HttpContent content)
                  throws java.lang.Exception
```
    从类复制的描述： MessageAggregator
    
    将指定内容消息提供的信息传输到指定的聚合消息。请注意，指定内容消息的内容已被添加到指定聚合消息的内容中，因此您不需要。使用此方法将内容消息提供的附加信息传输到aggregated 。
    
    重写：
    
    aggregate在课程 MessageAggregator<HttpObject,HttpMessage,HttpContent,FullHttpMessage>
    
    异常
    
    java.lang.Exception
  - finishAggregation
```
protected void finishAggregation(FullHttpMessage aggregated)
                          throws java.lang.Exception
```
    从类复制的描述： MessageAggregator
    
    当指定的 aggregated消息即将传递给管道中的下一个处理程序时调用。
    
    重写：
    
    finishAggregation在类 MessageAggregator<HttpObject,HttpMessage,HttpContent,FullHttpMessage>
    
    异常
    
    java.lang.Exception
  - handleOversizedMessage
```
protected void handleOversizedMessage(ChannelHandlerContext ctx,
                                      HttpMessage oversized)
                               throws java.lang.Exception
```
    从类复制的描述： MessageAggregator
    
    当传入请求超过最大内容长度时调用。默认behvaior是触发exceptionCaught()事件与TooLongFrameException 。
    
    重写：
    
    handleOversizedMessage ，等级 MessageAggregator<HttpObject,HttpMessage,HttpContent,FullHttpMessage>
    
    参数
    
    ctx - ChannelHandlerContext
    
    oversized - oversized积累的信息，其类型为 S或 O
    
    异常
    
    java.lang.Exception

Class HttpObjectAggregator

Nested Class Summary

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

构造方法摘要

方法摘要

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

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

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

Methods inherited from class java.lang.Object

构造方法详细信息

HttpObjectAggregator

HttpObjectAggregator

方法详细信息

isStartMessage

isContentMessage

isLastContentMessage

isAggregated

isContentLengthInvalid

newContinueResponse

closeAfterContinueResponse

ignoreContentAfterContinueResponse

beginAggregation

aggregate

finishAggregation

handleOversizedMessage