常见 I/O 接口
最后更新于：2022-04-02 06:46:48
# 常见的 I/O 接口
Go提供了一系列的 I/O 接口并经常在标准库源码中使用它们。尽可能使用这些接口而非传递结构或其它类型是Go推荐的方式(*不必恐惧，Go中的接口并不像Java那样浩如烟海，你喝杯咖啡的功夫就能把这几个为数不多的接口翻来覆去的看很多遍*)。其中，当属 io.Reader 和 io.Writer 这两个接口最为常用。在标准库源码中处处有他们俩的身影，熟悉并了解他们对于日常工作非常必要。
Reader 和 Writer 接口的定义是这样的：
```
type Reader interface {
Read(p []byte) (n int, err error)
}
type Writer interface {
Write(p []byte) (n int, err error)
}
```
在Go中可以轻松的组合接口，看看下面的代码：
```
type Seeker interface {
Seek(offset int64, whence int) (int64, error)
}
type ReadSeeker interface {
Reader
Seeker
}
```
这种使用方式你同样可以在 io 包的 Pipe() 中看到：
```
func Pipe() (*PipeReader, *PipeWriter)
```
接下来让我们看看该如何使用。
### 准备
根据以下步骤配置你的开发环境：
1. 从Go[国内官网](https://golang.google.cn/dl/)下载并安装Go到你的操作系统中，配置GOPATH环境变量(*[Go环境变量配置教程](https://slowbirdgogogo.com/install_simple)*)。
2. 打开命令行，跳转到你的 GOPATH/src 文件夹内，建立项目文件夹，例如$GOPATH/src/github.com/yourusername/customrepo。所有的代码会在该目录下进行修改。
3. 或者，你可以通过以下名直接安装本书示例代码：```go get github.com/agtorre/go-cookbook/```
### 实践
以下步骤包括编写和运行程序：
1. 在你的命令行中建立新的文件夹，名为chapter1/interfaces。
2. 跳转到该文件夹。
3. 建立interfaces.go：
```
package interfaces
import (
"fmt"
"io"
"os"
)
// Copy直接将数据从in复制到out
// 它使用了buffer作为缓存
// 同时会将数据复制到Stdout
func Copy(in io.ReadSeeker, out io.Writer) error {
// 我们将结果写入 out 和 Stdout
w := io.MultiWriter(out, os.Stdout)
// 标准的 io.Copy 调用,如果传入的数据 in 过大会很危险
// 第一次向w复制数据
if _, err := io.Copy(w, in); err != nil {
return err
}
in.Seek(0, 0)
// 使用64字节作为缓存写入 w
// 第二次向w复制数据
buf := make([]byte, 64)
if _, err := io.CopyBuffer(w, in, buf); err != nil {
return err
}
// 打印换行
fmt.Println()
return nil
}
```
4. 建立pipes.go。[理解golang io.Pipe](https://www.jianshu.com/p/aa207155ca7d)这篇文章将r和w分别比喻为在对方干活时一直睡觉的工人，形象生动，令人拍案叫绝：
```
package interfaces
import (
"io"
"os"
)
// PipeExample展现了对 io 接口的更多用法
func PipeExample() error {
// io.Pipe()返回的r和w分别实现了io.Reader 和 io.Writer接口
r, w := io.Pipe()
// 在w进行写入的时候，r会发生阻塞
go func() {
// 这里我们简单的写入字符串，同样也可以写入json或base64编码的其他东西
w.Write([]byte("test\n"))
w.Close()
}()
if _, err := io.Copy(os.Stdout, r); err != nil {
return err
}
return nil
}
```
5. 建立example文件夹，在文件夹内建立main.go：
```
package main
import (
"bytes"
"fmt"
"github.com/agtorre/go-cookbook/chapter1//interfaces"
)
func main() {
in := bytes.NewReader([]byte("example"))
out := &bytes.Buffer{}
fmt.Print("stdout on Copy = ")
if err := interfaces.Copy(in, out); err != nil {
panic(err)
}
fmt.Println("out bytes buffer =", out.String())
fmt.Print("stdout on PipeExample = ")
if err := interfaces.PipeExample(); err != nil {
panic(err)
}
}
```
6. 执行 go run main.go
7. 这会输出：
```
stdout on Copy = exampleexample
out bytes buffer = exampleexample
stdout on PipeExample = test
```
8. 如果复制或编写了自己的测试，请跳转至上一个目录并运行测试，并确保所有测试都通过。
### 说明
Copy函数在接口之间进行复制并将它们视为流。 将数据视为流的方式有很多实际用途，特别是在处理网络或文件系统时。Copy函数还创建了一个复合写入器，它将两个写入器流组合起来，并使用ReadSeeker写入两次。还有一个使用缓冲写入的例子，如果你的内存不满足数据流大小，那么使用它会很合适。
PipeReader和PipeWriter结构实现了io.Reader和io.Writer接口。他们连接在一起，从属于一个内存管道。管道的主要目的是从流中读取数据，同时从同一个数据流写入不同的数据源。实质上，它将两个流合并为一个管道。
Go接口使用了清晰的抽象来包装常见操作的数据。这使 I/O 操作变得很明显，所以使用io包学习接口组合很不错。 pip包通常使用较少，但在连接输入和输出流时提供了极高的灵活性和线程安全性。
* * * *
学识浅薄，错误在所难免。欢迎在群中就本书提出修改意见，以飨后来者，长风拜谢。
Golang中国（211938256）
beego实战（258969317）
Go实践（386056972）
';