HttpClient5Response (hutool 6.0.0-M20 API)

java.lang.Object
- org.dromara.hutool.core.lang.wrapper.SimpleWrapper<org.apache.hc.core5.http.ClassicHttpResponse>
- - org.dromara.hutool.http.client.engine.httpclient5.HttpClient5Response

All Implemented Interfaces:

Closeable, AutoCloseable, Wrapper<org.apache.hc.core5.http.ClassicHttpResponse>, Response
```
public class HttpClient5Response
extends SimpleWrapper<org.apache.hc.core5.http.ClassicHttpResponse>
implements Response
```
HttpClient响应包装
通过包装CloseableHttpResponse，实现获取响应状态码、响应头、响应体等内容

Author:

looly

Field Summary
- Fields inherited from class org.dromara.hutool.core.lang.wrapper.SimpleWrapper
  raw

Constructor Summary

Constructors
Constructor and Description
`HttpClient5Response(org.apache.hc.core5.http.ClassicHttpResponse rawRes, Request message)` 构造通过传入一个请求时的编码，当无法获取响应内容的编码时，默认使用响应时的编码

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ResponseBody`	`body()` 获取响应体，包含服务端返回的内容和Content-Type信息如果为HEAD、CONNECT、TRACE等方法无响应体，则返回`null`
`String`	`bodyStr()` 获取响应主体
`InputStream`	`bodyStream()` 获得服务区响应流流获取后处理完毕需关闭此类
`Charset`	`charset()` 获取字符集编码，默认为响应头中的编码
`void`	`close()`
`long`	`contentLength()` 获取内容长度，以下情况长度无效： Transfer-Encoding: Chunked Content-Encoding: XXX 参考：https://blog.csdn.net/jiang7701037/article/details/86304302
`int`	`getStatus()` 获取状态码
`String`	`header(String name)` 根据name获取头信息根据RFC2616规范，header的name不区分大小写
`Map<String,List<String>>`	`headers()` 获取headers
`HttpClient5Response`	`sync()` 同步如果为异步状态，则暂时不读取服务器中响应的内容，而是持有Http链接的`InputStream`。
`String`	`toString()`

Methods inherited from class org.dromara.hutool.core.lang.wrapper.SimpleWrapper
getRaw

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

Methods inherited from interface org.dromara.hutool.http.client.Response
bodyBytes, contentEncoding, getCookieStr, getFileNameFromDisposition, header, headerList, isChunked, isOk, then

- Constructor Detail
  - HttpClient5Response
```
public HttpClient5Response(org.apache.hc.core5.http.ClassicHttpResponse rawRes,
                           Request message)
```
    构造
    通过传入一个请求时的编码，当无法获取响应内容的编码时，默认使用响应时的编码
    
    Parameters:
    
    rawRes - CloseableHttpResponse
    
    message - 请求消息
- Method Detail
  - getStatus
```
public int getStatus()
```
    Description copied from interface: Response
    
    获取状态码
    
    Specified by:
    
    getStatus in interface Response
    
    Returns:
    
    状态码
  - header
```
public String header(String name)
```
    Description copied from interface: Response
    
    根据name获取头信息
    根据RFC2616规范，header的name不区分大小写
    
    Specified by:
    
    header in interface Response
    
    Parameters:
    
    name - Header名
    
    Returns:
    
    Header值
  - headers
```
public Map<String,List<String>> headers()
```
    Description copied from interface: Response
    
    获取headers
    
    Specified by:
    
    headers in interface Response
    
    Returns:
    
    Headers Map
  - contentLength
```
public long contentLength()
```
    Description copied from interface: Response
    获取内容长度，以下情况长度无效：
    - Transfer-Encoding: Chunked
    - Content-Encoding: XXX
    参考：https://blog.csdn.net/jiang7701037/article/details/86304302
    Specified by:
    
    contentLength in interface Response
    
    Returns:
    
    长度，-1表示服务端未返回或长度无效
  - charset
```
public Charset charset()
```
    Description copied from interface: Response
    
    获取字符集编码，默认为响应头中的编码
    
    Specified by:
    
    charset in interface Response
    
    Returns:
    
    字符集
  - bodyStream
```
public InputStream bodyStream()
```
    Description copied from interface: Response
    
    获得服务区响应流
    流获取后处理完毕需关闭此类
    
    Specified by:
    
    bodyStream in interface Response
    
    Returns:
    
    响应流
  - sync
```
public HttpClient5Response sync()
```
    Description copied from interface: Response
    
    同步
    如果为异步状态，则暂时不读取服务器中响应的内容，而是持有Http链接的InputStream。
    当调用此方法时，异步状态转为同步状态，此时从Http链接流中读取body内容并暂存在内容(内存)中。如果已经是同步状态，则不进行任何操作。
    
    Specified by:
    
    sync in interface Response
    
    Returns:
    
    this
  - body
```
public ResponseBody body()
```
    Description copied from interface: Response
    
    获取响应体，包含服务端返回的内容和Content-Type信息
    如果为HEAD、CONNECT、TRACE等方法无响应体，则返回null
    
    Specified by:
    
    body in interface Response
    
    Returns:
    
    ResponseBody
  - bodyStr
```
public String bodyStr()
               throws HttpException
```
    Description copied from interface: Response
    
    获取响应主体
    
    Specified by:
    
    bodyStr in interface Response
    
    Returns:
    
    String
    
    Throws:
    
    HttpException - 包装IO异常
  - close
```
public void close()
           throws IOException
```
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    IOException
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class HttpClient5Response

Field Summary

Fields inherited from class org.dromara.hutool.core.lang.wrapper.SimpleWrapper

Constructor Summary

Method Summary

Methods inherited from class org.dromara.hutool.core.lang.wrapper.SimpleWrapper

Methods inherited from class java.lang.Object

Methods inherited from interface org.dromara.hutool.http.client.Response

Constructor Detail

HttpClient5Response

Method Detail

getStatus

header

headers

contentLength

charset

bodyStream

sync

body

bodyStr

close

toString