3hutool实战:IoUtil 流操作工具类(从流中读取内容)

Posted 小虚竹

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了3hutool实战:IoUtil 流操作工具类(从流中读取内容)相关的知识,希望对你有一定的参考价值。

技术活,该赏
关注+一键三连(点赞,评论,收藏)再看,养成好习惯

hutool实战(带你掌握里面的各种工具)目录


用途:IO工具类(从流中读取内容)

使用场景

IO工具类只是辅助流的读写,并不负责关闭流。原因是流可能被多次读写,读写关闭后容易造成问题。

(从流中读取内容)

(从流中读取内容)

(从流中读取内容)

项目引用

此博文的依据:hutool-5.6.5版本源码

        <dependency>
			<groupId>cn.hutool</groupId>
			<artifactId>hutool-core</artifactId>
			<version>5.6.5</version>
		</dependency>

方法摘要

方法描述
cn.hutool.core.io.IoUtil.readUtf8(java.io.InputStream)
从流中读取UTF8编码的内容
cn.hutool.core.io.IoUtil.read(java.io.InputStream, java.lang.String)
从流中读取内容,读取完成后关闭流
cn.hutool.core.io.IoUtil.read(java.io.InputStream, java.nio.charset.Charset)
从流中读取内容,读取完毕后并不关闭流
cn.hutool.core.io.IoUtil.read(java.io.InputStream)
从流中读取内容,读到输出流中,读取完毕后并不关闭流
cn.hutool.core.io.IoUtil.read(java.io.InputStream, boolean)
从流中读取内容,读到输出流中,读取完毕后并不关闭流
cn.hutool.core.io.IoUtil.read(java.io.Reader)
从Reader中读取String,读取完毕后关闭Reader
cn.hutool.core.io.IoUtil.read(java.io.Reader, boolean)
从{@link Reader}中读取String
cn.hutool.core.io.IoUtil.readBytes(java.io.InputStream)
从流中读取bytes,读取完毕后关闭流
cn.hutool.core.io.IoUtil.readBytes(java.io.InputStream, boolean)
从流中读取bytes
cn.hutool.core.io.IoUtil.readBytes(java.io.InputStream, int)
读取指定长度的byte数组,不关闭流
cn.hutool.core.io.IoUtil.readHex(java.io.InputStream, int, boolean)
读取16进制字符串
cn.hutool.core.io.IoUtil.readHex28Upper(java.io.InputStream)
从流中读取前28个byte并转换为16进制,字母部分使用大写
cn.hutool.core.io.IoUtil.readHex28Lower(java.io.InputStream)
从流中读取前28个byte并转换为16进制,字母部分使用小写
cn.hutool.core.io.IoUtil.readObj(java.io.InputStream)
从流中读取对象,即对象的反序列化

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

cn.hutool.core.io.IoUtil.readObj(java.io.InputStream, java.lang.Class)
从流中读取对象,即对象的反序列化,读取后不关闭流

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

cn.hutool.core.io.IoUtil.readObj(cn.hutool.core.io.ValidateObjectInputStream, java.lang.Class)
从流中读取对象,即对象的反序列化,读取后不关闭流

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

cn.hutool.core.io.IoUtil.readUtf8Lines(java.io.InputStream, T)
从流中读取内容,使用UTF-8编码
cn.hutool.core.io.IoUtil.readLines(java.io.InputStream, java.lang.String, T)
从流中读取内容
cn.hutool.core.io.IoUtil.readLines(java.io.InputStream, java.nio.charset.Charset, T)
从流中读取内容
cn.hutool.core.io.IoUtil.readLines(java.io.Reader, T)
从Reader中读取内容
cn.hutool.core.io.IoUtil.readUtf8Lines(java.io.InputStream, cn.hutool.core.io.LineHandler)
按行读取UTF-8编码数据,针对每行的数据做处理
cn.hutool.core.io.IoUtil.readLines(java.io.InputStream, java.nio.charset.Charset, cn.hutool.core.io.LineHandler)
按行读取数据,针对每行的数据做处理
cn.hutool.core.io.IoUtil.readLines(java.io.Reader, cn.hutool.core.io.LineHandler)
按行读取数据,针对每行的数据做处理<br> {@link Reader}自带编码定义,因此读取数据的编码跟随其编码。

方法明细

方法名称:cn.hutool.core.io.IoUtil.readUtf8(java.io.InputStream)

方法描述

从流中读取UTF8编码的内容

支持版本及以上

5.4.4

参数描述:

参数名描述
InputStream in
in 输入流

返回值:

内容

参考案例:

	File src = new File("C:\\\\Users\\\\Administrator\\\\Desktop\\\\xuzhu/copyTest1.txt") ;
		InputStream input =  null;
		try {
			//创建流
			input =  new FileInputStream(src);
			String str = IoUtil.readUtf8(input);
			System.out.println(str);
		} catch (IOException e) {
			//抛出一个运行时异常(直接停止掉程序)
			throw new RuntimeException("运行时异常",e);
		} finally {
			try {
				//如果是空的 说明流创建失败 失败了不需要关闭
				if (input != null) {
					input.close();
				}
			} catch (Exception e) {
				//关闭资源失败 停止程序
				throw new RuntimeException("关闭资源失败");
			}
		}

在这里插入图片描述

源码解析:

链接:待补充

方法明细

方法名称:cn.hutool.core.io.IoUtil.read(java.io.InputStream, java.lang.String)

方法描述

从流中读取内容,读取完成后关闭流

支持版本及以上

参数描述:

参数名描述
InputStream in
in 输入流
String charsetName
charsetName 字符集

返回值:

内容

参考案例:

		File src = new File("C:\\\\Users\\\\Administrator\\\\Desktop\\\\xuzhu/copyTest1.txt") ;
		InputStream input =  null;
		try {
			//创建流
			input =  new FileInputStream(src);
			String str = IoUtil.read(input,"UTF-8");
			System.out.println(str);
		} catch (IOException e) {
			//抛出一个运行时异常(直接停止掉程序)
			throw new RuntimeException("运行时异常",e);
		} finally {
			try {
				//如果是空的 说明流创建失败 失败了不需要关闭
				if (input != null) {
					input.close();
				}
			} catch (Exception e) {
				//关闭资源失败 停止程序
				throw new RuntimeException("关闭资源失败");
			}
		}

源码解析:

链接:待补充

方法明细

方法名称:cn.hutool.core.io.IoUtil.read(java.io.InputStream, java.nio.charset.Charset)

方法描述

从流中读取内容,读取完毕后并不关闭流

支持版本及以上

参数描述:

参数名描述
InputStream in
in 输入流,读取完毕后并不关闭流
Charset charset
charset 字符集

返回值:

内容

参考案例:

		File src = new File("C:\\\\Users\\\\Administrator\\\\Desktop\\\\xuzhu/copyTest1.txt") ;
		InputStream input =  null;
		try {
			//创建流
			input =  new FileInputStream(src);
			String str = IoUtil.read(input,CharsetUtil.CHARSET_UTF_8);
			System.out.println(str);
		} catch (IOException e) {
			//抛出一个运行时异常(直接停止掉程序)
			throw new RuntimeException("运行时异常",e);
		} finally {
			try {
				//如果是空的 说明流创建失败 失败了不需要关闭
				if (input != null) {
					input.close();
				}
			} catch (Exception e) {
				//关闭资源失败 停止程序
				throw new RuntimeException("关闭资源失败");
			}
		}

源码解析:

链接:待补充

方法明细

方法名称:cn.hutool.core.io.IoUtil.read(java.io.InputStream)

方法描述

从流中读取内容,读到输出流中,读取完毕后并不关闭流

支持版本及以上

参数描述:

参数名描述
InputStream in
in 输入流

返回值:

输出流

参考案例:

		File src = new File("C:\\\\Users\\\\Administrator\\\\Desktop\\\\xuzhu/copyTest1.txt") ;
		InputStream input =  null;
		try {
			//创建流
			input =  new FileInputStream(src);
			//这种设计避免重新分配内存块而是分配新增的缓冲区,缓冲区不会被GC,数据也不会被拷贝到其他缓冲区。
			FastByteArrayOutputStream str = IoUtil.read(input);
			System.out.println(str.toString());
		} catch (IOException e) {
			//抛出一个运行时异常(直接停止掉程序)
			throw new RuntimeException("运行时异常",e);
		} finally {
			try {
				//如果是空的 说明流创建失败 失败了不需要关闭
				if (input != null) {
					input.close();
				}
			} catch (Exception e) {
				//关闭资源失败 停止程序
				throw new RuntimeException("关闭资源失败");
			}
		}

源码解析:

链接:待补充

方法明细

方法名称:cn.hutool.core.io.IoUtil.read(java.io.InputStream, boolean)

方法描述

从流中读取内容,读到输出流中,读取完毕后并不关闭流

支持版本及以上

5.5.3

参数描述:

参数名描述
InputStream in
in 输入流
boolean isClose
isClose 读取完毕后是否关闭流

返回值:

输出流

参考案例:

		File src = new File("C:\\\\Users\\\\Administrator\\\\Desktop\\\\xuzhu/copyTest1.txt") ;
		InputStream input =  null;
		try {
			//创建流
			input =  new FileInputStream(src);
			//这种设计避免重新分配内存块而是分配新增的缓冲区,缓冲区不会被GC,数据也不会被拷贝到其他缓冲区。
			FastByteArrayOutputStream str = IoUtil.read(input,false);//读取完毕后是否关闭流
			System.out.println(str.toString());
		} catch (IOException e) {
			//抛出一个运行时异常(直接停止掉程序)
			throw new RuntimeException("运行时异常",e);
		} finally {
			try {
				//如果是空的 说明流创建失败 失败了不需要关闭
				if (input != null) {
					input.close();
				}
			} catch (Exception e) {
				//关闭资源失败 停止程序
				throw new RuntimeException("关闭资源失败");
			}
		}

源码解析:

链接:待补充

方法明细

方法名称:cn.hutool.core.io.IoUtil.read(java.io.Reader)

方法描述

从Reader中读取String,读取完毕后关闭Reader

支持版本及以上

参数描述:

参数名描述
Reader reader
reader Reader

返回值:

String

参考案例:

		File src = new File("C:\\\\Users\\\\Administrator\\\\Desktop\\\\xuzhu/copyTest1.txt") ;
		FileReader fr =  null;
		try {
			//创建流
			fr = new FileReader(src);
			//从Reader中读取String,读取完毕后关闭Reader
			String str = IoUtil.read(fr);
			System.out.println(str);
		} catch (IOException e) {
			//抛出一个运行时异常(直接停止掉程序)
			throw new RuntimeException("运行时异常",e);
		} finally {
		}

源码解析:

链接:待补充

方法明细

方法名称:cn.hutool.core.io.IoUtil.read(java.io.Reader, boolean)

方法描述

从{@link Reader}中读取String

支持版本及以上

参数描述:

参数名描述
Reader reader
reader {@link Reader}
boolean isClose
isClose 是否关闭{@link Reader}

返回值:

String

参考案例:

		File src = new File("C:\\\\Users\\\\Administrator\\\\Desktop\\\\xuzhu/copyTest1.txt") ;
		FileReader fr =  null;
		try {
			//创建流
			fr = new FileReader(src);
			//从Reader中读取String,读取完毕后关闭Reader
			String str = IoUtil.read(fr,false);//是否关闭Reader
			System.out.println(str);
		} catch (IOException e) {
			//抛出一个运行时异常(直接停止掉程序)
			throw new RuntimeException("运行时异常",e);
		} finally {
			try {
				//如果是空的 说明流创建失败 失败了不需要关闭
				if (fr != null) {
					fr.close();
				}
			} catch (Exception e) {
				//关闭资源失败 停止程序
				throw new RuntimeException("关闭资源失败");
			}
		}

源码解析:

链接:待补充

方法明细

方法名称:cn.hutool.core.io.IoUtil.readBytes(java.io.InputStream)

方法描述

从流中读取bytes,读取完毕后关闭流

支持版本及以上

参数描述:

参数名描述
InputStream in
in {@link InputStream}

返回值:

bytes

参考案例:

		final byte[] bytes = IoUtil.readBytes(ResourceUtil.getStream("hutool.jpg"));
		Assert.assertEquals(22807, bytes.length);

源码解析:

链接:待补充

方法明细

方法名称:cn.hutool.core.io.IoUtil.readBytes(java.io.InputStream, boolean)

方法描述

从流中读取bytes

支持版本及以上

5.0.4

参数描述:

参数名描述
InputStream in
in {@link InputStream}
boolean isClose
isClose 是否关闭输入流

返回值:

bytes

参考案例:

		//这个文件3KB
		File src = new File("C:\\\\Users\\\\Administrator\\\\Desktop\\\\xuzhu/copyTest1.txt") ;
		InputStream input =  null;
		try {
			//创建流
			input =  new FileInputStream(src);
			final byte[] bytes = IoUtil.readBytes(input,true);
			System.out.println(bytes.length);
			Assert.assertEquals(3011, bytes.length);
		} catch (IOException e) {
			//抛出一个运行时异常(直接停止掉程序)
			throw new RuntimeException("运行时异常",e);
		} finally {
		}

源码解析:

链接:待补充

方法明细

方法名称:cn.hutool.core.io.IoUtil.readBytes(java.io.InputStream, int)

方法描述

读取指定长度的byte数组,不关闭流

支持版本及以上

参数描述:

参数名描述
InputStream in
in {@link InputStream},为null返回null
int length
length 长度,小于等于0返回空byte数组

返回值:

bytes

参考案例:

		//这个文件3KB
		File src = new File("C:\\\\Users\\\\Administrator\\\\Desktop\\\\xuzhu/copyTest1.txt") ;
		InputStream input =  null;
		try {
			//创建流
			input =  new FileInputStream(src);
			//读取指定长度的byte数组,不关闭流
			final byte[] bytes = IoUtil.readBytes(input,1000);
			String string = new String(bytes);
			System.out.println(string);
			Assert.assertEquals(1000, bytes.length);
		} catch (IOException e) {
			//抛出一个运行时异常(直接停止掉程序)
			throw new RuntimeException("运行时异常",e);
		} finally {
			try {
				//如果是空的 说明流创建失败 失败了不需要关闭
				if (input != null) {
					input.close();
				}
			} catch (Exception e) {
				//关闭资源失败 停止程序
				throw new RuntimeException("关闭资源失败");
			}
		}

在这里插入图片描述

源码解析:

链接:待补充

方法明细

方法名称:cn.hutool.core.io.IoUtil.readHex(java.io.InputStream, int, boolean)

方法描述

读取16进制字符串

支持版本及以上

参数描述:

参数名描述
InputStream in
in {@link InputStream}
int length
length 长度
boolean toLowerCase
toLowerCase true 传换成小写格式 , false 传换成大写格式

返回值:

16进制字符串

参考案例:

//这个文件3KB
		File src = new File("C:\\\\Users\\\\Administrator\\\\Desktop\\\\xuzhu/copyTest1.txt") ;
		InputStream input =  null;
		try {
			//创建流
			input =  new FileInputStream(src);
			//读取指定长度的byte数组,不关闭流
			boolean toLowerCase = false;
			String readHex = IoUtil.readHex(input,1000,toLowerCase);
			System.out.println(readHex);
			System.out.println("--------------------");
			System.out.println(HexUtil.decodeHexStr(readHex));
		} catch (IOException e) {
			//抛出一个运行时异常(直接停止掉程序)
			throw new RuntimeException("运行时异常",e);
		} finally {
			try {
				//如果是空的 说明流创建失败 失败了不需要关闭
				if (input != null) {
					input.close();
				}
			} catch (Exception e) {
				//关闭资源失败 停止程序
				throw new RuntimeException("关闭资源失败");
			}
		}

在这里插入图片描述

源码解析:

链接:待补充

方法明细

方法名称:cn.hutool.core.io.IoUtil.readHex28Upper(java.io.InputStream)

方法描述

从流中读取前28个byte并转换为16进制,字母部分使用大写

支持版本及以上

参数描述:

参数名描述
InputStream in
in {@link InputStream}

返回值:

16进制字符串

参考案例:

		//这个文件3KB
		File src = new File("C:\\\\Users\\\\Administrator\\\\Desktop\\\\xuzhu/copyTest1.txt") ;
		InputStream input =  null;
		try {
			//创建流
			input =  new FileInputStream(src);
			//读取指定长度的byte数组,不关闭流
			//从流中读取前28个byte并转换为16进制,字母部分使用大写
			String readHex = IoUtil.readHex28Upper(input);
			System.out.println(readHex);
			System.out.println("--------------------");
			以上是关于3hutool实战:IoUtil 流操作工具类(从流中读取内容)的主要内容,如果未能解决你的问题,请参考以下文章

4hutool实战:IoUtil 流操作工具类(toStream转为流)

4hutool实战:IoUtil 流操作工具类(toStream转为流)

6hutool实战:IoUtil 流操作工具类(流的常用操作)

1hutool实战:IoUtil 流操作工具类(copy拷贝操作)

1hutool实战:IoUtil 流操作工具类(copy拷贝操作)

6hutool实战:IoUtil 流操作工具类(流的常用操作)