Go语言中的io.Reader和io.Writer以及它们的实现

在使用Go语言的过程中，无论你是实现web应用程序，还是控制台输入输出，又或者是网络操作，不可避免的会遇到IO操作，使用到io.Reader和io.Writer接口。也也许对这两个接口和相关的一些接口很熟悉了，但是你脑海里确很难形成一个对io接口的继承关系整天的概貌，原因在于godoc缺省并没有像javadoc一样显示官方库继承关系，这导致了我们对io接口的继承关系记忆不深，在使用的时候还经常需要翻文档加深记忆。本文试图梳理清楚Go io接口的继承关系，提供一个io接口的全貌。

io接口回顾

首先我们回顾一下几个常用的io接口。标准库的实现是将功能细分，每个最小粒度的功能定义成一个接口，然后接口可以组成成更多功能的接口。

最小粒度的接口

1
2
3

type Reader interface {
    Read(p []byte) (n int, err error)
}

1
2
3

type Writer interface {
    Write(p []byte) (n int, err error)
}

1
2
3

type Closer interface {
    Close() error
}

1
2
3

type Seeker interface {
    Seek(offset int64, whence int) (int64, error)
}

1
2
3

type ReaderFrom interface {
    ReadFrom(r Reader) (n int64, err error)
}

1
2
3

type WriterTo interface {
    WriteTo(w Writer) (n int64, err error)
}

1
2
3

type ReaderAt interface {
    ReadAt(p []byte, off int64) (n int, err error)
}

1
2
3

type WriterAt interface {
    WriteAt(p []byte, off int64) (n int, err error)
}

以及

1
2
3

type ByteReader interface {
    ReadByte() (byte, error)
}

1
2
3

type ByteWriter interface {
    WriteByte(c byte) error
}

ByteScanner比ByteReader多了一个UnreadByte方法。

type ByteScanner interface {
    ByteReader
    UnreadByte() error
}

1
2
3

type RuneReader interface {
    ReadRune() (r rune, size int, err error)
}

type RuneScanner interface {
    RuneReader
    UnreadRune() error
}

组合接口

Go标准库还定义了一些由上面的单一职能的接口组合而成的接口。

type ReadCloser interface {
    Reader
    Closer
}

type ReadSeeker interface {
    Reader
    Seeker
}

type ReadWriter interface {
    Reader
    Writer
}

type ReadWriteCloser interface {
    Reader
    Writer
    Closer
}

type ReadWriteSeeker interface {
    Reader
    Writer
    Seeker
}

type WriteCloser interface {
    Writer
    Closer
}

type WriteSeeker interface {
    Writer
    Seeker
}

从它们的定义上可以看出，它们是最小粒度的组合。

最小接口的扩展

有些结构体struct实现并且扩展了接口，这些结构体是。

type LimitedReader struct {
    R Reader // underlying reader
    N int64  // max bytes remaining
}

1
2
3

type PipeReader struct {
    // contains filtered or unexported fields
}

1
2
3

type PipeWriter struct {
    // contains filtered or unexported fields
}

1
2
3

type SectionReader struct {
    // contains filtered or unexported fields
}

下面我会将它们的继承关系画出来。

一些辅助方法

一些辅助方法可以生成特殊类型的Reader或者Writer:

func LimitReader(r Reader, n int64) Reader
func MultiReader(readers ...Reader) Reader
func TeeReader(r Reader, w Writer) Reader
func MultiWriter(writers ...Writer) Writer