org.dromara.hutool.core.io.stream

Class StreamReader

java.lang.Object

org.dromara.hutool.core.io.stream.StreamReader

public class StreamReader
extends Object

InputStream读取器

Author:

looly

Constructor Summary

Constructors

Constructor and Description
StreamReader(InputStream in, boolean closeAfterRead) 构造

Method Summary

Modifier and Type	Method and Description
static StreamReader	of(InputStream in, boolean closeAfterRead) 创建读取器
FastByteArrayOutputStream	read() 从流中读取内容，读到输出流中，读取完毕后可选是否关闭流
FastByteArrayOutputStream	read(int limit) 从流中读取内容，读到输出流中，读取完毕后可选是否关闭流
byte[]	readBytes() 从流中读取bytes
byte[]	readBytes(int length) 读取指定长度的byte数组
<T> T	readObj(Class<?>... acceptClasses) 从流中读取对象，即对象的反序列化 注意！！！
FastByteArrayOutputStream	readTo(Predicate<Integer> predicate) 从流中读取内容，直到遇到给定token满足Predicate.test(Object)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StreamReader

public StreamReader(InputStream in,
                    boolean closeAfterRead)

构造

Parameters:

in - InputStream

closeAfterRead - 读取结束后是否关闭输入流

Method Detail

of

public static StreamReader of(InputStream in,
                              boolean closeAfterRead)

创建读取器

Parameters:

in - InputStream

closeAfterRead - 读取结束后是否关闭输入流

Returns:

StreamReader

readBytes

public byte[] readBytes()
                 throws IORuntimeException

从流中读取bytes

Returns:

bytes

Throws:

IORuntimeException - IO异常

readBytes

public byte[] readBytes(int length)
                 throws IORuntimeException

读取指定长度的byte数组

Parameters:

length - 长度，小于0表示读取全部

Returns:

bytes

Throws:

IORuntimeException - IO异常

read

public FastByteArrayOutputStream read()
                               throws IORuntimeException

从流中读取内容，读到输出流中，读取完毕后可选是否关闭流

Returns:

输出流

Throws:

IORuntimeException - IO异常

read

public FastByteArrayOutputStream read(int limit)
                               throws IORuntimeException

从流中读取内容，读到输出流中，读取完毕后可选是否关闭流

Parameters:

limit - 限制最大拷贝长度，-1表示无限制

Returns:

输出流

Throws:

IORuntimeException - IO异常

readTo

public FastByteArrayOutputStream readTo(Predicate<Integer> predicate)
                                 throws IORuntimeException

从流中读取内容，直到遇到给定token满足Predicate.test(Object)

Parameters:

predicate - 读取结束条件, Predicate.test(Object)返回true表示结束

Returns:

输出流

Throws:

IORuntimeException - IO异常

readObj

public <T> T readObj(Class<?>... acceptClasses)
              throws IORuntimeException,
                     HutoolException

从流中读取对象，即对象的反序列化

注意！！！ 此方法不会检查反序列化安全，可能存在反序列化漏洞风险！！！

此方法使用了ValidateObjectInputStream中的黑白名单方式过滤类，用于避免反序列化漏洞
通过构造ValidateObjectInputStream，调用ValidateObjectInputStream.accept(Class[]) 或者ValidateObjectInputStream.refuse(Class[])方法添加可以被序列化的类或者禁止序列化的类。

Type Parameters:

T - 读取对象的类型

Parameters:

acceptClasses - 读取对象类型

Returns:

输出流

Throws:

IORuntimeException - IO异常

HutoolException - ClassNotFoundException包装