HttpResponse (hutool-http 4.6.2 API)

java.lang.Object
- cn.hutool.http.HttpBase<HttpResponse>
- - cn.hutool.http.HttpResponse

所有已实现的接口:

Closeable, AutoCloseable
```
public class HttpResponse
extends HttpBase<HttpResponse>
implements Closeable
```
Http响应类
非线程安全对象

作者:

Looly

字段概要

字段
限定符和类型字段和说明

protected HttpConnection httpConnection
持有连接对象

protected InputStream in
Http请求原始流

protected int status
响应状态码
- 从类继承的字段 cn.hutool.http.HttpBase
  bodyBytes, charset, headers, HTTP_1_0, HTTP_1_1, httpVersion

字段
限定符和类型	字段和说明
`protected HttpConnection`	`httpConnection` 持有连接对象
`protected InputStream`	`in` Http请求原始流
`protected int`	`status` 响应状态码

构造器概要

构造器
限定符	构造器和说明
`protected`	`HttpResponse(HttpConnection httpConnection, Charset charset, boolean isAsync, boolean isIgnoreBody)` 构造

方法概要

方法
限定符和类型	方法和说明
`String`	`body()` 获取响应主体
`byte[]`	`bodyBytes()` 获取响应流字节码此方法会转为同步模式
`InputStream`	`bodyStream()` 获得服务区响应流异步模式下获取Http原生流，同步模式下获取获取到的在内存中的副本如果想在同步模式下获取流，请先调用`sync()`方法强制同步流获取后处理完毕需关闭此类
`void`	`close()`
`String`	`contentEncoding()` 获取内容编码
`HttpCookie`	`getCookie(String name)` 获取Cookie
`List<HttpCookie>`	`getCookies()` 获取Cookie
`String`	`getCookieStr()` 获取本次请求服务器返回的Cookie信息
`String`	`getCookieValue(String name)` 获取Cookie值
`int`	`getStatus()` 获取状态码
`boolean`	`isChunked()` 是否为Transfer-Encoding:Chunked的内容
`boolean`	`isDeflate()` 是否为zlib(Defalte)压缩过的内容
`boolean`	`isGzip()` 是否为gzip压缩过的内容
`boolean`	`isOk()` 请求是否成功，判断依据为：状态码范围在200~299内。
`HttpResponse`	`sync()` 同步如果为异步状态，则暂时不读取服务器中响应的内容，而是持有Http链接的`InputStream`。
`String`	`toString()`
`long`	`writeBody(File destFile)` 将响应内容写出到文件异步模式下直接读取Http流写出，同步模式下将存储在内存中的响应内容写出写出后会关闭Http流（异步模式）
`long`	`writeBody(File destFile, StreamProgress streamProgress)` 将响应内容写出到文件异步模式下直接读取Http流写出，同步模式下将存储在内存中的响应内容写出写出后会关闭Http流（异步模式）
`long`	`writeBody(OutputStream out, boolean isCloseOut, StreamProgress streamProgress)` 将响应内容写出到`OutputStream` 异步模式下直接读取Http流写出，同步模式下将存储在内存中的响应内容写出写出后会关闭Http流（异步模式）
`long`	`writeBody(String destFilePath)` 将响应内容写出到文件异步模式下直接读取Http流写出，同步模式下将存储在内存中的响应内容写出写出后会关闭Http流（异步模式）

从类继承的方法 cn.hutool.http.HttpBase
addHeaders, charset, charset, charset, header, header, header, header, header, header, header, header, headerList, headers, httpVersion, httpVersion, removeHeader, removeHeader

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - httpConnection
```
protected HttpConnection httpConnection
```
    持有连接对象
  - in
```
protected InputStream in
```
    Http请求原始流
  - status
```
protected int status
```
    响应状态码
- 构造器详细资料
  - HttpResponse
```
protected HttpResponse(HttpConnection httpConnection,
            Charset charset,
            boolean isAsync,
            boolean isIgnoreBody)
```
    构造
    
    参数:
    httpConnection - HttpConnection
    charset - 编码，从请求编码中获取默认编码
    isAsync - 是否异步
    isIgnoreBody - 是否忽略读取响应体
    从以下版本开始:
    
    3.1.2
- 方法详细资料
  - getStatus
```
public int getStatus()
```
    获取状态码
    
    返回:
    状态码
  - isOk
```
public boolean isOk()
```
    请求是否成功，判断依据为：状态码范围在200~299内。
    
    返回:
    是否成功请求
    从以下版本开始:
    
    4.1.9
  - sync
```
public HttpResponse sync()
```
    同步
    如果为异步状态，则暂时不读取服务器中响应的内容，而是持有Http链接的InputStream。
    当调用此方法时，异步状态转为同步状态，此时从Http链接流中读取body内容并暂存在内容中。如果已经是同步状态，则不进行任何操作。
    
    返回:
    this
  - contentEncoding
```
public String contentEncoding()
```
    获取内容编码
    
    返回:
    String
  - isGzip
```
public boolean isGzip()
```
    是否为gzip压缩过的内容
    
    返回:
    是否为gzip压缩过的内容
  - isDeflate
```
public boolean isDeflate()
```
    是否为zlib(Defalte)压缩过的内容
    
    返回:
    是否为zlib(Defalte)压缩过的内容
    从以下版本开始:
    
    4.5.7
  - isChunked
```
public boolean isChunked()
```
    是否为Transfer-Encoding:Chunked的内容
    
    返回:
    是否为Transfer-Encoding:Chunked的内容
    从以下版本开始:
    
    4.6.2
  - getCookieStr
```
public String getCookieStr()
```
    获取本次请求服务器返回的Cookie信息
    
    返回:
    Cookie字符串
    从以下版本开始:
    
    3.1.1
  - getCookies
```
public List<HttpCookie> getCookies()
```
    获取Cookie
    
    返回:
    Cookie列表
    从以下版本开始:
    
    3.1.1
    
    另请参阅:
    GlobalCookieManager.getCookieManager()
  - getCookie
```
public HttpCookie getCookie(String name)
```
    获取Cookie
    
    参数:
    name - Cookie名
    
    返回:
    HttpCookie
    从以下版本开始:
    
    4.1.4
  - getCookieValue
```
public String getCookieValue(String name)
```
    获取Cookie值
    
    参数:
    name - Cookie名
    
    返回:
    Cookie值
    从以下版本开始:
    
    4.1.4
  - bodyStream
```
public InputStream bodyStream()
```
    获得服务区响应流
    异步模式下获取Http原生流，同步模式下获取获取到的在内存中的副本
    如果想在同步模式下获取流，请先调用sync()方法强制同步
    流获取后处理完毕需关闭此类
    
    返回:
    响应流
  - bodyBytes
```
public byte[] bodyBytes()
```
    获取响应流字节码
    此方法会转为同步模式
    
    返回:
    byte[]
  - body
```
public String body()
            throws HttpException
```
    获取响应主体
    
    返回:
    String
    
    抛出:
    
    HttpException - 包装IO异常
  - writeBody
```
public long writeBody(OutputStream out,
             boolean isCloseOut,
             StreamProgress streamProgress)
```
    将响应内容写出到OutputStream
    异步模式下直接读取Http流写出，同步模式下将存储在内存中的响应内容写出
    写出后会关闭Http流（异步模式）
    
    参数:
    out - 写出的流
    isCloseOut - 是否关闭输出流
    streamProgress - 进度显示接口，通过实现此接口显示下载进度
    
    返回:
    写出bytes数
    从以下版本开始:
    
    3.3.2
  - writeBody
```
public long writeBody(File destFile,
             StreamProgress streamProgress)
```
    将响应内容写出到文件
    异步模式下直接读取Http流写出，同步模式下将存储在内存中的响应内容写出
    写出后会关闭Http流（异步模式）
    
    参数:
    destFile - 写出到的文件
    streamProgress - 进度显示接口，通过实现此接口显示下载进度
    
    返回:
    写出bytes数
    从以下版本开始:
    
    3.3.2
  - writeBody
```
public long writeBody(File destFile)
```
    将响应内容写出到文件
    异步模式下直接读取Http流写出，同步模式下将存储在内存中的响应内容写出
    写出后会关闭Http流（异步模式）
    
    参数:
    destFile - 写出到的文件
    
    返回:
    写出bytes数
    从以下版本开始:
    
    3.3.2
  - writeBody
```
public long writeBody(String destFilePath)
```
    将响应内容写出到文件
    异步模式下直接读取Http流写出，同步模式下将存储在内存中的响应内容写出
    写出后会关闭Http流（异步模式）
    
    参数:
    destFilePath - 写出到的文件的路径
    
    返回:
    写出bytes数
    从以下版本开始:
    
    3.3.2
  - close
```
public void close()
```
    指定者:
    
    close 在接口中 Closeable
    
    指定者:
    
    close 在接口中 AutoCloseable
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 HttpBase<HttpResponse>

类 HttpResponse

字段概要

从类继承的字段 cn.hutool.http.HttpBase

构造器概要

方法概要

从类继承的方法 cn.hutool.http.HttpBase

从类继承的方法 java.lang.Object

字段详细资料

httpConnection

in

status

构造器详细资料

HttpResponse

方法详细资料

getStatus

isOk

sync

contentEncoding

isGzip

isDeflate

isChunked

getCookieStr

getCookies

getCookie

getCookieValue

bodyStream

bodyBytes

body

writeBody

writeBody

writeBody

writeBody

close

toString