JavaIO BufferedReader和BufferedWriter介绍和实例

雨点打透心脏的1/2处 2022-05-16 20:12 153阅读 0赞

# BufferedReader和BufferedWriter简介 #

为了提高字符流读写的效率，引入了缓冲机制，进行字符批量的读写，提高了单个字符读写的效率。`BufferedReader`用于加快读取字符的速度，`BufferedWriter`用于加快写入的速度

`BufferedReader`和`BufferedWriter`类各拥有`8192`个字符的缓冲区。当`BufferedReader`在读取文本文件时，会先尽量从文件中读入字符数据并放满缓冲区，而之后若使用`read()`方法，会先从缓冲区中进行读取。如果缓冲区数据不足，才会再从文件中读取，使用`BufferedWriter`时，写入的数据并不会先输出到目的地，而是先存储至缓冲区中。如果缓冲区中的数据满了，才会一次对目的地进行写出。

# BufferedReader #

`BufferedReader`是为了提供读的效率而设计的一个包装类，它可以包装字符流。可以从字符输入流中读取文本，缓冲各个字符，从而实现字符、数组和行的高效读取。

## 构造方法 ##

<table> 
 <thead> 
  <tr> 
   <th align="left">方法</th> 
   <th align="left">描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left"><code>BufferedReader(Reader in)</code></td> 
   <td align="left">创建一个使用默认大小输入缓冲区的缓冲字符输入流。</td> 
  </tr> 
  <tr> 
   <td align="left"><code>BufferedReader(Reader in, int sz)</code></td> 
   <td align="left">创建一个使用指定大小输入缓冲区的缓冲字符输入流。</td> 
  </tr> 
 </tbody> 
</table>

## 成员方法 ##

<table> 
 <thead> 
  <tr> 
   <th align="left">方法</th> 
   <th align="left">描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left"><code>int read()</code></td> 
   <td align="left">读取单个字符。</td> 
  </tr> 
  <tr> 
   <td align="left"><code>int read(char[] cbuf, int off, int len)</code></td> 
   <td align="left">将字符读入数组的某一部分。</td> 
  </tr> 
  <tr> 
   <td align="left"><code>String readLine()</code></td> 
   <td align="left"><strong>读取一个文本行。</strong></td> 
  </tr> 
  <tr> 
   <td align="left"><code>long skip(long n)</code></td> 
   <td align="left">跳过字符。</td> 
  </tr> 
  <tr> 
   <td align="left"><code>boolean ready()</code></td> 
   <td align="left">判断此流是否已准备好被读取。</td> 
  </tr> 
  <tr> 
   <td align="left"><code>void close()</code></td> 
   <td align="left">关闭该流并释放与之关联的所有资源。</td> 
  </tr> 
  <tr> 
   <td align="left"><code>void mark(int readAheadLimit)</code></td> 
   <td align="left">标记流中的当前位置。</td> 
  </tr> 
  <tr> 
   <td align="left"><code>boolean markSupported()</code></td> 
   <td align="left">判断此流是否支持 mark() 操作（它一定支持）。</td> 
  </tr> 
  <tr> 
   <td align="left"><code>void reset()</code></td> 
   <td align="left">将流重置到最新的标记。</td> 
  </tr> 
 </tbody> 
</table>

## 读取文件实例 ##

### 读取文件: 一个字符一个字符的读取 ###

`int read()`方法,每次可以读取到一个字符(以`int` 类型表示)，不过因为返回的是`int`类型的，所以要强制类型转换成`char`类型才能打印该字符。

public static void printByFileReader(String filePath) throws IOException
    {
        BufferedReader reader=new BufferedReader(
                new FileReader(filePath)
                );
        if(!reader.ready())
        {
            System.out.println("文件流暂时无法读取");
            return;
        }
        int result=0;
        while((result=reader.read())!=-1)
        {
            //因为读取到的是int类型的，所以要强制类型转换
            System.out.print((char)result);
        }
        reader.close();
    }

### 读取文件:一个数组一个数组的读取 ###

`int read(char[] cbuf, int off, int len)`方法，每次读取`len`个字符放到字符数组`cbuf`中,从数组`cbuf`的下表`off`开始放,返回的是每次读取的字符个数。

public static void printByFileReaderChars(String filePath) throws IOException
    {
        BufferedReader reader=new BufferedReader(
                new FileReader(filePath)
                );
        if(!reader.ready())
        {
            System.out.println("文件流暂时无法读取");
            return;
        }
        int size=0;
        char[] cbuf=new char[20];
        while((size=reader.read(cbuf, 0, cbuf.length))!=-1)
        {
            System.out.print(new String(cbuf,0,size));
        }
        reader.close();
    }

### 读取文件:一行一行的读取 ###

`String readLine()`这个方法一次可以读取一个文本行,返回的直接就是这一行的字符串,如果读到行尾了就返回`null`。

public static void printByFileReaderLine(String filePath) throws IOException
    {
        BufferedReader reader=new BufferedReader(
                new FileReader(filePath)
                );
        if(!reader.ready())
        {
            System.out.println("文件流暂时无法读取");
            return;
        }
        int size=0;
        String line;
        while((line=reader.readLine())!=null)
        {
            System.out.print(line+"\n");
        }
        reader.close();
    }

需要注意的是：`reader.readLine()`方法返回的一行字符中`不包含换行符`,所以输出的时候要自己加上换行符。

`BufferedReader`比`FileReader`高级的地方在于这个，`FileReader`能一次读取一个字符，或者一个字符数组。而`BufferedReader`也可以，同时`BufferedReader`还能一次读取一行字符串。同时,`BufferedReader`带缓冲，会比`FileReader`快很多。

但是`FileReader`使用项目的编码来读取解析字符，不能指定编码，可能会出现编码问题，如果要指定编码可以使用包装`InputStreamReader`的`BufferedReader`。这样兼顾效率和编码。

测试上述方法：

public static void main(String[] args) throws IOException
    {
        String fileutf8="utf8.txt";
        String filegbk="gbk.txt";
        //一个字符一个字符的读取
        printByFileReader(filegbk);
        System.out.println("\n---------------------------------------");
        //一个字符数组一个字符数组的读取
        printByFileReaderChars(filegbk);
        System.out.println("\n---------------------------------------");
        //一行一行的读取
        printByFileReaderLine(filegbk);
        System.out.println("#########################################");
        //一个字符一个字符的读取
        printByFileReader(fileutf8);
        System.out.println("\n---------------------------------------");
        //一个数组一个数组的读取
        printByFileReaderChars(fileutf8);
        System.out.println("\n---------------------------------------");
        //一行一行的读取
        printByFileReaderLine(fileutf8);
    }

运行结果：

gbk file
    这里是一句中文 ---------------------------------------
    gbk file
    这里是一句中文 ---------------------------------------
    gbk file
    这里是一句中文
    #########################################
    utf-8 file
    杩欓噷鏄竴鍙ヤ腑鏂? ---------------------------------------
    utf-8 file
    杩欓噷鏄竴鍙ヤ腑鏂? ---------------------------------------
    utf-8 file
    杩欓噷鏄竴鍙ヤ腑鏂?

可以看到包装`FileReader`的`BufferedReader`在读取文件时候如果文件的编码和项目的编码不一样的时候，会出现乱。

## 乱码问题 ##

使用包装`InputStreamReader`的`BufferedReader`读取文件

String file = "utf8.txt";
    BufferedReader reader = new BufferedReader(
            new InputStreamReader(new FileInputStream(file), "utf-8"));
    char[] cbuf=new char[20];
    int size;
    while((size=reader.read(cbuf, 0, cbuf.length))!=-1)
    {
        System.out.println(new String(cbuf,0,size));
    }

运行结果：

utf-8 file
    这里是一句中文

这里要弄清楚的是BufferedReader只负责读到它的内部缓冲区中，而解码的工作是InputStreamReader完成的。

# BufferedWriter #

BufferedWriter的API：

## 构造函数： ##

<table> 
 <thead> 
  <tr> 
   <th align="left">方法</th> 
   <th align="left">描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left"><code>BufferedWriter(Writer out)</code></td> 
   <td align="left">创建一个缓冲字符输出流,使用默认大小的输出缓冲区</td> 
  </tr> 
  <tr> 
   <td align="left"><code>BufferedWriter(Writer out, int sz)</code></td> 
   <td align="left">创建一个缓冲字符输出流,使用给定大小的输出缓冲区</td> 
  </tr> 
 </tbody> 
</table>

## 成员方法 ##

<table> 
 <thead> 
  <tr> 
   <th align="left">方法</th> 
   <th align="left">描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left"><code>void write(int c)</code></td> 
   <td align="left">写入单个字符。</td> 
  </tr> 
  <tr> 
   <td align="left"><code>void write(char[] cbuf, int off, int len)</code></td> 
   <td align="left">写入字符数组的某一部分。</td> 
  </tr> 
  <tr> 
   <td align="left"><code>void write(String s, int off, int len)</code></td> 
   <td align="left">写入字符串的某一部分。</td> 
  </tr> 
  <tr> 
   <td align="left"><code>void newLine()</code></td> 
   <td align="left">写入一个行分隔符。</td> 
  </tr> 
  <tr> 
   <td align="left"><code>void close()</code></td> 
   <td align="left">关闭此流，但要先刷新它。</td> 
  </tr> 
  <tr> 
   <td align="left"><code>void flush()</code></td> 
   <td align="left">刷新该流的缓冲。</td> 
  </tr> 
 </tbody> 
</table>

## 写文件实例 ##

使用上述三个写方法写文件：一个字符一个字符的复制文件

public static void main(String[] args) throws IOException
    {
        BufferedWriter writer=new BufferedWriter(new FileWriter("静夜思.txt"));
        char ch='床';
        //写入一个字符
        writer.write(ch);
        String next="前明月光,";
        char[] nexts=next.toCharArray();
        //写入一个字符数组
        writer.write(nexts,0,nexts.length);
        //写入换行符
        writer.newLine();//写入换行符
        String nextLine="疑是地上霜。";
        //写入一个字符串。
        writer.write(nextLine);
        //关闭流
        writer.close();
    }

运行结果,静夜思.txt：

床前明月光,
    疑是地上霜。

# 应用：复制文本文件 #

## 逐个字符复制文件 ##

static void copyByChar(String srcFile, String destFile) throws IOException
    {
        BufferedReader reader = new BufferedReader(new FileReader(srcFile));
        BufferedWriter writer = new BufferedWriter(new FileWriter(destFile));
        int ch=0;
        //读取一个字符
        while ((ch = reader.read()) != -1)
        {
            //写入一个字符
            writer.write(ch);
        }
        reader.close();
        writer.close();
    }

## 逐个字符数组复制文件 ##

static void copyByCharArray(String srcFile, String destFile) throws IOException
    {
        BufferedReader reader = new BufferedReader(new FileReader(srcFile));
        BufferedWriter writer = new BufferedWriter(new FileWriter(destFile));
        int size=0;
        char[] cbuf=new char[20];
        //读取一个字符数组
        while ((size = reader.read(cbuf)) != -1)
        {
            //读入多少写入多少
            writer.write(cbuf,0,size);
        }
        reader.close();
        writer.close();
    }

## 按行复制文件 ##

static void copyByLine(String srcFile,String destFile) throws IOException
    {
        BufferedReader reader=new BufferedReader(new FileReader(srcFile));
        BufferedWriter writer=new BufferedWriter(new FileWriter(destFile));
        String line;
        //BufferedReader读取一行的时候返回的字符串中不包括换行符
        //如果有一行字符就返回该行字符串，没有就返回null
        while((line=reader.readLine())!=null)
        {
            writer.write(line);
            writer.newLine();//写换行符
        }
        reader.close();
        writer.close();
    }

需要注意的是,`BufferedReader`的`readLine()`读取一行的时候返回的字符串没有换行符，所以，复制的时候写文件是我们好多写入一个换行符，使用`writer.newLine()`方法即可。

## 测试： ##

public static void main(String[] args) throws IOException
    {
        String from = "gbk.txt";
        String to = "gbk_copy.txt";
        String to1 = "gbk_copy1.txt";
        String to2 = "gbk_copy2.txt";
        copyByChar(from, to);
        copyByCharArray(from, to1);
        copyByLine(from, to2);
    }

源文件gbk.txt:  
运行结果：  
gbk\_copy.txt

gbk file
    这里是一句中文

gbk\_copy1.txt

gbk file
    这里是一句中文

gbk\_copy2.txt

gbk file
    这里是一句中文

## bug:按行复制的时候多写换行符 ##

细心的朋友可能发现，按行复制的时候，复制的文件会莫名其妙的在文件后面多了一个换行符。这是因为我们每次都在读到的字符串后面写一个换行符。  
解决办法：在读到的字符串前面写换行符，这样出现新的问题,就是在文件开头多出了一个空行，所以加入控制语句，在第一行不写入换行符，第二行后再写。

static void copyByLine(String srcFile,String destFile) throws IOException
    {
        BufferedReader reader=new BufferedReader(new FileReader(srcFile));
        BufferedWriter writer=new BufferedWriter(new FileWriter(destFile));
        String line;
        //BufferedReader读取一行的时候返回的字符串中不包括换行符
        //如果有一行字符就返回该行字符串，没有就返回null
        boolean flag=false;
        while((line=reader.readLine())!=null)
        {
            if(!flag)
            {
                flag=true;
                writer.write(line);
            }
            else
            {
                writer.newLine();//写换行符
                writer.write(line);
            }
    
        }
        reader.close();
        writer.close();
    }

这样复制的文件就不会多谢换行符了，保证复制的文件和源文件是一模一样的。

## bug:乱码问题 ##

因为我们使用的是包装`FileReader`的`BufferedReader`，包装`FileWriter`的`BufferedWriter`。所以读字符，写字符的时候使用的是默认的字符编码读写的。所以读写文件的时候会出现乱码，可以使用包装`InputStreamReader`的`BufferedReader`,包装`OutputStreamWriter`的`BufferedWriter`来复制文件，这样就可以支持各种字符编码。

### 实例：gbk编码的文件复制到utf8编码的文件中： ###

static void copyByLineEncoding(String srcFile, String srcEncoding, String destFile,
            String destEncoding)
    {
        BufferedReader reader = null;
        BufferedWriter writer = null;
        try
        {
            reader = new BufferedReader(new InputStreamReader(
                    new FileInputStream(srcFile), srcEncoding));
            writer = new BufferedWriter(new OutputStreamWriter(
                    new FileOutputStream(destFile), destEncoding));
            char[] charArray = new char[512];
            int size;
            while ((size = reader.read(charArray, 0, charArray.length)) != -1)
            {
                writer.write(charArray, 0, size);
            }
    
        } catch (UnsupportedEncodingException | FileNotFoundException e)
        {
            e.printStackTrace();
        } catch (IOException e)
        {
            e.printStackTrace();
        } finally
        {
            if (writer != null)
            {
                try
                {
                    writer.close();
                } catch (IOException e)
                {
                    e.printStackTrace();
                }
            }
            if (reader != null)
            {
                try
                {
                    reader.close();
                } catch (IOException e)
                {
                    e.printStackTrace();
                }
            }
        }
    }

main方法：

public static void main(String[] args) throws IOException
    {
        String from = "gbk.txt";
        String to = "copyto_utf8.txt";
        copyByLineEncoding(from,"gbk",to,"utf-8");
    }

源文件gbk.txt(gbk编码)：

gbk file
    这里是一句中文

目标文件copyto\_utf8.txt：

utf-8 file
    杩欓噷鏄竴鍙ヤ腑鏂�

乱码是正常的，因为我们的工程目录用的gbk编码，把copyto\_utf8.txt编码显示就好了：

utf-8 file
    这里是一句中文

所以使用包装`InputStreamReader`的`BufferedReader`,包装`OutputStreamWriter`的`BufferedWriter`来复制文件的好处就是可以指定复制文件的时候使用的字符编码，例如上面的复制操作，从gbk编码的文件中读取，然后写入到utf8编码的文件中去。