org.dromara.hutool.http.client.body

Class ResponseBody

java.lang.Object

org.dromara.hutool.http.client.body.ResponseBody

All Implemented Interfaces:

Closeable, AutoCloseable, HttpBody

public class ResponseBody
extends Object
implements HttpBody, Closeable

响应体部分封装

Author:

looly

Constructor Summary

Constructors

Constructor and Description
ResponseBody(Response response, InputStream in) 构造，不读取响应体，忽略响应体EOF错误
ResponseBody(Response response, InputStream in, boolean isAsync, boolean isIgnoreEOFError) 构造

Method Summary

Modifier and Type	Method and Description
void	close()
long	contentLength() 获取写出字节长度，未知为-1
String	contentType() 获取Content-Type 根据实现不同，Content-Type可能包含编码信息，也可以不包含
byte[]	getBytes() 获取响应内容的bytes
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中获取文件名

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.body.HttpBody

contentType, writeClose

Constructor Detail

ResponseBody

public ResponseBody(Response response,
                    InputStream in)

构造，不读取响应体，忽略响应体EOF错误

Parameters:

response - 响应体

in - HTTP主体响应流

ResponseBody

public ResponseBody(Response response,
                    InputStream in,
                    boolean isAsync,
                    boolean isIgnoreEOFError)

构造

Parameters:

response - 响应体

in - HTTP主体响应流

isAsync - 是否异步模式

isIgnoreEOFError - 是否忽略EOF错误

Method Detail

contentType

public String contentType()

Description copied from interface: HttpBody

获取Content-Type
根据实现不同，Content-Type可能包含编码信息，也可以不包含

Specified by:

contentType in interface HttpBody

Returns:

Content-Type值

contentLength

public long contentLength()

Description copied from interface: HttpBody

获取写出字节长度，未知为-1

Specified by:

contentLength in interface HttpBody

Returns:

长度

getStream

public InputStream getStream()

Description copied from interface: HttpBody

获取body资源流

Specified by:

getStream in interface HttpBody

Returns:

InputStream

write

public void write(OutputStream out)

Description copied from interface: HttpBody

写出数据，不关闭流

Specified by:

write in interface HttpBody

Parameters:

out - out流

sync

public ResponseBody sync()

同步数据到内存，以bytes形式存储

Returns:

this

getBytes

public byte[] getBytes()

获取响应内容的bytes

Specified by:

getBytes in interface HttpBody

Returns:

响应内容bytes

getString

public String getString()

获取响应字符串，自动识别判断编码

Returns:

响应字符串

write

public long write(OutputStream out,
                  boolean isCloseOut,
                  StreamProgress streamProgress)

将响应内容写出到OutputStream
异步模式下直接读取Http流写出，同步模式下将存储在内存中的响应内容写出
写出后会关闭Http流（异步模式）

Parameters:

out - 写出的流

isCloseOut - 是否关闭输出流

streamProgress - 进度显示接口，通过实现此接口显示下载进度

Returns:

写出bytes数

Since:

3.3.2

write

public File write(String targetFileOrDir)

将响应内容写出到文件

Parameters:

targetFileOrDir - 写出到的文件或目录的路径

Returns:

写出的文件

write

public File write(File targetFileOrDir)

将响应内容写出到文件
异步模式下直接读取Http流写出，同步模式下将存储在内存中的响应内容写出
写出后会关闭Http流（异步模式）

Parameters:

targetFileOrDir - 写出到的文件或目录

Returns:

写出的文件

write

public File write(File targetFileOrDir,
                  StreamProgress streamProgress)

将响应内容写出到文件-避免未完成的文件 来自：https://gitee.com/dromara/hutool/pulls/407
此方法原理是先在目标文件同级目录下创建临时文件，下载之，等下载完毕后重命名，避免因下载错误导致的文件不完整。

Parameters:

targetFileOrDir - 写出到的文件或目录

streamProgress - 进度显示接口，通过实现此接口显示下载进度

Returns:

写出的文件对象

write

public File write(File targetFileOrDir,
                  String tempFileSuffix,
                  StreamProgress streamProgress)

将响应内容写出到文件-避免未完成的文件 来自：https://gitee.com/dromara/hutool/pulls/407
此方法原理是先在目标文件同级目录下创建临时文件，下载之，等下载完毕后重命名，避免因下载错误导致的文件不完整。

Parameters:

targetFileOrDir - 写出到的文件或目录

tempFileSuffix - 临时文件后缀，默认".temp"

streamProgress - 进度显示接口，通过实现此接口显示下载进度

Returns:

写出的文件对象

Since:

5.7.12

writeDirect

public File writeDirect(File targetFileOrDir,
                        String customParamName,
                        StreamProgress streamProgress)

将响应内容直接写出到文件，目标为目录则从Content-Disposition中获取文件名

Parameters:

targetFileOrDir - 写出到的文件

customParamName - 自定义的Content-Disposition中文件名的参数名

streamProgress - 进度显示接口，通过实现此接口显示下载进度

Returns:

写出的文件

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