Java IO笔记（FilterReader/FilterWriter）

本篇讲述的是java io包中的FilterReader/FilterWriter，它们同FilterInputStream/FilterOutputStream一样，是Reader和Writer的包装类，为Reader/Writer提供了更多的功能，下面先贴上源码，对其进行简单的分析。

FilterReader：

 

package java.io;

public abstract class FilterReader extends Reader {

    //内置了一个Reader对象句柄in，用于接收传入的Reader对象。
    protected Reader in;

    /**
     * 带一个参数的构造方法，传入的参数类型为一个Reader对象。内部直接调用父类Reader对象的对应构造方法，并为内置的Reader对象句柄in赋值。
     */
    protected FilterReader(Reader in) {
        super(in);
        this.in = in;
    }

    /**
     * 该方法每次读取读取一个字符的数据，实质就是调用Reader中对应的read方法。
     */
    public int read() throws IOException {
        return in.read();
    }

    /**
     * 该方法每次能够读取多个字符的数据，包含三个参数，第一个参数为一个字符数组，用于存放读取的数据内容，第二和第三个参数都是一个int型数值，分别表示着
     * 在数组中存放数据的起点以及存储数据的长度。内部实质直接调用Reader中对应的read方法。
     */
    public int read(char cbuf[], int off, int len) throws IOException {
        return in.read(cbuf, off, len);
    }

    /**
     * 该方法可以跳过指定字符数量的数据。内部实质直接调用Reader中对应的read方法。
     */
    public long skip(long n) throws IOException {
        return in.skip(n);
    }

    /**
     * 该方法用于判断当前流是否处于可读状态
     */
    public boolean ready() throws IOException {
        return in.ready();
    }

    /**
     * 该方法用于判断当前流是否支持流标记功能。
     */
    public boolean markSupported() {
        return in.markSupported();
    }

    /**
     * 该方法用于在指定位置留下标记，以便于跟reset方法联合使用，从而可以使流回退到标记的地方。内部实质是直接调用Reader的mark方法。
     */
    public void mark(int readAheadLimit) throws IOException {
        in.mark(readAheadLimit);
    }

    /**
     * 该方法用于与mark方法联用，用于将当前流的读取位置回退到标记的地方。内部实质是直接调用Reader的reset方法。
     */
    public void reset() throws IOException {
        in.reset();
    }

    
    /**
     * 该方法用于关闭当前的流及与之相关联的系统资源。内部实质是直接调用Reader对应的close方法。
     */
    public void close() throws IOException {
        in.close();
    }
}

FilterWriter：

 

 

package java.io;


public abstract class FilterWriter extends Writer {

    //内置了一个Writer对象的句柄，用于接收传入的Writer对象。
    protected Writer out;

    /**
     * 一个带一个参数的构造方法，传入的参数是一个Writer对象。内部实质上是调用Writer对应的构造方法，并为内置的Writer对象句柄赋值。
     */
    protected FilterWriter(Writer out) {
        super(out);
        this.out = out;
    }

    /**
     * 该方法可以每次写入一个字符的数据，传入的参数为要写入字符数据的int型值。内部实质是调用Writer对应的构造方法。
     */
    public void write(int c) throws IOException {
        out.write(c);
    }

    /**
     * 该方法可以每次写入多个字符的数据，含有3个参数，第一个参数为一个字符型数组，其中包含要写入的数据，第二和第三个参数都是一个int型数值
     * 分别表示了从数组中取出数据的起点和长度。内部本质是直接调用Writer对应的write方法。
     */
    public void write(char cbuf[], int off, int len) throws IOException {
        out.write(cbuf, off, len);
    }

    /**
     * 该方法可以每次写入一个字符串类型的数据（可以截取一部分），含有3个参数，第一个参数为要写入的字符串类型的数据，第二和第三个参数都是
     * 一个int型数据，分别代表截取字符串数据的起点和终点。内部本质上是直接调用Writer对应的write方法。
     */
    public void write(String str, int off, int len) throws IOException {
        out.write(str, off, len);
    }

    /**
     * 该方法用于将缓存中的数据强制写出。内部实质上是调用Writer的flush方法。
     */
    public void flush() throws IOException {
        out.flush();
    }

    /**
     * 该方法用于关闭当前流以及其相关联的系统资源。内部实质上是调用Writer的close方法。
     */
    public void close() throws IOException {
        out.close();
    }

}

 

通过对源码的简单分析，我们也不难看出FilterReader/FilterWriter和之前说过的FilterInputStream/FilterOutputStream一样，都是一个包装类，它们本身并没有什么特别大的意义，更多的是定义了标准，具体的实现是由子类来实现的，这里再次牵扯到了装饰者模式。

以上为本篇的全部内容。