Response (hutool 6.0.0-M20 API)

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

HttpClient4Response, HttpClient5Response, JdkHttpResponse, OkHttpResponse
```
public interface Response
extends Closeable
```
响应内容接口，包括响应状态码、HTTP消息头、响应体等信息

Since:

6.0.0

Author:

looly

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`ResponseBody`	`body()` 获取响应体，包含服务端返回的内容和Content-Type信息如果为HEAD、CONNECT、TRACE等方法无响应体，则返回`null`
`default byte[]`	`bodyBytes()` 获取响应流字节码此方法会转为同步模式，读取响应流并关闭之
`default String`	`bodyStr()` 获取响应主体
`InputStream`	`bodyStream()` 获得服务区响应流流获取后处理完毕需关闭此类
`default Charset`	`charset()` 获取字符集编码，默认为响应头中的编码
`default String`	`contentEncoding()` 获取内容编码
`default long`	`contentLength()` 获取内容长度，以下情况长度无效： Transfer-Encoding: Chunked Content-Encoding: XXX 参考：https://blog.csdn.net/jiang7701037/article/details/86304302
`default String`	`getCookieStr()` 获取本次请求服务器返回的Cookie信息
`default String`	`getFileNameFromDisposition(String paramName)` 从Content-Disposition头中获取文件名，以参数名为`filename`为例，规则为：首先按照RFC5987规范检查`filename`参数对应的值，即：`filename="example.txt"`，则获取`example.txt` 如果找不到`filename`参数，则检查`filename`参数对应的值，即：`filename="example.txt"`，则获取`example.txt` 按照规范，`Content-Disposition`可能返回多个，此处遍历所有返回头，并且`filename`始终优先获取，即使`filename`存在并更靠前。
`int`	`getStatus()` 获取状态码
`default String`	`header(HeaderName name)` 根据name获取头信息
`String`	`header(String name)` 根据name获取头信息根据RFC2616规范，header的name不区分大小写
`default List<String>`	`headerList(String name)` 根据name获取对应的头信息列表
`Map<String,List<String>>`	`headers()` 获取headers
`default boolean`	`isChunked()` 是否为Transfer-Encoding:Chunked的内容
`default boolean`	`isOk()` 请求是否成功，判断依据为：状态码范围在200~299内。
`Response`	`sync()` 同步如果为异步状态，则暂时不读取服务器中响应的内容，而是持有Http链接的`InputStream`。
`default void`	`then(Consumer<Response> consumer)` 链式处理结果

Methods inherited from interface java.io.Closeable
close

- Method Detail
  - getStatus
```
int getStatus()
```
    获取状态码
    
    Returns:
    
    状态码
  - header
```
String header(String name)
```
    根据name获取头信息
    根据RFC2616规范，header的name不区分大小写
    
    Parameters:
    
    name - Header名
    
    Returns:
    
    Header值
  - headers
```
Map<String,List<String>> headers()
```
    获取headers
    
    Returns:
    
    Headers Map
  - charset
```
default Charset charset()
```
    获取字符集编码，默认为响应头中的编码
    
    Returns:
    
    字符集
  - bodyStream
```
InputStream bodyStream()
```
    获得服务区响应流
    流获取后处理完毕需关闭此类
    
    Returns:
    
    响应流
  - sync
```
Response sync()
```
    同步
    如果为异步状态，则暂时不读取服务器中响应的内容，而是持有Http链接的InputStream。
    当调用此方法时，异步状态转为同步状态，此时从Http链接流中读取body内容并暂存在内容(内存)中。如果已经是同步状态，则不进行任何操作。
    
    Returns:
    
    this
  - body
```
ResponseBody body()
```
    获取响应体，包含服务端返回的内容和Content-Type信息
    如果为HEAD、CONNECT、TRACE等方法无响应体，则返回null
    
    Returns:
    
    ResponseBody
  - bodyStr
```
default String bodyStr()
                throws HttpException
```
    获取响应主体
    
    Returns:
    
    String
    
    Throws:
    
    HttpException - 包装IO异常
  - bodyBytes
```
default byte[] bodyBytes()
```
    获取响应流字节码
    此方法会转为同步模式，读取响应流并关闭之
    
    Returns:
    
    byte[]
  - isOk
```
default boolean isOk()
```
    请求是否成功，判断依据为：状态码范围在200~299内。
    
    Returns:
    
    是否成功请求
  - header
```
default String header(HeaderName name)
```
    根据name获取头信息
    
    Parameters:
    
    name - Header名
    
    Returns:
    
    Header值
  - headerList
```
default List<String> headerList(String name)
```
    根据name获取对应的头信息列表
    
    Parameters:
    
    name - Header名
    
    Returns:
    
    Header值
  - contentEncoding
```
default String contentEncoding()
```
    获取内容编码
    
    Returns:
    
    String
  - contentLength
```
default long contentLength()
```
    获取内容长度，以下情况长度无效：
    - Transfer-Encoding: Chunked
    - Content-Encoding: XXX
    参考：https://blog.csdn.net/jiang7701037/article/details/86304302
    Returns:
    
    长度，-1表示服务端未返回或长度无效
    
    Since:
    
    5.7.9
  - isChunked
```
default boolean isChunked()
```
    是否为Transfer-Encoding:Chunked的内容
    
    Returns:
    
    是否为Transfer-Encoding:Chunked的内容
    
    Since:
    
    4.6.2
  - getCookieStr
```
default String getCookieStr()
```
    获取本次请求服务器返回的Cookie信息
    
    Returns:
    
    Cookie字符串
    
    Since:
    
    3.1.1
  - getFileNameFromDisposition
```
default String getFileNameFromDisposition(String paramName)
```
    从Content-Disposition头中获取文件名，以参数名为`filename`为例，规则为：
    - 首先按照RFC5987规范检查`filename*`参数对应的值，即：`filename*="example.txt"`，则获取`example.txt`
    - 如果找不到`filename*`参数，则检查`filename`参数对应的值，即：`filename="example.txt"`，则获取`example.txt`
    按照规范，`Content-Disposition`可能返回多个，此处遍历所有返回头，并且`filename*`始终优先获取，即使`filename`存在并更靠前。
    参考：https://developer.mozilla.org/zh-CN/docs/Web/HTTP/Headers/Content-Disposition
    Parameters:
    
    paramName - 文件参数名，如果为null则使用默认的`filename`
    
    Returns:
    
    文件名，empty表示无
  - then
```
default void then(Consumer<Response> consumer)
```
    链式处理结果
    
    Parameters:
    
    consumer - Consumer

Interface Response

Method Summary

Methods inherited from interface java.io.Closeable

Method Detail

getStatus

header

headers

charset

bodyStream

sync

body

bodyStr

bodyBytes

isOk

header

headerList

contentEncoding

contentLength

isChunked

getCookieStr

getFileNameFromDisposition

then