Class IoUtil
java.lang.Object
com.sure.tool.io.IoUtil
IO 流工具类,参考 Hutool 的
IoUtil 设计。
English: Stream and reader/writer helpers for copying, reading and closing resources safely.
- Since:
- 0.1.0
- Author:
- suretool
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class懒加载行迭代器:IoUtil.LineIterator.next()时才读取下一行,可关闭底层流。 -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionstatic voidcloseQuietly(Closeable... closeables) 安静关闭可关闭资源,忽略关闭异常。static booleancontentEquals(InputStream in1, InputStream in2) 比较两个输入流内容是否一致。static booleancontentEqualsIgnoreEOL(Reader reader1, Reader reader2) 忽略行结束符(\r、\n、\r\n)比较两个字符流内容是否一致。static longcopy(File file, OutputStream out) 将文件内容写入输出流。static longcopy(InputStream in, File file) 将输入流内容写入文件(自动创建父目录)。static longcopy(InputStream in, OutputStream out) 复制输入流到输出流。static longcopy(InputStream in, OutputStream out, int bufferSize) 复制输入流到输出流。static longcopy(InputStream in, Writer writer, Charset charset) 输入流复制到字符流(按指定字符集解码),不关闭流。static longcopy(Reader reader, OutputStream out, Charset charset) 字符流复制到输出流(按指定字符集编码写出),不关闭流。static long复制字符流。static IoUtil.LineIteratorlineIterator(InputStream in, Charset charset) 按行读取的懒加载迭代器(字节流版),使用后应关闭返回的IoUtil.LineIterator。static IoUtil.LineIteratorlineIterator(Reader reader) 按行读取的懒加载迭代器(字符流版),使用后应关闭返回的IoUtil.LineIterator。static Stringread(InputStream in, Charset charset) 按指定字符集读取输入流为字符串。static byte[]readBytes(InputStream in) 读取输入流全部字节。static voidreadFully(InputStream in, byte[] buf, int off, int len) 精确读取指定长度的字节:必须读满len字节,否则抛IOException。readLines(InputStream in, Charset charset) 按指定字符集读取输入流为行列表。static intreadLines(InputStream in, Charset charset, Collection<String> lines) 追加式读取流内容并按行写入目标集合(适合大文件分块处理,避免一次性 OOM)。static StringreadUtf8(InputStream in) 按 UTF-8 读取输入流为字符串。按 UTF-8 读取输入流为行列表。static voidskipFully(InputStream in, long skip) 精确跳过指定字节数:不足则抛IOException。static BufferedInputStream将输入流包装为缓冲输入流(null安全)。static BufferedReadertoBufferedReader(Reader reader) 将字符流包装为缓冲字符流(null安全)。static longtoOutput(InputStream in, OutputStream out) 输入流转输出流(输出流关闭)。static String字符流全量读取为字符串(使用平台默认字符集解码)。static voidwrite(byte[] data, OutputStream out) 写入字节数组。static voidwrite(String content, OutputStream out, Charset charset) 按指定字符集写入字符串。static void按指定字符集写入字符串(通过 Writer)。static voidwriteLines(Collection<?> lines, OutputStream out, Charset charset) 逐行写出集合内容(每行末尾追加行分隔符)。static voidwriteUtf8(String content, OutputStream out) 按 UTF-8 写入字符串。
-
Field Details
-
DEFAULT_BUFFER_SIZE
public static final int DEFAULT_BUFFER_SIZE默认缓冲区大小- See Also:
-
-
Method Details
-
copy
复制输入流到输出流。- Parameters:
in- 输入流out- 输出流- Returns:
- 复制的字节数
- Throws:
IOException- IO 异常
-
copy
复制输入流到输出流。- Parameters:
in- 输入流out- 输出流bufferSize- 缓冲区大小- Returns:
- 复制的字节数
- Throws:
IOException- IO 异常
-
copy
复制字符流。- Parameters:
reader- 字符输入流writer- 字符输出流- Returns:
- 复制的字符数
- Throws:
IOException- IO 异常
-
readBytes
读取输入流全部字节。- Parameters:
in- 输入流- Returns:
- 字节数组
- Throws:
IOException- IO 异常
-
readUtf8
按 UTF-8 读取输入流为字符串。- Parameters:
in- 输入流- Returns:
- 字符串
- Throws:
IOException- IO 异常
-
read
按指定字符集读取输入流为字符串。- Parameters:
in- 输入流charset- 字符集- Returns:
- 字符串
- Throws:
IOException- IO 异常
-
readUtf8Lines
按 UTF-8 读取输入流为行列表。- Parameters:
in- 输入流- Returns:
- 行列表
- Throws:
IOException- IO 异常
-
readLines
按指定字符集读取输入流为行列表。- Parameters:
in- 输入流charset- 字符集- Returns:
- 行列表
- Throws:
IOException- IO 异常
-
write
写入字节数组。- Parameters:
data- 字节数组out- 输出流- Throws:
IOException- IO 异常
-
writeUtf8
按 UTF-8 写入字符串。- Parameters:
content- 字符串out- 输出流- Throws:
IOException- IO 异常
-
write
按指定字符集写入字符串。- Parameters:
content- 字符串out- 输出流charset- 字符集- Throws:
IOException- IO 异常
-
write
按指定字符集写入字符串(通过 Writer)。- Parameters:
content- 字符串writer- 字符输出流- Throws:
IOException- IO 异常
-
copy
将输入流内容写入文件(自动创建父目录)。- Parameters:
in- 输入流file- 目标文件- Returns:
- 写入字节数
- Throws:
IOException- IO 失败
-
copy
将文件内容写入输出流。- Parameters:
file- 源文件out- 输出流- Returns:
- 写入字节数
- Throws:
IOException- IO 失败
-
writeLines
public static void writeLines(Collection<?> lines, OutputStream out, Charset charset) throws IOException 逐行写出集合内容(每行末尾追加行分隔符)。- Parameters:
lines- 行集合(元素经String.valueOf(Object)转换,null 元素写出空行)out- 输出流charset- 字符集- Throws:
IOException- IO 失败
-
readLines
public static int readLines(InputStream in, Charset charset, Collection<String> lines) throws IOException 追加式读取流内容并按行写入目标集合(适合大文件分块处理,避免一次性 OOM)。- Parameters:
in- 输入流charset- 字符集lines- 目标集合(内容追加到末尾)- Returns:
- 读取行数
- Throws:
IOException- IO 失败
-
closeQuietly
安静关闭可关闭资源,忽略关闭异常。- Parameters:
closeables- 可关闭资源
-
contentEquals
比较两个输入流内容是否一致。- Parameters:
in1- 输入流 1in2- 输入流 2- Returns:
- 内容是否一致
- Throws:
IOException- IO 异常
-
toOutput
输入流转输出流(输出流关闭)。- Parameters:
in- 输入流out- 输出流- Returns:
- 复制的字节数
- Throws:
IOException- IO 异常
-
toBufferedInputStream
将输入流包装为缓冲输入流(null安全)。示例:
IoUtil.toBufferedInputStream(in)等价于new BufferedInputStream(in)。- Parameters:
in- 输入流,可为null- Returns:
- 缓冲输入流;
in为null返回null
-
toBufferedReader
将字符流包装为缓冲字符流(null安全)。示例:
IoUtil.toBufferedReader(reader)等价于new BufferedReader(reader)。- Parameters:
reader- 字符流,可为null- Returns:
- 缓冲字符流;
reader为null返回null
-
readFully
- Parameters:
in- 输入流buf- 目标数组off- 起始偏移len- 读取长度- Throws:
IOException- 读不满len字节或 IO 异常
-
skipFully
精确跳过指定字节数:不足则抛IOException。示例:
IoUtil.skipFully(in, 4)保证恰好跳过 4 字节。- Parameters:
in- 输入流skip- 待跳过字节数,非负- Throws:
IOException- 跳不足skip字节或 IO 异常
-
toString
字符流全量读取为字符串(使用平台默认字符集解码)。示例:
IoUtil.toString(reader)读取全部剩余字符。- Parameters:
reader- 字符流- Returns:
- 全部内容字符串
- Throws:
IOException- IO 异常
-
lineIterator
按行读取的懒加载迭代器(字符流版),使用后应关闭返回的IoUtil.LineIterator。示例:
try (var it = IoUtil.lineIterator(reader)) { ... }逐行消费。- Parameters:
reader- 字符流- Returns:
- 行迭代器
- Throws:
IOException- 包装行读取异常
-
lineIterator
按行读取的懒加载迭代器(字节流版),使用后应关闭返回的IoUtil.LineIterator。示例:
try (var it = IoUtil.lineIterator(in, StandardCharsets.UTF_8)) { ... }逐行消费。- Parameters:
in- 输入流charset- 字符集- Returns:
- 行迭代器
- Throws:
IOException- 包装行读取异常
-
contentEqualsIgnoreEOL
忽略行结束符(\r、\n、\r\n)比较两个字符流内容是否一致。示例:
IoUtil.contentEqualsIgnoreEOL(r1, r2)对"a\r\nb"与"a\nb"返回true。- Parameters:
reader1- 字符流 1reader2- 字符流 2- Returns:
- 忽略行结束符后内容是否一致
- Throws:
IOException- IO 异常
-
copy
字符流复制到输出流(按指定字符集编码写出),不关闭流。示例:
IoUtil.copy(reader, out, StandardCharsets.UTF_8)。- Parameters:
reader- 字符流out- 输出流charset- 写出字符集- Returns:
- 复制的字符数
- Throws:
IOException- IO 异常
-
copy
输入流复制到字符流(按指定字符集解码),不关闭流。示例:
IoUtil.copy(in, writer, StandardCharsets.UTF_8)。- Parameters:
in- 输入流writer- 字符流charset- 解码字符集- Returns:
- 写出的字符数
- Throws:
IOException- IO 异常
-