HttpResponse (hutool 5.8.33 API)

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

All Implemented Interfaces:

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

Author:

Looly

Field Summary

Fields
Modifier and Type	Field and Description
`protected HttpConfig`	`config` Http配置
`protected HttpConnection`	`httpConnection` 持有连接对象
`protected InputStream`	`in` Http请求原始流
`protected int`	`status` 响应状态码

Fields inherited from class cn.hutool.http.HttpBase
body, charset, DEFAULT_CHARSET, headers, HTTP_1_0, HTTP_1_1, httpVersion

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`HttpResponse(HttpConnection httpConnection, HttpConfig config, Charset charset, boolean isAsync, boolean isIgnoreBody)` 构造

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`body()` 获取响应主体
`HttpResponse`	`body(byte[] bodyBytes)` 设置主体字节码需在此方法调用前使用charset方法设置编码，否则使用默认编码UTF-8
`byte[]`	`bodyBytes()` 获取响应流字节码此方法会转为同步模式
`InputStream`	`bodyStream()` 获得服务区响应流异步模式下获取Http原生流，同步模式下获取获取到的在内存中的副本如果想在同步模式下获取流，请先调用`sync()`方法强制同步流获取后处理完毕需关闭此类
`void`	`close()`
`File`	`completeFileNameFromHeader(File targetFileOrDir)` 从响应头补全下载文件名
`String`	`contentEncoding()` 获取内容编码
`long`	`contentLength()` 获取内容长度，以下情况长度无效： Transfer-Encoding: Chunked Content-Encoding: XXX 参考：https://blog.csdn.net/jiang7701037/article/details/86304302
`HttpCookie`	`getCookie(String name)` 获取Cookie
`List<HttpCookie>`	`getCookies()` 获取Cookie
`String`	`getCookieStr()` 获取本次请求服务器返回的Cookie信息
`String`	`getCookieValue(String name)` 获取Cookie值
`String`	`getFileNameFromDisposition()` 从Content-Disposition头中获取文件名
`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()` 获取状态码
`boolean`	`isChunked()` 是否为Transfer-Encoding:Chunked的内容
`boolean`	`isDeflate()` 是否为zlib(Deflate)压缩过的内容
`boolean`	`isGzip()` 是否为gzip压缩过的内容
`boolean`	`isOk()` 请求是否成功，判断依据为：状态码范围在200~299内。
`HttpResponse`	`sync()` 同步如果为异步状态，则暂时不读取服务器中响应的内容，而是持有Http链接的`InputStream`。
`String`	`toString()`
`long`	`writeBody(File targetFileOrDir)` 将响应内容写出到文件异步模式下直接读取Http流写出，同步模式下将存储在内存中的响应内容写出写出后会关闭Http流（异步模式）
`long`	`writeBody(File targetFileOrDir, StreamProgress streamProgress)` 将响应内容写出到文件异步模式下直接读取Http流写出，同步模式下将存储在内存中的响应内容写出写出后会关闭Http流（异步模式）
`long`	`writeBody(File targetFileOrDir, String tempFileSuffix, StreamProgress streamProgress)` 将响应内容写出到文件-避免未完成的文件异步模式下直接读取Http流写出，同步模式下将存储在内存中的响应内容写出写出后会关闭Http流（异步模式）来自：https://gitee.com/dromara/hutool/pulls/407 此方法原理是先在目标文件同级目录下创建临时文件，下载之，等下载完毕后重命名，避免因下载错误导致的文件不完整。
`long`	`writeBody(OutputStream out, boolean isCloseOut, StreamProgress streamProgress)` 将响应内容写出到`OutputStream` 异步模式下直接读取Http流写出，同步模式下将存储在内存中的响应内容写出写出后会关闭Http流（异步模式）
`long`	`writeBody(String targetFileOrDir)` 将响应内容写出到文件异步模式下直接读取Http流写出，同步模式下将存储在内存中的响应内容写出写出后会关闭Http流（异步模式）
`File`	`writeBodyForFile(File targetFileOrDir, StreamProgress streamProgress)` 将响应内容写出到文件异步模式下直接读取Http流写出，同步模式下将存储在内存中的响应内容写出写出后会关闭Http流（异步模式）

Methods inherited from class cn.hutool.http.HttpBase
addHeaders, charset, charset, charset, clearHeaders, header, header, header, header, header, header, header, header, headerList, headerMap, headers, httpVersion, httpVersion, removeHeader, removeHeader

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

- Field Detail
  - config
```
protected HttpConfig config
```
    Http配置
  - httpConnection
```
protected HttpConnection httpConnection
```
    持有连接对象
  - in
```
protected InputStream in
```
    Http请求原始流
  - status
```
protected int status
```
    响应状态码
- Constructor Detail
  - HttpResponse
```
protected HttpResponse(HttpConnection httpConnection,
                       HttpConfig config,
                       Charset charset,
                       boolean isAsync,
                       boolean isIgnoreBody)
```
    构造
    
    Parameters:
    
    httpConnection - HttpConnection
    
    config - Http配置
    
    charset - 编码，从请求编码中获取默认编码
    
    isAsync - 是否异步
    
    isIgnoreBody - 是否忽略读取响应体
    
    Since:
    
    3.1.2
- Method Detail
  - getStatus
```
public int getStatus()
```
    获取状态码
    
    Returns:
    
    状态码
  - isOk
```
public boolean isOk()
```
    请求是否成功，判断依据为：状态码范围在200~299内。
    
    Returns:
    
    是否成功请求
    
    Since:
    
    4.1.9
  - sync
```
public HttpResponse sync()
```
    同步
    如果为异步状态，则暂时不读取服务器中响应的内容，而是持有Http链接的InputStream。
    当调用此方法时，异步状态转为同步状态，此时从Http链接流中读取body内容并暂存在内容中。如果已经是同步状态，则不进行任何操作。
    
    Returns:
    
    this
  - contentEncoding
```
public String contentEncoding()
```
    获取内容编码
    
    Returns:
    
    String
  - contentLength
```
public long contentLength()
```
    获取内容长度，以下情况长度无效：
    - Transfer-Encoding: Chunked
    - Content-Encoding: XXX
    参考：https://blog.csdn.net/jiang7701037/article/details/86304302
    Returns:
    
    长度，-1表示服务端未返回或长度无效
    
    Since:
    
    5.7.9
  - isGzip
```
public boolean isGzip()
```
    是否为gzip压缩过的内容
    
    Returns:
    
    是否为gzip压缩过的内容
  - isDeflate
```
public boolean isDeflate()
```
    是否为zlib(Deflate)压缩过的内容
    
    Returns:
    
    是否为zlib(Deflate)压缩过的内容
    
    Since:
    
    4.5.7
  - isChunked
```
public boolean isChunked()
```
    是否为Transfer-Encoding:Chunked的内容
    
    Returns:
    
    是否为Transfer-Encoding:Chunked的内容
    
    Since:
    
    4.6.2
  - getCookieStr
```
public String getCookieStr()
```
    获取本次请求服务器返回的Cookie信息
    
    Returns:
    
    Cookie字符串
    
    Since:
    
    3.1.1
  - getCookies
```
public List<HttpCookie> getCookies()
```
    获取Cookie
    
    Returns:
    
    Cookie列表
    
    Since:
    
    3.1.1
  - getCookie
```
public HttpCookie getCookie(String name)
```
    获取Cookie
    
    Parameters:
    
    name - Cookie名
    
    Returns:
    
    HttpCookie
    
    Since:
    
    4.1.4
  - getCookieValue
```
public String getCookieValue(String name)
```
    获取Cookie值
    
    Parameters:
    
    name - Cookie名
    
    Returns:
    
    Cookie值
    
    Since:
    
    4.1.4
  - bodyStream
```
public InputStream bodyStream()
```
    获得服务区响应流
    异步模式下获取Http原生流，同步模式下获取获取到的在内存中的副本
    如果想在同步模式下获取流，请先调用sync()方法强制同步
    流获取后处理完毕需关闭此类
    
    Returns:
    
    响应流
  - bodyBytes
```
public byte[] bodyBytes()
```
    获取响应流字节码
    此方法会转为同步模式
    
    Overrides:
    
    bodyBytes in class HttpBase<HttpResponse>
    
    Returns:
    
    byte[]
  - body
```
public HttpResponse body(byte[] bodyBytes)
```
    设置主体字节码
    需在此方法调用前使用charset方法设置编码，否则使用默认编码UTF-8
    
    Parameters:
    
    bodyBytes - 主体
    
    Returns:
    
    this
  - body
```
public String body()
            throws HttpException
```
    获取响应主体
    
    Returns:
    
    String
    
    Throws:
    
    HttpException - 包装IO异常
  - writeBody
```
public long writeBody(OutputStream out,
                      boolean isCloseOut,
                      StreamProgress streamProgress)
```
    将响应内容写出到OutputStream
    异步模式下直接读取Http流写出，同步模式下将存储在内存中的响应内容写出
    写出后会关闭Http流（异步模式）
    
    Parameters:
    
    out - 写出的流
    
    isCloseOut - 是否关闭输出流
    
    streamProgress - 进度显示接口，通过实现此接口显示下载进度
    
    Returns:
    
    写出bytes数
    
    Since:
    
    3.3.2
  - writeBody
```
public long writeBody(File targetFileOrDir,
                      StreamProgress streamProgress)
```
    将响应内容写出到文件
    异步模式下直接读取Http流写出，同步模式下将存储在内存中的响应内容写出
    写出后会关闭Http流（异步模式）
    
    Parameters:
    
    targetFileOrDir - 写出到的文件或目录
    
    streamProgress - 进度显示接口，通过实现此接口显示下载进度
    
    Returns:
    
    写出bytes数
    
    Since:
    
    3.3.2
  - writeBody
```
public long writeBody(File targetFileOrDir,
                      String tempFileSuffix,
                      StreamProgress streamProgress)
```
    将响应内容写出到文件-避免未完成的文件
    异步模式下直接读取Http流写出，同步模式下将存储在内存中的响应内容写出
    写出后会关闭Http流（异步模式）
    来自：https://gitee.com/dromara/hutool/pulls/407
    此方法原理是先在目标文件同级目录下创建临时文件，下载之，等下载完毕后重命名，避免因下载错误导致的文件不完整。
    
    Parameters:
    
    targetFileOrDir - 写出到的文件或目录
    
    tempFileSuffix - 临时文件后缀，默认".temp"
    
    streamProgress - 进度显示接口，通过实现此接口显示下载进度
    
    Returns:
    
    写出bytes数
    
    Since:
    
    5.7.12
  - writeBodyForFile
```
public File writeBodyForFile(File targetFileOrDir,
                             StreamProgress streamProgress)
```
    将响应内容写出到文件
    异步模式下直接读取Http流写出，同步模式下将存储在内存中的响应内容写出
    写出后会关闭Http流（异步模式）
    
    Parameters:
    
    targetFileOrDir - 写出到的文件
    
    streamProgress - 进度显示接口，通过实现此接口显示下载进度
    
    Returns:
    
    写出的文件
    
    Since:
    
    5.6.4
  - writeBody
```
public long writeBody(File targetFileOrDir)
```
    将响应内容写出到文件
    异步模式下直接读取Http流写出，同步模式下将存储在内存中的响应内容写出
    写出后会关闭Http流（异步模式）
    
    Parameters:
    
    targetFileOrDir - 写出到的文件或目录
    
    Returns:
    
    写出bytes数
    
    Since:
    
    3.3.2
  - writeBody
```
public long writeBody(String targetFileOrDir)
```
    将响应内容写出到文件
    异步模式下直接读取Http流写出，同步模式下将存储在内存中的响应内容写出
    写出后会关闭Http流（异步模式）
    
    Parameters:
    
    targetFileOrDir - 写出到的文件或目录的路径
    
    Returns:
    
    写出bytes数
    
    Since:
    
    3.3.2
  - close
```
public void close()
```
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class HttpBase<HttpResponse>
  - completeFileNameFromHeader
```
public File completeFileNameFromHeader(File targetFileOrDir)
```
    从响应头补全下载文件名
    
    Parameters:
    
    targetFileOrDir - 目标文件夹或者目标文件
    
    Returns:
    
    File 保存的文件
    
    Since:
    
    5.4.1
  - getFileNameFromDisposition
```
public String getFileNameFromDisposition()
```
    从Content-Disposition头中获取文件名
    
    Returns:
    
    文件名，empty表示无
  - getFileNameFromDisposition
```
public 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表示无

Class HttpResponse

Field Summary

Fields inherited from class cn.hutool.http.HttpBase

Constructor Summary

Method Summary

Methods inherited from class cn.hutool.http.HttpBase

Methods inherited from class java.lang.Object

Field Detail

config

httpConnection

in

status

Constructor Detail

HttpResponse

Method Detail

getStatus

isOk

sync

contentEncoding

contentLength

isGzip

isDeflate

isChunked

getCookieStr

getCookies

getCookie

getCookieValue

bodyStream

bodyBytes

body

body

writeBody

writeBody

writeBody

writeBodyForFile

writeBody

writeBody

close

toString

completeFileNameFromHeader

getFileNameFromDisposition

getFileNameFromDisposition