Go package(3)：io包介绍和使用

IO 操作的基本分类

在计算机中，处理文件和网络通讯等，都需要进行 IO 操作，IO 即是 input/ouput，计算机的输入输出操作。

Go语言中的 IO 操作封装在如下几个包中：

• io 为 IO 原语提供基本的接口
• io/ioutil 封装一些实用的 I/O 函数
• fmt 实现了 I/O 的格式化
• bufio 实现了带缓冲的 I/O
• net.Conn 网络的读写
• os.Stdin, Stdout 系统标准输入输出
• os.File 系统文件操作

当然除了上面这些，还有一些比如 json，xml，tar 等也属于文件操作。

其中 io 包中的 io.Reader 和 io.Writer 比较关键。io.Reader 接口实现了对文件、套接字等输入设备的抽象；io.Writer 接口则实现了对输出设备的抽象。

io 包提供了很多功能，这个包可以以流式的方式高效处理数据，而不用考虑数据是什么，数据来自哪里，以及数据要发送到哪里去。只要你实现了这2个接口。这就是抽象的能力。

IO包2个重要接口 Reader 和 Writer

在 io 包中有 2 个重要的接口：io.Reader和 io.Writer。

实现了这2个接口，就可以使用 io 包的功能。

Reader 接口

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

Read() 方法将 len(p) 个字节读取到 p 中。它返回读取的字节数 n，以及发生错误时的错误信息。

1. 如果读到了数据（n > 0），则 err 应该返回 nil。
2. 如果数据被读空，没有数据可读（n == 0），则 err 应该返回 EOF。
3. 如果遇到读取错误，则 err 应该返回相应的错误信息。
4. n 可能小于 len(p)，也就是说在 Go 读取 IO 时，是不会保证一次读取预期的所有数据的。
5. 如果要保证读取所需的所有数据，就需要在一个循环里调用 Read，累加每次返回的数据。

只要某个实例实现了接口 io.Reader 里的方法 Read() ，就满足了接口 io.Reader ，可以当做参数传入进来。

io.EOF 变量的定义：var EOF = errors.New("EOF")，是 error 类型。根据 reader 接口的说明，在 n > 0 且数据被读完了的情况下，当次返回的 error 有可能是 EOF 也有可能是 nil。

例子1： demo_reader.go 从标准输入中读取数据

package main

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

func ReadFrom(reader io.Reader, num int) ([]byte, error) {
	p := make([]byte, num)
	n, err := reader.Read(p)

	fmt.Println("n: ", n)

	if n > 0 {
		return p[:n], nil
	}
	return p, err
}

func main() {
	for {
		data, err := ReadFrom(os.Stdin, 4)
		if err != nil {
			if err == io.EOF {
				break
			}
		} else {
			fmt.Printf("receive: %X, %s\n", data, string(data))
		}
	}
}

Writer 接口

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

Write 方法将 len(p) 个字节从 p 中写入到对象数据流中。它返回从 p 中被写入的字节数 n，以及发生错误时返回的错误信息。

1. 如果 p 中的数据全部被写入，则 err 应该返回 nil。
2. 如果 p 中的数据无法被全部写入，则 err 应该返回相应的错误信息。

例子1 ：demo_writer.go

package main

import (
	"bytes"
	"fmt"
	"os"
)

func main() {
	// 创建 Buffer 暂存空间，并将一个字符串写入 Buffer
	// 使用 io.Writer 的 Write 方法写入
	var buf bytes.Buffer
	buf.Write([]byte("hello world , "))

	// 用 Fprintf 将一个字符串拼接到 Buffer 里
	fmt.Fprintf(&buf, " welcome to golang !")

	// 将 Buffer 的内容输出到标准输出设备
	buf.WriteTo(os.Stdout)
}

bytes.Buffer 结构体：

bytes.Buffer 是一个结构体类型，用来暂存写入的数据，这个结构体实现了 io.Writer 接口的 Write 方法。

Fprintf 方法定义：

func Fprintf(w io.Writer, format string, a ...interface{}) (n int, err error)

第一个参数是 io.Writer 接口类型，bytes.Buffer 结构体实现了 io.Writer 接口里的 Write 方法，实现了 Write 方法的类型都可以作为参数（这里是 buf）传入。

WriteTo 方法定义：

func (b *Buffer) WriteTo(w io.Writer) (n int64, err error)

WriteTo 方法第一个参数是 io.Writer 接口类型。

例子1：file_write.go

package main

import (
	"fmt"
	"os"
)

func main() {
	strings := []string{
		"hello, golang! \n",
		"welcome to golang! \n",
		"Go is a good lang. ",
	}

	file, err := os.Create("./writefile.txt")
	if err != nil {
		fmt.Println(err)
		os.Exit(1)
	}

	defer file.Close()

	for _, p := range strings {
		// file 类型实现了 io.Writer
		n, err := file.Write([]byte(p))
		if err != nil {
			fmt.Println(err)
			os.Exit(1)
		}
		if n != len(p) {
			fmt.Println("failed to write data")
			os.Exit(1)
		}
	}

	fmt.Println("file wirte done")
}

把 strings 这个 slice 结构中的字符串写入到名为 writefile.txt 的文件中。

参考

• io 包
• Fprintf 包
• bytes 包
• example_Buffer