ResponseBody (hutool-http 6.0.0-M4 API)

java.lang.Object
- org.dromara.hutool.http.client.body.ResponseBody

所有已实现的接口:

Closeable, AutoCloseable, HttpBody
```
public class ResponseBody
extends Object
implements HttpBody, Closeable
```
响应体部分封装

作者:

looly

构造器概要

构造器
构造器和说明

ResponseBody(Response response, InputStream in, boolean isAsync, boolean isIgnoreEOFError)
构造

构造器
构造器和说明
`ResponseBody(Response response, InputStream in, boolean isAsync, boolean isIgnoreEOFError)` 构造

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`close()`
`byte[]`	`getBytes()` 获取响应内容的bytes
`String`	`getContentType()` 获取Content-Type
`InputStream`	`getStream()` 获取body资源流
`String`	`getString()` 获取响应字符串，自动识别判断编码
`ResponseBody`	`sync()` 同步数据到内存，以bytes形式存储
`String`	`toString()`
`File`	`write(File targetFileOrDir)` 将响应内容写出到文件异步模式下直接读取Http流写出，同步模式下将存储在内存中的响应内容写出写出后会关闭Http流（异步模式）
`File`	`write(File targetFileOrDir, StreamProgress streamProgress)` 将响应内容写出到文件-避免未完成的文件来自：https://gitee.com/dromara/hutool/pulls/407 此方法原理是先在目标文件同级目录下创建临时文件，下载之，等下载完毕后重命名，避免因下载错误导致的文件不完整。
`File`	`write(File targetFileOrDir, String tempFileSuffix, StreamProgress streamProgress)` 将响应内容写出到文件-避免未完成的文件来自：https://gitee.com/dromara/hutool/pulls/407 此方法原理是先在目标文件同级目录下创建临时文件，下载之，等下载完毕后重命名，避免因下载错误导致的文件不完整。
`void`	`write(OutputStream out)` 写出数据，不关闭流
`long`	`write(OutputStream out, boolean isCloseOut, StreamProgress streamProgress)` 将响应内容写出到`OutputStream` 异步模式下直接读取Http流写出，同步模式下将存储在内存中的响应内容写出写出后会关闭Http流（异步模式）
`File`	`write(String targetFileOrDir)` 将响应内容写出到文件
`File`	`writeDirect(File targetFileOrDir, String customParamName, StreamProgress streamProgress)` 将响应内容直接写出到文件，目标为目录则从Content-Disposition中获取文件名

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

从接口继承的方法 org.dromara.hutool.http.client.body.HttpBody
getContentType, writeClose

- 构造器详细资料
  - ResponseBody
```
public ResponseBody(Response response,
                    InputStream in,
                    boolean isAsync,
                    boolean isIgnoreEOFError)
```
    构造
    
    参数:
    
    response - 响应体
    
    in - HTTP主体响应流
    
    isAsync - 是否异步模式
    
    isIgnoreEOFError - 是否忽略EOF错误
- 方法详细资料
  - getContentType
```
public String getContentType()
```
    从接口复制的说明: HttpBody
    
    获取Content-Type
    
    指定者:
    
    getContentType 在接口中 HttpBody
    
    返回:
    
    Content-Type值
  - getStream
```
public InputStream getStream()
```
    从接口复制的说明: HttpBody
    
    获取body资源流
    
    指定者:
    
    getStream 在接口中 HttpBody
    
    返回:
    
    InputStream
  - write
```
public void write(OutputStream out)
```
    从接口复制的说明: HttpBody
    
    写出数据，不关闭流
    
    指定者:
    
    write 在接口中 HttpBody
    
    参数:
    
    out - out流
  - sync
```
public ResponseBody sync()
```
    同步数据到内存，以bytes形式存储
    
    返回:
    
    this
  - getBytes
```
public byte[] getBytes()
```
    获取响应内容的bytes
    
    返回:
    
    响应内容bytes
  - getString
```
public String getString()
```
    获取响应字符串，自动识别判断编码
    
    返回:
    
    响应字符串
  - write
```
public long write(OutputStream out,
                  boolean isCloseOut,
                  StreamProgress streamProgress)
```
    将响应内容写出到OutputStream
    异步模式下直接读取Http流写出，同步模式下将存储在内存中的响应内容写出
    写出后会关闭Http流（异步模式）
    
    参数:
    
    out - 写出的流
    
    isCloseOut - 是否关闭输出流
    
    streamProgress - 进度显示接口，通过实现此接口显示下载进度
    
    返回:
    
    写出bytes数
    
    从以下版本开始:
    
    3.3.2
  - write
```
public File write(String targetFileOrDir)
```
    将响应内容写出到文件
    
    参数:
    
    targetFileOrDir - 写出到的文件或目录的路径
    
    返回:
    
    写出的文件
  - write
```
public File write(File targetFileOrDir)
```
    将响应内容写出到文件
    异步模式下直接读取Http流写出，同步模式下将存储在内存中的响应内容写出
    写出后会关闭Http流（异步模式）
    
    参数:
    
    targetFileOrDir - 写出到的文件或目录
    
    返回:
    
    写出的文件
  - write
```
public File write(File targetFileOrDir,
                  StreamProgress streamProgress)
```
    将响应内容写出到文件-避免未完成的文件来自：https://gitee.com/dromara/hutool/pulls/407
    此方法原理是先在目标文件同级目录下创建临时文件，下载之，等下载完毕后重命名，避免因下载错误导致的文件不完整。
    
    参数:
    
    targetFileOrDir - 写出到的文件或目录
    
    streamProgress - 进度显示接口，通过实现此接口显示下载进度
    
    返回:
    
    写出的文件对象
  - write
```
public File write(File targetFileOrDir,
                  String tempFileSuffix,
                  StreamProgress streamProgress)
```
    将响应内容写出到文件-避免未完成的文件来自：https://gitee.com/dromara/hutool/pulls/407
    此方法原理是先在目标文件同级目录下创建临时文件，下载之，等下载完毕后重命名，避免因下载错误导致的文件不完整。
    
    参数:
    
    targetFileOrDir - 写出到的文件或目录
    
    tempFileSuffix - 临时文件后缀，默认".temp"
    
    streamProgress - 进度显示接口，通过实现此接口显示下载进度
    
    返回:
    
    写出的文件对象
    
    从以下版本开始:
    
    5.7.12
  - writeDirect
```
public File writeDirect(File targetFileOrDir,
                        String customParamName,
                        StreamProgress streamProgress)
```
    将响应内容直接写出到文件，目标为目录则从Content-Disposition中获取文件名
    
    参数:
    
    targetFileOrDir - 写出到的文件
    
    customParamName - 自定义的Content-Disposition中文件名的参数名
    
    streamProgress - 进度显示接口，通过实现此接口显示下载进度
    
    返回:
    
    写出的文件
  - close
```
public void close()
           throws IOException
```
    指定者:
    
    close 在接口中 Closeable
    
    指定者:
    
    close 在接口中 AutoCloseable
    
    抛出:
    
    IOException
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object

类 ResponseBody

构造器概要

方法概要

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

从接口继承的方法 org.dromara.hutool.http.client.body.HttpBody

构造器详细资料

ResponseBody

方法详细资料

getContentType

getStream

write

sync

getBytes

getString

write

write

write

write

write

writeDirect

close

toString