Commons IO -- IOUtils

关注

原创最新推荐文章于 2026-03-14 01:19:04 发布 1w 阅读 AI 写同款· GEO 优化 ›

java-Apache Commons IO Google的guava对Java的IO操作进行了一定封装，但是它更偏向于集合、并发和缓存，在实际项目中，我非常喜欢guava，同时我也非常喜欢Apache的一个工具包org.apache.commons.io，这两个工具包提供非常强大的工具能力，能够简化代码逻辑，提高开发效率和质量，是每个Java程序员都应该掌握的工具包.Apache Commons IO是Apache基金会创建并维护的Java函阅读详情

IOUtils是apache基金会下面的一个子项目，提供了对于IO流操作的进一步封装，让我们可以更加方便的对IO流进行操作。

       IOUtils的下载地址是：

         http://commons.apache.org/proper/commons-io/download_io.cgi

         IOUtils的api帮助文档地址：

         http://commons.apache.org/proper/commons-io/apidocs/org/apache/commons/io/IOUtils.html

打开IOUtils的api文档，我们发现他的方法大部分都是重载的。所以，我们理解他的方法并不是难事。因此，对于他方法的用法总结如下：

buffer方法：将传入的流进行包装，变成缓冲流。并可以通过参数指定缓冲大小。

closeQueitly方法：关闭流

contentEquals方法：比较两个流中的内容是否一致

copy方法：将输入流中的内容拷贝到输出流中，并可以指定字符编码。

copyLarge方法：将输入流中的内容拷贝到输出流中，适合大于2G内容的拷贝。

lineIterator方法：返回可以迭代每一行内容的迭代器

read方法：将输入流中的部分内容读入到字节数组中

readFully方法：将输入流中的所有内容读入到字节数组中

readLine方法：读入输入流内容中的一行

toBufferedInputStream，toBufferedReader：将输入转为带缓存的输入流

toByteArray，toCharArray：将输入流的内容转为字节数组、字符数组。

toString：将输入流或数组中的内容转化为字符串

write方法：向流里面写入内容

writeLine方法：向流里面写入一行内容

`IOUtils`流操作的相关方法

copy：这个方法可以拷贝流，算是这个工具类中使用最多的方法了。支持多种数据间的拷贝。copy内部使用的其实还是copyLarge方法。因为copy能拷贝Integer.MAX_VALUE的字节数据，即2^31-1。

copy(inputstream,outputstream)
copy(inputstream,writer)
copy(inputstream,writer,encoding)
copy(reader,outputstream)
copy(reader,writer)
copy(reader,writer,encoding)

copyLarge：这个方法适合拷贝较大的数据流，比如2G以上。

copyLarge(reader,writer) 默认会用1024*4的buffer来读取
copyLarge(reader,writer,buffer)

获取输入流

//通过文本获取输入流 ， 可以指定编码格式
InputStream toInputStream(final String input, final Charset encoding)

InputStream toInputStream(final String input, final String encoding)

//获取一个缓冲输入流，默认缓冲大小 1KB
InputStream toBufferedInputStream(final InputStream input)  

//获取一个指定缓冲流的大小的输入流
InputStream toBufferedInputStream(final InputStream input, int size)

//把流的全部内容放在另一个流中
BufferedReader toBufferedReader(final Reader reader)

//把流的全部内容放在另一个流中
BufferedReader toBufferedReader(final Reader reader, int size)

获取输入流里面的内容

// 输入流 --》 字符串
String toString(final InputStream input, final Charset encoding)

// 输入流 --》 字符串
String toString(final InputStream input, final String encoding)

// 字符输入流 --》 字符串
String toString(final Reader input)

// 字符数组 --》 字符串
String toString(final byte[] input, final String encoding)

//输入流 --》 字符数组
byte[] toByteArray(final InputStream input)

//输入流 --》 字符数组
byte[] toByteArray(final Reader input, final Charset encoding)

//输入流 --》 字符数组
byte[] toByteArray(final Reader input, final String encoding) 

//URL   --》 字符数组
byte[] toByteArray(final URI uri)

// URL  --》 字符串
String toString(final URL url, final Charset encoding)

// URL  --》 字符串
String toString(final URL url, final String encoding)

// URLConnection --》 字符串
byte[] toByteArray(final URLConnection urlConn)

字符串读写

List<String> readLines(InputStream input) 

List<String> readLines(InputStream input, final Charset encoding) 

List<String> readLines(InputStream input, final String encoding)

List<String> readLines(Reader input)

void writeLines(Collection<?> lines, String lineEnding, OutputStream output)

void writeLines(Collection<?> lines, String lineEnding, OutputStream output, Charset encoding)

void writeLines(Collection<?> lines, String lineEnding, OutputStream output, final encoding)

void writeLines(Collection<?> lines, String lineEnding,Writer writer)

小例子：

public void readLinesTest(){
       try{
           InputStream is = new FileInputStream("D://test1.txt");
           List<String> lines = IOUtils.readLines(is);
           for(String line : lines){
               System.out.println(line);
           }
       } catch (FileNotFoundException e) {
           e.printStackTrace();
       } catch (IOException e) {
           e.printStackTrace();
       }
   }

结果：

hello
world

write：这个方法可以把数据写入到输出流中

write(byte[] data, OutputStream output)
write(byte[] data, Writer output)
write(byte[] data, Writer output, Charset encoding)
write(byte[] data, Writer output, String encoding)

write(char[] data, OutputStream output)
write(char[] data, OutputStream output, Charset encoding)
write(char[] data, OutputStream output, String encoding)
write(char[] data, Writer output)

write(CharSequence data, OutputStream output)
write(CharSequence data, OutputStream output, Charset encoding)
write(CharSequence data, OutputStream output, String encoding)
write(CharSequence data, Writer output)

write(StringBuffer data, OutputStream output)
write(StringBuffer data, OutputStream output, String encoding)
write(StringBuffer data, Writer output)

write(String data, OutputStream output)
write(String data, OutputStream output, Charset encoding)
write(String data, OutputStream output, String encoding)
write(String data, Writer output)

read：从一个流中读取内容

read(inputstream,byte[])
read(inputstream,byte[],offset,length) 
//offset是buffer的偏移值，length是读取的长度

read(reader,char[])
read(reader,char[],offset,length)

下例子：

public void readTest(){
      try{
          byte[] bytes = new byte[4];
          InputStream is = IOUtils.toInputStream("hello world");
          IOUtils.read(is, bytes);
          System.out.println(new String(bytes));

          bytes = new byte[10];
          is = IOUtils.toInputStream("hello world");
          IOUtils.read(is, bytes, 2, 4);
          System.out.println(new String(bytes));
      } catch (IOException e) {
          e.printStackTrace();
      }
  }

readFully：这个方法会读取指定长度的流，如果读取的长度不够，就会抛出异常

readFully(inputstream,byte[])
readFully(inputstream,byte[],offset,length)
readFully(reader,charp[])
readFully(reader,char[],offset,length)

小例子：

public void readFullyTest(){
      byte[] bytes = new byte[4];
      InputStream is  = IOUtils.toInputStream("hello world");
      try {
          IOUtils.readFully(is,bytes);
          System.out.println(new String(bytes));
      } catch (IOException e) {
          e.printStackTrace();
      }
  }

输出：hell
报出异常：

java.io.EOFException: Length to read: 20 actual: 11
    at org.apache.commons.io.IOUtils.readFully(IOUtils.java:2539)
    at org.apache.commons.io.IOUtils.readFully(IOUtils.java:2558)
    at test.java.IOUtilsTest.readFullyTest(IOUtilsTest.java:22)
    ...

contentEquals：比较两个流是否相等

contentEquals(InputStream input1, InputStream input2)
contentEquals(Reader input1, Reader input2)

contentEqualsIgnoreEOL：比较两个流，忽略换行符

contentEqualsIgnoreEOL(Reader input1, Reader input2)

skip：这个方法用于跳过指定长度的流

long skip(inputstream,skip_length)
long skip(ReadableByteChannel,skip_length)
long skip(reader,skip_length)

skipFully：这个方法类似skip，只是如果忽略的长度大于现有的长度，就会抛出异常。

skipFully(inputstream,toSkip)
skipFully(readableByteChannel,toSkip)
skipFully(inputstream,toSkip)

小例子：

public void skipFullyTest(){
    InputStream is = IOUtils.toInputStream("hello world");
    try {
        IOUtils.skipFully(is,30);
        System.out.println(IOUtils.toString(is,"utf-8"));
    } catch (IOException e) {
        e.printStackTrace();
    }
}

ineIterator：读取流，返回迭代器

LineIterator lineIterator(InputStream input, Charset encoding)
LineIterator lineIterator(InputStream input, String encoding)
LineIterator lineIterator(Reader reader)

close：关闭流


//关闭 URLConnection 
void close(final URLConnection conn)

//closeQuietly 忽略nulls和异常，关闭某个流
void closeQuietly(final Reader input)

void closeQuietly(final Writer output)

void closeQuietly(final InputStream input)

void closeQuietly(final OutputStream output)

void closeQuietly(final Socket sock)

void closeQuietly(final ServerSocket sock)

小例子1


package com.app;
import java.io.IOException;
import java.io.InputStream;
import org.apache.commons.io.IOUtils;

public class A8 {

    public static void main(String[] args) {
        
        String meString = "哈哈哈哈，下班了，hello" ;

        try {
            
            InputStream inputStream = IOUtils.toInputStream( meString, "utf-8" ) ;
            String mes = IOUtils.toString( inputStream , "utf-8" ) ;
            System.out.println( mes );
            
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

效果：

哈哈哈哈，下班了，hello

小例子2 : 模拟了http 请求

package com.app;
import java.io.IOException;
import java.net.URL;

import org.apache.commons.io.IOUtils;

public class A8 {

    public static void main(String[] args) {

        String meString = "http://www.baidu.com" ;

        try {
            //模拟了http 请求
            String mes = IOUtils.toString( new URL( meString ) , "utf-8") ;
            System.out.println( mes );

        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}