一、常用接口
1、Reader
type Reader interface {
Read(p []byte) (n int, err error)
}
Reader 是包装基本 Read 方法的接口。
Read 最多将 len(p) 个字节读入 p。它返回读取的字节数 (0 <= n <= len(p)) 和遇到的错误。即使 Read 返回 n < len(p),它也可能在调用期间使用所有 p 作为暂存空间。
如果有一些数据可用,但长度不为 len(p) ,则 Read 通常会返回可用的数据,而不是等待更多数据。
当 Read 遇到错误,或者在成功读取 n > 0 个字节后,遇到 end-of-file 条件时,返回读取的字节数。它可能会从同一次调用中返回(非空)错误,或者从后续调用中返回错误(并且 n == 0)。
这种情况一个例子是:Reader 在读取到输入流末尾时,返回一个非零的字节数,并返回 err == EOF 或者 err == nil。下一次读取应该返回 0,EOF。
在考虑错误错误之前,调用者应始终处理返回的 n > 0 字节。这样做可以正确处理读取某些字节后发生的 I/O 错误以及允许的 EOF 行为。
对于 Read 的实现,不鼓励同时返回零字节计数和 nil 错误,除非 len(p) == 0。
调用者应将返回 0 和 nil 视为表示没有发生任何事情;特别是它不表示EOF。
实现不得持有 p。
2、Writer
type Writer interface {
Write(p []byte) (n int, err error)
}
Writer 是封装了基本 Write 方法的接口。
Write 将 len(p) 个字节从 p 写入底层数据流。
它返回从 p (0 <= n <= len(p)) 写入的字节数,以及遇到的任何导致写入提前停止的错误。
如果返回 n < len(p),则写入必须返回非零错误。
写入不能修改切片数据,即使是临时的。
实现不得保留 p。
3、Closer
type Closer interface {
Close() error
}
Closer 是封装了基本 Close 方法的接口。
第一次调用 Close 后的行为未定义。
具体实现的行为可以查看文档。
4、Seeker
type Seeker interface {
Seek(offset int64, whence int) (int64, error)
}
Seeker 是封装了基本 Seek 方法的接口。
Seek 将下一次读取或写入的偏移量设置为偏移量,根据 wherece
进行解释:
-
SeekStart
表示相对于文件的开头, -
SeekCurrent
表示相对于当前偏移量,并且 -
SeekEnd
表示相对于终点(例如,offset = -2 指定文件的倒数第二个字节)。
Seek 返回相对于文件开头的新偏移量或错误(如果有)。
Seek 到开始之前的偏移量是错误的。
可以允许 Seek 任何正偏移量,但如果新偏移量超过底层对象的大小,则后续 I/O 操作的行为取决于实现。
5、其他
type ReadWriter interface {
Reader
Writer
}
type ReadCloser interface {
Reader
Closer
}
type WriteCloser interface {
Writer
Closer
}
type ReadWriteCloser interface {
Reader
Writer
Closer
}
type ReadSeeker interface {
Reader
Seeker
}
type ReadSeekCloser interface {
Reader
Seeker
Closer
}
二、常用到的实现和 IO 工具
1、bytes.Buffer
Buffer 是具有 Read 和 Write 方法的可变大小的字节缓冲区。
Buffer 的零值是一个可以使用的空缓冲区。
Buffer 同时实现了 Reader 和 Writer 接口。
2、strings.Reader
和 bytes.Reader
共同点:都实现了 Reader 接口,用于以流的形式读取数据
区别:具备各自的特色方法,分别用于处理 string 和 byte
3、os.File
实现了 Reader、Writer、Seeker、Closer 接口。用于文件读写。
4、常用的工具方法
// 从 Reader 中读取全部数据,以 byte 切片形式返回数据
func ReadAll(r Reader) ([]byte, error)
// 从 Reader 中读取长度为 len(buf) 的数据,存入 buf 中
func ReadFull(r Reader, buf []byte) (n int, err error)
// 数据复制
func Copy(dst Writer, src Reader) (written int64, err error)
// 将 Reader 包装为 ReadCloser
func NopCloser(r Reader) ReadCloser
三、Demo
下面的代码只着重演示 IO 相关代码,忽略了所有的异常检查和处理。
func main() {
// 以一个字符串为基础,创建一个 String Reader,实现了 Reader 接口
strReader := strings.NewReader("I'm a piece of plain text.\n")
// 测试 1:通过 io.Copy 复制到标准输出
io.Copy(os.Stdout, strReader)
// 测试 2:通过 io.Copy 复制到 Buffer
buf := new(bytes.Buffer)
// 重置 Reader 的当前位置
strReader.Seek(0, io.SeekStart)
io.Copy(buf, strReader)
s, _ := buf.ReadString(0)
fmt.Println(s)
// 测试 3:写入文件
const FileName = "test.txt"
myFile, _ := os.Create(FileName)
defer myFile.Close()
strReader.Seek(0, io.SeekStart)
io.Copy(myFile, strReader)
}
四、参考
Go 中 io 包的使用方法
https://segmentfault.com/a/1190000015591319
官方文档
(完)