HttpPostRequestDecoder (Netty API Reference (4.1.22.Final))

java.lang.Object
- io.netty.handler.codec.http.multipart.HttpPostRequestDecoder

All Implemented Interfaces:

InterfaceHttpPostRequestDecoder
```
public class HttpPostRequestDecoder
extends java.lang.Object
implements InterfaceHttpPostRequestDecoder
```
该解码器将解码Body并可以处理POST BODY。完成后您必须致电destroy()以释放所有资源。

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`HttpPostRequestDecoder.EndOfDataDecoderException` 即使仍然有数据，身体完全解码也是例外
`static class`	`HttpPostRequestDecoder.ErrorDataDecoderException` 解码时发生错误时异常
`protected static class`	`HttpPostRequestDecoder.MultiPartStatus` 状态遵循NOTSTARTED PREAMBLE（（HEADERDELIMITER配置（字段\| FILEUPLOAD））（HEADERDELIMITER配置混合可执行文件（MIXEDDELIMITER MIXEDDISPOSITION MIXEDFILEUPLOAD）+ MIXEDCLOSEDELIMITER） CLOSEDELIMITER）+ EPILOGUE首先getStatus为：NOSTARTED内容类型：multipart / form-data，boundary = AaB03x =>标题中的PREAMBLE --AaB03x => HEADERDELIMITER content-disposition：form-data; name =“field1”=>配置Joe Blow => FIELD --AaB03x => HEADERDELIMITER content-disposition：form-data; name =“pics”=>处置内容类型：multipart / mixed，边界= BbC04y --BbC04y => MIXEDDELIMITER内容处置：附件; filename =“file1.txt”=> MIXEDDISPOSITION Content-Type：文本/纯文本... file1.txt的内容... => MIXEDFILEUPLOAD --BbC04y => MIXEDDELIMITER内容处置：文件; filename =“file2.gif”=> MIXEDDISPOSITION Content-type：image / gif Content-Transfer-Encoding：binary ... file2.gif的内容... => MIXEDFILEUPLOAD --BbC04y-- => MIXEDCLOSEDELIMITER --AaB03x- - => CLOSEDELIMITER一旦找到CLOSEDELIMITER，最后的getStatus就是EPILOGUE
`static class`	`HttpPostRequestDecoder.NotEnoughDataDecoderException` 尝试以分块格式从请求中读取数据时出现异常，并且没有足够的数据可用（需要更多块）

构造方法摘要

构造方法
Constructor and Description
`HttpPostRequestDecoder(HttpDataFactory factory, HttpRequest request)`
`HttpPostRequestDecoder(HttpDataFactory factory, HttpRequest request, java.nio.charset.Charset charset)`
`HttpPostRequestDecoder(HttpRequest request)`

方法摘要

所有方法静态方法接口方法具体的方法
Modifier and Type	Method and Description
`void`	`cleanFiles()` 清理当前请求的所有HttpDatas（在磁盘上）。
`InterfaceHttpData`	`currentPartialHttpData()` 如果当前处于解码状态（表示所有数据尚未处于内），则返回当前的InterfaceHttpData;如果当前没有处于解码状态的InterfaceHttpData（因为尚未解码或当前未解码），则返回null。
`void`	`destroy()` 销毁`InterfaceHttpPostRequestDecoder`并释放它的所有资源。
`InterfaceHttpData`	`getBodyHttpData(java.lang.String name)` 这个getMethod从body返回具有给定名称的第一个InterfaceHttpData。
`java.util.List<InterfaceHttpData>`	`getBodyHttpDatas()` 这个getMethod从body返回一个所有HttpDatas的列表。
`java.util.List<InterfaceHttpData>`	`getBodyHttpDatas(java.lang.String name)` 这个getMethod返回一个所有HttpDatas的列表，其中包含正文中给定的名字。
`int`	`getDiscardThreshold()` 以字节为单位返回阈值，之后应丢弃缓冲区中的读取数据。
`protected static java.lang.String[]`	`getMultipartDataBoundary(java.lang.String contentType)` 如果此请求是多部分请求，请检查ContentType请求。
`boolean`	`hasNext()` 如果在当前的getStatus中，则为真，则存在来自Body的可用解码的InterfaceHttpData。
`boolean`	`isMultipart()` 如果此请求是多部分请求，则为真
`static boolean`	`isMultipart(HttpRequest request)` 检查给定的请求是否是多部分请求
`InterfaceHttpData`	`next()` 返回下一个可用的InterfaceHttpData;如果在调用时没有可用的InterfaceHttpData，则返回null。
`InterfaceHttpPostRequestDecoder`	`offer(HttpContent content)` 从新块初始化内部
`void`	`removeHttpDataFromClean(InterfaceHttpData data)` 从FileUploads列表中删除给定的FileUpload以进行清理
`void`	`setDiscardThreshold(int discardThreshold)` 设置缓冲区中的读取字节应该丢弃的字节数量。

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

- 构造方法详细信息
  - HttpPostRequestDecoder
```
public HttpPostRequestDecoder(HttpRequest request)
```
    参数
    
    request - 解码请求
    
    异常
    
    java.lang.NullPointerException - 请求
    
    HttpPostRequestDecoder.ErrorDataDecoderException - 如果解码或其他错误时默认字符集错误
  - HttpPostRequestDecoder
```
public HttpPostRequestDecoder(HttpDataFactory factory,
                              HttpRequest request)
```
    参数
    
    factory - 用于创建InterfaceHttpData的工厂
    
    request - 解码请求
    
    异常
    
    java.lang.NullPointerException - 请求或工厂
    
    HttpPostRequestDecoder.ErrorDataDecoderException - 如果解码或其他错误时默认字符集错误
  - HttpPostRequestDecoder
```
public HttpPostRequestDecoder(HttpDataFactory factory,
                              HttpRequest request,
                              java.nio.charset.Charset charset)
```
    参数
    
    factory - 用于创建InterfaceHttpData的工厂
    
    request - 解码请求
    
    charset - 默认使用的字符集
    
    异常
    
    java.lang.NullPointerException - 用于请求或字符集或工厂
    
    HttpPostRequestDecoder.ErrorDataDecoderException - 如果解码或其他错误时默认字符集错误
- 方法详细信息
  - isMultipart
```
public static boolean isMultipart(HttpRequest request)
```
    检查给定的请求是否是多部分请求
    
    结果
    
    如果请求是多部分请求，则为真
  - getMultipartDataBoundary
```
protected static java.lang.String[] getMultipartDataBoundary(java.lang.String contentType)
```
    如果此请求是多部分请求，请检查ContentType请求。
    
    结果
    
    一个字符串数组，如果multipartDataBoundary以multipartDataBoundary作为第一个元素存在，则字符集（如果有的话）作为第二个（如果未设置则丢失），否则返回null
  - isMultipart
```
public boolean isMultipart()
```
    从接口复制的描述： InterfaceHttpPostRequestDecoder
    
    如果此请求是多部分请求，则为真
    
    Specified by:
    
    isMultipart在界面 InterfaceHttpPostRequestDecoder
    
    结果
    
    如果此请求是多部分请求，则为真
  - setDiscardThreshold
```
public void setDiscardThreshold(int discardThreshold)
```
    从接口复制的描述： InterfaceHttpPostRequestDecoder
    
    设置缓冲区中的读取字节应该丢弃的字节数量。设置这个较低值会降低内存使用量，但会增加更多内存副本的开销。使用0来禁用它。
    
    Specified by:
    
    setDiscardThreshold在界面 InterfaceHttpPostRequestDecoder
  - getDiscardThreshold
```
public int getDiscardThreshold()
```
    从界面复制的描述： InterfaceHttpPostRequestDecoder
    
    以字节为单位返回阈值，之后应丢弃缓冲区中的读取数据。
    
    Specified by:
    
    getDiscardThreshold接口 InterfaceHttpPostRequestDecoder
  - getBodyHttpDatas
```
public java.util.List<InterfaceHttpData> getBodyHttpDatas()
```
    从接口复制的描述： InterfaceHttpPostRequestDecoder
    
    这个getMethod从body返回一个所有HttpDatas的列表。
    如果分块，则必须使用offer（）getMethod提供所有块。如果不是，则会引发NotEnoughDataDecoderException。
    
    Specified by:
    
    getBodyHttpDatas ，界面 InterfaceHttpPostRequestDecoder
    
    结果
    
    POST getMethod的正文部分中的HttpDatas列表
  - getBodyHttpDatas
```
public java.util.List<InterfaceHttpData> getBodyHttpDatas(java.lang.String name)
```
    从界面复制的描述： InterfaceHttpPostRequestDecoder
    
    这个getMethod返回一个所有HttpDatas的列表，其中包含正文中给定的名字。
    如果分块，则必须使用offer（）getMethod提供所有块。如果不是，则会引发NotEnoughDataDecoderException。
    
    Specified by:
    
    getBodyHttpDatas在界面 InterfaceHttpPostRequestDecoder
    
    结果
    
    具有给定名称的所有Body HttpDatas（忽略大小写）
  - getBodyHttpData
```
public InterfaceHttpData getBodyHttpData(java.lang.String name)
```
    从接口复制的描述： InterfaceHttpPostRequestDecoder
    
    这个getMethod从body返回具有给定名称的第一个InterfaceHttpData。
    如果分块，则必须使用offer（）getMethod提供所有块。如果不是，则会引发NotEnoughDataDecoderException。
    
    Specified by:
    
    getBodyHttpData在界面 InterfaceHttpPostRequestDecoder
    
    结果
    
    具有给定名称的第一个Body InterfaceHttpData（忽略大小写）
  - offer
```
public InterfaceHttpPostRequestDecoder offer(HttpContent content)
```
    从界面复制的描述： InterfaceHttpPostRequestDecoder
    
    从新块初始化内部
    
    Specified by:
    
    offer接口 InterfaceHttpPostRequestDecoder
    
    参数
    
    content - 新收到的块
  - hasNext
```
public boolean hasNext()
```
    从界面复制的描述： InterfaceHttpPostRequestDecoder
    
    如果在当前的getStatus中，则为真，则存在来自Body的可用解码的InterfaceHttpData。这个getMethod适用于分块和不分块的请求。
    
    Specified by:
    
    hasNext ，界面 InterfaceHttpPostRequestDecoder
    
    结果
    
    如果在当前的getStatus中，则为true，则有解码的InterfaceHttpData
  - next
```
public InterfaceHttpData next()
```
    从界面复制的描述： InterfaceHttpPostRequestDecoder
    
    返回下一个可用的InterfaceHttpData;如果在调用时没有可用的InterfaceHttpData，则返回null。随后的提供呼叫（httpChunk）可以启用更多数据。处理完成后请务必致电ReferenceCounted.release() ，以确保不泄漏任何资源
    
    Specified by:
    
    next ，界面 InterfaceHttpPostRequestDecoder
    
    结果
    
    下一个可用的InterfaceHttpData;如果没有，则返回null
  - currentPartialHttpData
```
public InterfaceHttpData currentPartialHttpData()
```
    从界面复制的描述： InterfaceHttpPostRequestDecoder
    
    如果当前处于解码状态（表示所有数据尚未处于内），则返回当前的InterfaceHttpData;如果当前没有处于解码状态的InterfaceHttpData（因为尚未解码或当前未解码），则返回null。通过hasNext（）和next（）方法可以完全解码。
    
    Specified by:
    
    currentPartialHttpData在界面 InterfaceHttpPostRequestDecoder
    
    结果
    
    如果当前处于解码状态，则返回当前的InterfaceHttpData;如果没有，则返回null。
  - destroy
```
public void destroy()
```
    从界面复制的描述： InterfaceHttpPostRequestDecoder
    
    销毁InterfaceHttpPostRequestDecoder并释放它的所有资源。在调用这个方法之后，不可能再对其进行操作。
    
    Specified by:
    
    destroy ，界面 InterfaceHttpPostRequestDecoder
  - cleanFiles
```
public void cleanFiles()
```
    从接口复制的描述： InterfaceHttpPostRequestDecoder
    
    清理当前请求的所有HttpDatas（在磁盘上）。
    
    Specified by:
    
    cleanFiles ，界面 InterfaceHttpPostRequestDecoder
  - removeHttpDataFromClean
```
public void removeHttpDataFromClean(InterfaceHttpData data)
```
    从接口复制的描述： InterfaceHttpPostRequestDecoder
    
    从FileUploads列表中删除给定的FileUpload以进行清理
    
    Specified by:
    
    removeHttpDataFromClean接口 InterfaceHttpPostRequestDecoder

Class HttpPostRequestDecoder

Nested Class Summary

构造方法摘要

方法摘要

Methods inherited from class java.lang.Object

构造方法详细信息

HttpPostRequestDecoder

HttpPostRequestDecoder

HttpPostRequestDecoder

方法详细信息

isMultipart

getMultipartDataBoundary

isMultipart

setDiscardThreshold

getDiscardThreshold

getBodyHttpDatas

getBodyHttpDatas

getBodyHttpData

offer

hasNext

next

currentPartialHttpData

destroy

cleanFiles

removeHttpDataFromClean