JDK源码：BufferedWriter

Posted 2021-04-21 jdkSpring

       BufferedWriter 是缓冲字符输出流。它继承于Writer。它的作用是为其他字符输出流添加一些缓冲功能，能够提高效率。

      BufferedWriter是给FileWriter提高效率用的，比如当我们向磁盘中不断的写入字节时或者将一个非常大单位是G的字节数据写入到磁盘的指定文件中，每写入一个字节就要打开一次到这个磁盘的通道，这个结果无疑是恐怖的，而当我们使用BufferedWriter，我们可以在程序中先将要写入到文件中的字符写入到BufferedWriter的内置缓存空间中，然后当达到一定数量时一次性写入。这样做虽然不可能达到一次访问就将所有数据写入磁盘中的效果，但也大大提高了效率和减少了磁盘的访问量！

类名

public class BufferedWriter extends Writer

成员变量

// 输出流对象private Writer out;// 保存“缓冲输出流”数据的字符数组private char cb[];// nChars 是cb缓冲区中字符的总的个数// nextChar是下一个要读取的字符在cb缓冲区中的位置private int nChars, nextChar;// 默认字符缓冲区大小private static int defaultCharBufferSize = 8192;// 行分割符private String lineSeparator;

方法

// 构造函数，传入“Writer对象”，// 指定缓冲区大小是szpublic BufferedWriter(Writer out, int sz)// 构造函数，传入“Writer对象”，// 默认缓冲区大小是8kpublic BufferedWriter(Writer out) // 确保“BufferedWriter”是打开状态private void ensureOpen() throws IOException// 对缓冲区执行flush()操作，// 将缓冲区的数据写入到Writer中void flushBuffer() throws IOException// 将c写入到缓冲区中。// 先将c转换为char，然后将其写入到缓冲区。public void write(int c) throws IOException// 返回a，b中较小的数private int min(int a, int b)// 将字符数组cbuf写入到缓冲中，// 从cbuf的off位置开始写入，写入长度是len。public void write(char cbuf[], int off, int len)                               throws IOException// 将字符串s写入到缓冲中，// 从s的off位置开始写入，写入长度是len。public void write(String s, int off, int len)  throws IOException// 将换行符写入到缓冲中public void newLine() throws IOException// 清空缓冲区数据public void flush() throws IOException// 关闭流public void close() throws IOException

write(int c)

// 将c写入到缓冲区中。// 先将c转换为char，然后将其写入到缓冲区。public void write(int c) throws IOException { synchronized (lock) { ensureOpen(); // 若缓冲区满了，则清空缓冲， // 将缓冲数据写入到输出流中。 if (nextChar >= nChars) flushBuffer(); cb[nextChar++] = (char) c; }}

write(char cbuf[], int off, int len)

// 将字符数组cbuf写入到缓冲中，// 从cbuf的off位置开始写入，写入长度是len。public void write(char cbuf[], int off, int len) throws IOException { synchronized (lock) { ensureOpen(); if ((off < 0) || (off > cbuf.length) || (len < 0) || ((off + len) > cbuf.length) || ((off + len) < 0)) { throw new IndexOutOfBoundsException(); } else if (len == 0) { return;        } if (len >= nChars) { /** 如果请求长度超过输出缓冲区的大小， * 刷新缓冲区，然后直接写入数据  */ flushBuffer(); out.write(cbuf, off, len); return;        } int b = off, t = off + len; while (b < t) { // nChars-nextChar:缓冲区剩余空间 // t-b：cbuf[off,len]未写入缓存区的大小 int d = min(nChars - nextChar, t - b); System.arraycopy(cbuf, b, cb, nextChar, d); b += d; nextChar += d; if (nextChar >= nChars) flushBuffer(); } }}

write(String s, int off, int len)

// 将字符串s写入到缓冲中，// 从s的off位置开始写入，写入长度是len。public void write(String s, int off, int len) throws IOException { synchronized (lock) {        ensureOpen(); int b = off, t = off + len; while (b < t) { // nChars-nextChar:缓冲区剩余空间 // t-b：s[off,len]未写入缓存区的大小 int d = min(nChars - nextChar, t - b); // String的getChars方法中调用System.arraycopy // 相当于System.arraycopy(s.toCharArray(), b, cb, nextChar, (b+d)-b) // 写满缓冲区 s.getChars(b, b + d, cb, nextChar); b += d; nextChar += d; if (nextChar >= nChars) flushBuffer(); } }}

flushBuffer()

// 对缓冲区执行flush()操作，将缓冲区的数据写入到Writer中void flushBuffer() throws IOException { synchronized (lock) { ensureOpen(); if (nextChar == 0) return; out.write(cb, 0, nextChar); nextChar = 0; }}

close()

// 关闭流public void close() throws IOException { synchronized (lock) { if (out == null) { return; } try { flushBuffer(); } finally { out.close(); out = null; cb = null; } }}

代码注释

public class BufferedWriter extends Writer { // 输出流对象 private Writer out; // 保存“缓冲输出流”数据的字符数组 private char cb[]; // nChars 是cb缓冲区中字符的总的个数 // nextChar是下一个要读取的字符在cb缓冲区中的位置 private int nChars, nextChar; // 默认字符缓冲区大小 private static int defaultCharBufferSize = 8192; // 行分割符 private String lineSeparator; // 构造函数，传入“Writer对象”，默认缓冲区大小是8k public BufferedWriter(Writer out) { this(out, defaultCharBufferSize); } // 构造函数，传入“Writer对象”，指定缓冲区大小是sz public BufferedWriter(Writer out, int sz) { super(out); if (sz <= 0) throw new IllegalArgumentException("Buffer size <= 0"); this.out = out; cb = new char[sz]; nChars = sz; nextChar = 0;
 lineSeparator = java.security.AccessController.doPrivileged( new sun.security.action.GetPropertyAction("line.separator")); } // 确保“BufferedWriter”是打开状态 private void ensureOpen() throws IOException { if (out == null) throw new IOException("Stream closed"); } // 对缓冲区执行flush()操作，将缓冲区的数据写入到Writer中 void flushBuffer() throws IOException { synchronized (lock) { ensureOpen(); if (nextChar == 0) return; out.write(cb, 0, nextChar); nextChar = 0; } } // 将c写入到缓冲区中。 // 先将c转换为char，然后将其写入到缓冲区。 public void write(int c) throws IOException { synchronized (lock) { ensureOpen(); // 若缓冲区满了，则清空缓冲， // 将缓冲数据写入到输出流中。 if (nextChar >= nChars) flushBuffer(); cb[nextChar++] = (char) c; } } // 返回a，b中较小的数 private int min(int a, int b) { if (a < b) return a; return b; } // 将字符数组cbuf写入到缓冲中， // 从cbuf的off位置开始写入，写入长度是len。 public void write(char cbuf[], int off, int len) throws IOException { synchronized (lock) { ensureOpen(); if ((off < 0) || (off > cbuf.length) || (len < 0) || ((off + len) > cbuf.length) || ((off + len) < 0)) { throw new IndexOutOfBoundsException(); } else if (len == 0) { return; }
 if (len >= nChars) { /** 如果请求长度超过输出缓冲区的大小， * 刷新缓冲区，然后直接写入数据  */ flushBuffer(); out.write(cbuf, off, len); return; }
 int b = off, t = off + len; while (b < t) { // nChars-nextChar:缓冲区剩余空间 // t-b：[off,len]未写入缓存区的大小 int d = min(nChars - nextChar, t - b); System.arraycopy(cbuf, b, cb, nextChar, d); b += d; nextChar += d; if (nextChar >= nChars) flushBuffer(); } } }
 // 将字符串s写入到缓冲中， // 从s的off位置开始写入，写入长度是len。 public void write(String s, int off, int len) throws IOException { synchronized (lock) {            ensureOpen(); int b = off, t = off + len; while (b < t) { // nChars-nextChar:缓冲区剩余空间 // t-b：[off,len]未写入缓存区的大小 int d = min(nChars - nextChar, t - b); // String的getChars方法中调用System.arraycopy // 相当于System.arraycopy(s.toCharArray(), b, cb, nextChar, (b+d)-b) // 写满缓冲区 s.getChars(b, b + d, cb, nextChar); b += d; nextChar += d; if (nextChar >= nChars) flushBuffer(); } } } // 将换行符写入到缓冲中 public void newLine() throws IOException { write(lineSeparator); } // 清空缓冲区数据 public void flush() throws IOException { synchronized (lock) { flushBuffer(); out.flush(); } } // 关闭流 public void close() throws IOException { synchronized (lock) { if (out == null) { return; } try { flushBuffer(); } finally { out.close(); out = null; cb = null; } } }}

下一篇是使用例子，记得看。。。