Golang 中的 io 包详解（一）：基础接口

Golang 中的 io 包提供了许多用于处理 I/O（输入输出） 操作的接口和函数，在许多标准库中都可以看到这些接口和函数的应用。本文首先介绍一下 io 包的几个基础接口。

io.Reader

io.Reader 表示任何可以读取数据的对象，定义了基本的 Read 方法。

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

Read 方法读取长度为 len(p) 字节的数据到 p 中，返回两个参数，读取数据的字节数（0 <= n <= len(p)）和 error 信息。当 Read 在读取 n>0 个字节后遇到错误或 EOF 时，返回读取的字节数和一个可能为非空的 error，下次接着读取时，会返回 0 和 非空 error。看个示例：

package main

import (
	"fmt"
	"io"
	"os"
)

func main() {
	f, err := os.Open("test.txt")
	if err != nil {
		panic(err)
	}
	defer f.Close()

	buf := make([]byte, 4) // 实例化一个长度为4的[]byte
	i := 0
	for {
		i++
		n, err := f.Read(buf) 
		fmt.Printf("第 %d 次读取, ", i)
		fmt.Printf("返回行数：%d，error 信息：%v ", n, err)

		if n == 0 || err == io.EOF {
			fmt.Println("文件以读取完毕")
			break
		}
		fmt.Printf("读取内容：%s \n", string(buf[:n]))
	}
}

将 test.txt 文件内容设置为 3 个字节 lud，运行看下效果：

第 1 次读取, 返回行数：3，error 信息：<nil> 读取内容：lud 
第 2 次读取, 返回行数：0，error 信息：EOF 文件以读取完毕

将 test.txt 文件内容设置为 4 个字节 ludu，运行看下效果：

第 1 次读取, 返回行数：4，error 信息：<nil> 读取内容：ludu 
第 2 次读取, 返回行数：0，error 信息：EOF 文件以读取完毕

将 test.txt 文件内容设置为 5 个字节 luduo，运行看下效果：

第 1 次读取, 返回行数：4，error 信息：<nil> 读取内容：ludu 
第 2 次读取, 返回行数：1，error 信息：<nil> 读取内容：o 
第 3 次读取, 返回行数：0，error 信息：EOF 文件以读取完毕

io.Writer

Writer 接口表示一个可以写入数据的对象，定义了基本的 Write 方法。

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

Write方法写入长度为 len(p) 字节的数据到基本数据流中，返回实际写入的字节数 n 和 error 信息。若 Write 返回的 n < len(p)，同时会返回一个非 nil 的 error。简单示例如下：

package main

import (
	"fmt"
	"os"
)

func main() {
	file, err := os.Create("file.txt")
	if err != nil {
		panic(err)
	}

	defer file.Close()

	data := []byte("luduoxin's blog")

	n, err := file.Write(data)
	if err != nil {
		panic(err)
	}

	fmt.Printf("%d bytes written", n)
}

io.Closer

Closer 接口表示可以关闭的对象，定义了一个基本的 Close 方法，通常在完成读写后关闭IO流以释放资源。

type Closer interface {
	Close() error
}

Close 方法用于释放资源，返回可能出现的 error，简单示例如下：

import (
    "os"
)

func main() {
    file, err := os.Create("file.txt")
    if err != nil {
        panic(err)
    }

    // 在文件使用结束后，需要调用 Close 方法释放资源。
    defer file.Close()

    // 文件读写操作...
}

io.Seeker

Seeker 接口表示可以随机读写的对象，定义了基本的 Seek 方法。Seek方法定位到给定偏移量位置，返回新的 offset 和 error 信息。

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

Seek 方法将当前读或写位置设置为距离偏移量 offset 个字节之后的位置。参数 whence 可以是 0、1 或 2：

1. 参数 whence 为 0 时，表示相对于文件起始位置，offset 必须为非负数。
2. 参数 whence 为 1 时，表示相对于当前位置，offset 可以为负数。
3. 参数 whence 为 2 时，表示相对于文件结尾，offset 可以为负数。

Seek 方法将返回新的偏移量和可能出现的错误。示例如下：

package main

import (
	"fmt"
	"io"
	"os"
)

func main() {
	file, err := os.Create("file.txt")
	if err != nil {
		panic(err)
	}

	defer file.Close()

	// 写入数据到文件中...
	file.Write([]byte("hello world"))

	// 将文件指针移动到文件开头
	file.Seek(0, io.SeekStart)

	// 从文件中读取数据到切片中
	buf := make([]byte, 5)
	file.Read(buf)
	fmt.Println(string(buf)) // 输出 hello

	// 将文件指针移动到文件末尾
	file.Seek(0, io.SeekEnd)

	// 在文件末尾进行写入操作
	file.Write([]byte("golang"))
}

通过调用 Seek 方法将文件指针移动到文件开头，并从文件中读取了数据，接下来将文件指针移动到文件末尾，并在文件末尾写入了新的数据。