Go语言中io包核心接口示例详解

目录

• 前言
• Reader
• Writer
• Closer
• Seeker
• 组合接口
• 总结

前言

IO 操作是我们在编程中不可避免会遇到的，例如读写文件，Go语言的 io 包中提供了相关的接口，定义了相应的规范，不同的数据类型可以根据规范去实现相应的方法，提供更加丰富的功能。

Go 语言提倡小接口 + 接口组合的方式，来扩展程序的行为以及增加程序的灵活性。io代码包恰恰就可以作为这样的一个标杆，它可以成为我们运用这种技巧时的一个参考标准。io包中包含了大量接口，本篇文章我们就先来学习四个核心接口以及对应的接口组合。

Reader

io.Reader接口定义了 Read 方法，用于读取数据到字节数组中：

• 入参：字节数组 p，会将数据读入到 p 中
• 返回值：本次读取的字节数 n，以及遇到的错误 err

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

方法功能详解

1. 方法读取数据写入到字节数组 p 中，由于 p 是有大小的，所以一次至多读取 len(p) 个字节
2. 方法返回读取的数据字节数 n(0 <= n <= len(p))，以及读取过程中遇到的 error
3. 即使一次调用读取到的数据小于 len(p)，也可能会占用整个字节数组 p 作为暂存空间
4. 如果数据源的数据量小于 len(p) 个字节，方法只会读取当前可用数据，不会等待更多数据的到来

何时返回error

1. 在成功读取了 n（n>0）个字节后，如果产生了 error 或者 读到文件末尾 （end-of-file），本次调用必须要返回读取的字节数 n，但对于err 的值，可以选择在本次直接返回 err（err!=nil），或者在下次调用的时候再返回 err (n=0, err!=nil)。常见的一个例子就是，读取到n个字节后到达文件末尾（EOF），此时可以返回 err=EOF 或者 err=nil，下次调用返回 n=0,err=EOF。
2. 调用者需要注意，每次调用后，如果 n>0，应该先处理数据，再考虑 err 是否为 nil。因为上一点已经指出，如果读取到 n>0 个字节后遇到 error，会同时返回 n>0 和 err!=nil，此时就需要先处理数据再考虑 err。

方法实现和调用需注意

1. 如果想要实现该方法，不推荐同时返回 n=0 和 err=nil，除非 len(p)=0
2. 如果调用该该方法返回 n=0 和 err=nil，可以认为什么都没有发生，不能认为是读到文件末尾了（end-of-file）
3. 实现该方法后，一定不要持有字节数组p （保留下地址做他用）

Writer

io.Writer接口定义了 Write 方法，用于写数据到文件中

• 入参：字节数组 p，会将 p 中的数据写入到文件中
• 返回值：成功写入完成的字节数 n，以及遇到的错误 err

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

方法功能详解

1. 该方法将 p 中的数据写到文件中
2. 方法返回成功写入的字节数 n（0 <= n <= len(p)），以及写入过程中遇到的错误 err
3. 如果 n<len(p)，方法必须返回 err!=nil
4. 方法一定不能修改字节数组 p，即使是临时修改也不被允许

方法实现需注意

实现该方法后，一定不要持有字节数组p，只是用来读取数据

Closer

io.Closer接口定义了 Close 方法，该方法用于关闭连接。

方法实现需注意

第一次调用该方法后，再次调用该方法应该产生什么行为，该接口没有定义，依赖实现方法自定义。

type Closer interface {
    Close() error
}

Seeker

io.Seeker接口定义了 Seek 方法，该方法用于指定下次读取或者写入时的偏移量

入参：计算新偏移量的起始值 whence， 基于whence的偏移量offset

返回值：基于 whence 和 offset 计算后新的偏移量值，以及可能产生的错误

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

方法功能详解

io包中定义了如下三种 whence

const (
    SeekStart   = 0 // 基于文件开始位置
    SeekCurrent = 1 // 基于当前偏移量
    SeekEnd     = 2 // 基于文件结束位置
)

如果计算后新的偏移量，在文件起始位置之前，返回 error!=nil

任意正数的偏移量都是合法的，但是对数据源如何进行I/O操作，依赖具体的实现方法

组合接口

在go语言中，可以利用接口的组合，来囊括其他接口中的方法，类似于定义了一个父接口，可以包含多个子接口。如果一个 struct 实现了所有子接口的方法，也就相当于实现了父接口。小接口 + 接口组合的方式，很大程度上增加了程序的灵活性，在我们自己业务开发过程中，可以借鉴这种做法。

针对上面四个最小粒度的接口，io包定义了如下几种组合接口：

// ReadWriter 是 Read 和 Write 方法的组合
type ReadWriter interface {
    Reader
    Writer
}

// ReadCloser 是 Read 和 Close 方法的组合
type ReadCloser interface {
    Reader
    Closer
}

// WriteCloser 是 Write 和 Close 方法的组合
type WriteCloser interface {
    Writer
    Closer
}

// ReadWriteCloser 是 Read、Write 和 Close 方法的组合
type ReadWriteCloser interface {
    Reader
    Writer
    Closer
}

// ReadSeeker 是 Read 和 Seek 方法的组合
type ReadSeeker interface {
    Reader
    Seeker
}

// WriteSeeker 是 Write 和 Seek 方法的组合
type WriteSeeker interface {
    Writer
    Seeker
}

// ReadWriteSeeker 是 Read、Write 和 Seek 方法的组合
type ReadWriteSeeker interface {
    Reader
    Writer
    Seeker
}

总结

本篇文章介绍了 io包 中的四大核心接口：

• Reader : 读取文件中的数据到字节数组中
• Writer : 将字节数组的数据写入到文件中
• Closer : 用于关闭连接
• Seeker : 给定 whence 和 offset，计算得出新的offset，用于在特定位置开始读写

可以看到 Reader 和 Writer 接口中定义的方法中，都有字节数组p，而底层要操作的文件在方法中都没有体现。Read方法是将文件的数据读入字节数组p，Write 是将字节数组p的数据写入文件，这一点不要记混。

到此这篇关于Go语言中io包核心接口的文章就介绍到这了,更多相关Go语言io包核心接口内容请搜索服务器之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持服务器之家！

原文链接：https://juejin.cn/post/7041579897818447903