6hutool实战:IoUtil 流操作工具类（流的常用操作）

技术活，该赏
关注+一键三连（点赞，评论，收藏），养成好习惯

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

用途：IO工具类（流的常用操作）

使用场景

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

包含但不限于：flush,close,对比两个流内容，计算流的校验码和返回行遍历器等。

项目引用

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

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

方法摘要

LineIterator it = null; try {   it = IoUtil.lineIter(reader);   while (it.hasNext()) {    String line = it.nextLine();    // do something with line   } } finally {     it.close(); }

LineIterator it = null; try {   it = IoUtil.lineIter(in, CharsetUtil.CHARSET_UTF_8);  while (it.hasNext()) {    String line = it.nextLine();    // do something with line   } } finally {     it.close(); }

方法明细

方法名称:cn.hutool.core.io.IoUtil.flush(java.io.Flushable)

方法描述

从缓存中刷出数据

支持版本及以上

4.2.2

参数描述:

返回值:

参考案例:

//传统的写法
    File dest = new File("C:\\Users\\Administrator\\Desktop\\xuzhu/flushTest.txt") ;
    FileOutputStream outputStream = null;
    OutputStreamWriter outputStreamWriter = null;
    try {
      //创建流
      outputStream = new FileOutputStream(dest);
      //新new OutputStreamWriter对象，记得关闭回收
      outputStreamWriter = IoUtil.getUtf8Writer(outputStream);
      String content = "1hello 小虚竹\n2hello 小虚竹";
      int c;
      for (int i = 0; i < content.length(); i++) {
        c = content.charAt(i);
        outputStreamWriter.write((char) c);

      }
      outputStreamWriter.flush();
    } catch (IOException e) {
      //抛出一个运行时异常(直接停止掉程序)
      throw new RuntimeException("运行时异常",e);
    } finally {
      try {
        //如果是空的 说明流创建失败 失败了不需要关闭
        if (outputStream != null) {
          outputStream.close();
        }
      } catch (Exception e) {
        //关闭资源失败 停止程序
        throw new RuntimeException("关闭资源失败");
      }finally {
        try {
          if (outputStreamWriter != null) {
            outputStreamWriter.close();
          }
        } catch (Exception e) {
          throw new RuntimeException("关闭资源失败");
        }
      }
    }

    //使用IoUtil.flush的写法
        File dest = new File("C:\\Users\\Administrator\\Desktop\\xuzhu/flushTest.txt") ;
    FileOutputStream outputStream = null;
    OutputStreamWriter outputStreamWriter = null;
    try {
      //创建流
      outputStream = new FileOutputStream(dest);
      //新new OutputStreamWriter对象，记得关闭回收
      outputStreamWriter = IoUtil.getUtf8Writer(outputStream);
      String content = "1hello 小虚竹\n2hello 小虚竹";
      int c;
      for (int i = 0; i < content.length(); i++) {
        c = content.charAt(i);
        outputStreamWriter.write((char) c);

      }
      IoUtil.flush(outputStreamWriter);
    } catch (IOException e) {
      //抛出一个运行时异常(直接停止掉程序)
      throw new RuntimeException("运行时异常",e);
    } finally {
      IoUtil.close(outputStream);
      IoUtil.close(outputStreamWriter);
    }

源码解析：

链接：待补充

方法明细

方法名称:cn.hutool.core.io.IoUtil.close(java.io.Closeable)

方法描述

关闭

关闭失败不会抛出异常

支持版本及以上

参数描述:

返回值:

参考案例:

//传统的写法
    File dest = new File("C:\\Users\\Administrator\\Desktop\\xuzhu/flushTest.txt") ;
    FileOutputStream outputStream = null;
    OutputStreamWriter outputStreamWriter = null;
    try {
      //创建流
      outputStream = new FileOutputStream(dest);
      //新new OutputStreamWriter对象，记得关闭回收
      outputStreamWriter = IoUtil.getUtf8Writer(outputStream);
      String content = "1hello 小虚竹\n2hello 小虚竹";
      int c;
      for (int i = 0; i < content.length(); i++) {
        c = content.charAt(i);
        outputStreamWriter.write((char) c);

      }
      outputStreamWriter.flush();
    } catch (IOException e) {
      //抛出一个运行时异常(直接停止掉程序)
      throw new RuntimeException("运行时异常",e);
    } finally {
      try {
        //如果是空的 说明流创建失败 失败了不需要关闭
        if (outputStream != null) {
          outputStream.close();
        }
      } catch (Exception e) {
        //关闭资源失败 停止程序
        throw new RuntimeException("关闭资源失败");
      }finally {
        try {
          if (outputStreamWriter != null) {
            outputStreamWriter.close();
          }
        } catch (Exception e) {
          throw new RuntimeException("关闭资源失败");
        }
      }
    }

    //使用IoUtil.close的写法
        File dest = new File("C:\\Users\\Administrator\\Desktop\\xuzhu/flushTest.txt") ;
    FileOutputStream outputStream = null;
    OutputStreamWriter outputStreamWriter = null;
    try {
      //创建流
      outputStream = new FileOutputStream(dest);
      //新new OutputStreamWriter对象，记得关闭回收
      outputStreamWriter = IoUtil.getUtf8Writer(outputStream);
      String content = "1hello 小虚竹\n2hello 小虚竹";
      int c;
      for (int i = 0; i < content.length(); i++) {
        c = content.charAt(i);
        outputStreamWriter.write((char) c);

      }
      IoUtil.flush(outputStreamWriter);
    } catch (IOException e) {
      //抛出一个运行时异常(直接停止掉程序)
      throw new RuntimeException("运行时异常",e);
    } finally {
      IoUtil.close(outputStream);
      IoUtil.close(outputStreamWriter);
    }

源码解析：

链接：待补充

方法明细

方法名称:cn.hutool.core.io.IoUtil.closeIfPosible(java.lang.Object)

方法描述

尝试关闭指定对象<br>

判断对象如果实现了{@link AutoCloseable}，则调用之

支持版本及以上

4.3.2

参数描述:

返回值:

参考案例:

public class AutoCloseableObject implements AutoCloseable{
  @Override
  public void close() throws Exception {
    System.out.println("--close AutoCloseableObject--");
  }

  public void demo(){
    System.out.println("这是AutoCloseableObject对象里的demo方法");
    //1.7之后，只要实现了AutoCloseable接口
    try (FileInputStream fileInputStream = new FileInputStream("C:\\Users\\Administrator\\Desktop\\xuzhu/flushTest.txt")) {
      System.out.println("--fileInputStream--");
    } catch (FileNotFoundException e) {
      e.printStackTrace();
    } catch (IOException e) {
      e.printStackTrace();
    }


  }
}
    //----------------------------------
    //先了解下AutoCloseable的工作原理
    //1、AutoCloseable jdk1.7+才支持
    //2、try方法可以管理多个资源，用;号隔开
    //3、管理的资源一定要实现AutoCloseable接口
    try(AutoCloseableObject object = new AutoCloseableObject())  {
      System.out.println("--执行closeIfPosibleTest方法--");
      System.out.println("--demo--");
      object.demo();
    }catch (Exception e){
      System.out.println("--exception--");
    }finally {
      System.out.println("--finally--");
    }

参考案例2:

try (FileInputStream fileInputStream = new FileInputStream("C:\\Users\\Administrator\\Desktop\\xuzhu/flushTest.txt")) {
      System.out.println("--fileInputStream--");
      IoUtil.closeIfPosible(fileInputStream);
      System.out.println(fileInputStream);
    }catch (Exception e){
      System.out.println("--exception--");
    }finally {
      System.out.println("--finally--");
    }

源码解析：

链接：待补充

方法明细

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

方法描述

对比两个流内容是否相同<br>

内部会转换流为 {@link BufferedInputStream}

支持版本及以上

4.0.6

参数描述:

返回值:

两个流的内容一致返回true，否则false

参考案例1:

File src = new File("C:\\Users\\Administrator\\Desktop\\xuzhu/copyTest1.txt") ;
    File dest = new File("C:\\Users\\Administrator\\Desktop\\xuzhu/toCopyTest1.txt") ;
    try (FileInputStream srcFileInputStream = new FileInputStream(src);
       FileInputStream destFileInputStream = new FileInputStream(dest)) {
      Assert.assertEquals(Boolean.TRUE, IoUtil.contentEquals(srcFileInputStream,destFileInputStream));
    }catch (Exception e){
      System.out.println("--exception--");
    }finally {
      System.out.println("--finally--");
    }

参考案例2:

File src = new File("C:\\Users\\Administrator\\Desktop\\xuzhu/copyTest1.txt") ;
    File flushFile = new File("C:\\Users\\Administrator\\Desktop\\xuzhu/flushTest.txt") ;
    try (FileInputStream srcFileInputStream = new FileInputStream(src);
       FileInputStream flushFileInputStream = new FileInputStream(flushFile)) {
      Assert.assertEquals(Boolean.FALSE, IoUtil.contentEquals(srcFileInputStream,flushFileInputStream));
    }catch (Exception e){
      System.out.println("--exception--");
    }finally {
      System.out.println("--finally--");
    }

源码解析：

链接：待补充

方法明细

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

方法描述

对比两个Reader的内容是否一致<br>

内部会转换流为 {@link BufferedInputStream}

支持版本及以上

4.0.6

参数描述:

返回值:

两个流的内容一致返回true，否则false

参考案例1:

File src = new File("C:\\Users\\Administrator\\Desktop\\xuzhu/copyTest1.txt") ;
    File dest = new File("C:\\Users\\Administrator\\Desktop\\xuzhu/toCopyTest1.txt") ;
    try (FileReader srcFileFileReader = new FileReader(src);
       FileReader destFileFileReader = new FileReader(dest)) {
      Assert.assertEquals(Boolean.TRUE, IoUtil.contentEquals(srcFileFileReader,destFileFileReader));
    }catch (Exception e){
      System.out.println("--exception--");
    }finally {
      System.out.println("--finally--");
    }

参考案例2:

File src = new File("C:\\Users\\Administrator\\Desktop\\xuzhu/copyTest1.txt") ;
    File flushFile = new File("C:\\Users\\Administrator\\Desktop\\xuzhu/flushTest.txt") ;
    try (FileReader srcFileFileReader = new FileReader(src);
       FileReader flushFileFileReader = new FileReader(flushFile)) {
      Assert.assertEquals(Boolean.FALSE, IoUtil.contentEquals(srcFileFileReader,flushFileFileReader));
    }catch (Exception e){
      System.out.println("--exception--");
    }finally {
      System.out.println("--finally--");
    }

源码解析：

链接：待补充

方法明细

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

方法描述

对比两个流内容是否相同，忽略EOL字符<br>

内部会转换流为 {@link BufferedInputStream}

支持版本及以上

4.0.6

参数描述:

返回值:

两个流的内容一致返回true，否则false

参考案例1:

//对比两个流内容是否相同，忽略EOL字符 像\n,\r 就是EOL字符
    File src = new File("C:\\Users\\Administrator\\Desktop\\xuzhu/contentEqualsIgnoreEOLTest1.txt") ;
    File dest = new File("C:\\Users\\Administrator\\Desktop\\xuzhu/toContentEqualsIgnoreEOLTest1.txt") ;
    try (FileReader srcFileFileReader = new FileReader(src);
       FileReader destFileFileReader = new FileReader(dest)) {
      Assert.assertEquals(Boolean.TRUE, IoUtil.contentEqualsIgnoreEOL(srcFileFileReader,destFileFileReader));
    }catch (Exception e){
      System.out.println("--exception--");
    }finally {
      System.out.println("--finally--");
    }

参考案例2:

//对比两个流内容是否相同，忽略EOL字符 像\n,\r 就是EOL字符
    File src = new File("C:\\Users\\Administrator\\Desktop\\xuzhu/contentEqualsIgnoreEOLTest1.txt") ;
    File flushFile = new File("C:\\Users\\Administrator\\Desktop\\xuzhu/contentEqualsIgnoreEOLTest2.txt") ;
    try (FileReader srcFileFileReader = new FileReader(src);
       FileReader flushFileFileReader = new FileReader(flushFile)) {
      Assert.assertEquals(Boolean.TRUE, IoUtil.contentEqualsIgnoreEOL(srcFileFileReader,flushFileFileReader));
    }catch (Exception e){
      System.out.println("--exception--");
    }finally {
      System.out.println("--finally--");
    }

源码解析：

链接：待补充

方法明细

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

方法描述

计算流CRC32校验码，计算后关闭流

（CRC32是什么：CRC是一个数值，该数值被用于校验数据的正确性。类似的校验有MD5校验码）

支持版本及以上

4.0.6

参数描述:

返回值:

CRC32值

参考案例:

File src = new File("C:\\Users\\Administrator\\Desktop\\xuzhu/contentEqualsIgnoreEOLTest1.txt") ;
    try {
      FileInputStream srcFileInputStream = new FileInputStream(src);
      //计算流的校验码，计算后关闭流
      System.out.println( IoUtil.checksumCRC32(srcFileInputStream));
    }catch (Exception e){
      System.out.println("--exception--");
    }finally {
      System.out.println("--finally--");
    }

源码解析：

链接：待补充

方法明细

方法名称:cn.hutool.core.io.IoUtil.checksum(java.io.InputStream, java.util.zip.Checksum)

方法描述

计算流的校验码，计算后关闭流

支持版本及以上

4.0.10

参数描述:

返回值:

Checksum

参考案例:

File src = new File("C:\\Users\\Administrator\\Desktop\\xuzhu/contentEqualsIgnoreEOLTest1.txt") ;
    try {
      FileInputStream srcFileInputStream = new FileInputStream(src);
      //计算流的校验码，计算后关闭流,支持可选校验码 实现Checksum
      System.out.println( IoUtil.checksum(srcFileInputStream,new CRC32()).getValue());
    }catch (Exception e){
      System.out.println("--exception--");
    }finally {
      System.out.println("--finally--");
    }

源码解析：

链接：待补充

方法明细

方法名称:cn.hutool.core.io.IoUtil.checksumValue(java.io.InputStream, java.util.zip.Checksum)

方法描述

计算流的校验码，计算后关闭流

支持版本及以上

5.4.0

参数描述:

返回值:

Checksum

参考案例:

File src = new File("C:\\Users\\Administrator\\Desktop\\xuzhu/contentEqualsIgnoreEOLTest1.txt") ;
    try {
      FileInputStream srcFileInputStream = new FileInputStream(src);
      //计算流的校验码，计算后关闭流,支持可选校验码 实现Checksum
      System.out.println( IoUtil.checksumValue(srcFileInputStream,new CRC32()));
    }catch (Exception e){
      System.out.println("--exception--");
    }finally {
      System.out.println("--finally--");
    }

源码解析：

链接：待补充

方法明细

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

方法描述

返回行遍历器

LineIterator it = null;
 try {
  it = IoUtil.lineIter(reader);
  while (it.hasNext()) {
    String line = it.nextLine();
    // do something with line
  }
 } finally {
    it.close();
 }

支持版本及以上

5.6.1

参数描述:

返回值:

{@link LineIter}

参考案例:

File src = new File("C:\\Users\\Administrator\\Desktop\\xuzhu/contentEqualsIgnoreEOLTest1.txt") ;
    LineIter it = null;
    try (FileReader srcFileFileReader = new FileReader(src)) {
      //返回行遍历器
      it = IoUtil.lineIter(srcFileFileReader);
      while (it.hasNext()) {
      String line = it.nextLine();
        System.out.println("行遍历器行数据："+line);
      }
    }catch (Exception e){
      System.out.println("--exception--");
    }finally {
      System.out.println("--finally--");
      it.close();
    }

源码解析：

链接：待补充

方法明细

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

方法描述

返回行遍历器

LineIterator it = null;
 try {
  it = IoUtil.lineIter(in, CharsetUtil.CHARSET_UTF_8);
  while (it.hasNext()) {
    String line = it.nextLine();
    // do something with line
  }
 } finally {
    it.close();
 }

支持版本及以上

5.6.1

参数描述:

返回值:

{@link LineIter}

参考案例:

File src = new File("C:\\Users\\Administrator\\Desktop\\xuzhu/contentEqualsIgnoreEOLTest1.txt") ;
    LineIter it = null;
    try (FileInputStream srcFileInputStream = new FileInputStream(src);) {
      //返回行遍历器
      it = IoUtil.lineIter(srcFileInputStream,CharsetUtil.CHARSET_UTF_8);
      while (it.hasNext()) {
        String line = it.nextLine();
        System.out.println("行遍历器行数据："+line);
      }
    }catch (Exception e){
      System.out.println("--exception--");
    }finally {
      System.out.println("--finally--");
      it.close();
    }

源码解析：

链接：待补充