Golang学习笔记_21——Reader

Golang学习笔记_18——接口
Golang学习笔记_19——Stringer
Golang学习笔记_20——error

Reader

1. 介绍

io.Reader 是 Go 语言标准库 io 包中的一个接口，它定义了对象读取数据的基本方法。io.Reader 接口非常简单，只有一个方法

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

• Read(p []byte) (n int, err error)

  • p []byte：一个字节切片，用于存储从读取器中读取的数据。
  • n int：实际读取的字节数，0 <= n <= len§。如果 n == 0，通常意味着已经到达了数据流的末尾或没有更多数据可读。
  • err error：读取过程中遇到的错误，如果读取成功，则 err 为 nil。

2. 用途

io.Reader 接口非常通用，可以用于从各种数据源读取数据,比如文件、网络连接、内存缓冲区等。

由于它的简单性和通用性，io.Reader 被广泛用于 Go 语言中的标准库和第三方库中。

3. 实现

任何类型只要实现了 Read 方法，就实现了 io.Reader 接口。

type MyReader struct {
	data []byte
}

func (mr *MyReader) Read(p []byte) (n int, err error) {
	if len(mr.data) == 0 {
		return 0, io.EOF
	}

	n = copy(p, mr.data)
	mr.data = mr.data[n:]

	return n, nil
}

func demo_1() {
	reader := &MyReader{data: []byte("Hello, World!")}
	buf := make([]byte, 5)

	for {
		n, err := reader.Read(buf)
		if err != nil && err != io.EOF {
			fmt.Println("Error:", err)
			break
		}
		fmt.Print(string(buf[:n])) // 打印读取到的数据
		if err == io.EOF {
			break // 读取完毕
		}
	}
}

测试方法

func Test_demo_1(t *testing.T) {
	demo_1()
}

输出结果

=== RUN   Test_demo_1
Hello, World!--- PASS: Test_demo_1 (0.00s)
PASS

4. 实用函数

Go 标准库提供了一些实用函数，用于处理 io.Reader 对象，例如：

• io.Copy(dst io.Writer, src io.Reader)：从 src 读取数据并写入到 dst，直到遇到 EOF 或错误。
• io.ReadAll(r io.Reader)：读取 r 中的所有数据，返回一个字节切片和可能的错误。
• io.LimitReader(r io.Reader, n int64)：返回一个 Reader，它读取的数据量不超过 n 个字节。

5. 与其他接口组合使用

• io.ReadCloser：结合了 io.Reader 和 io.Closer 接口，用于在读取完数据后关闭资源。
• io.ReadWriteCloser：结合了 io.Reader、io.Writer 和 io.Closer 接口，用于双向数据传输和资源管理。
• io.ReaderAt 和 io.WriterAt：提供了从指定位置读取和写入数据的能力。

源码

// reader_demo.go 文件

package reader_demo

import (
	"fmt"
	"io"
)

type MyReader struct {
	data []byte
}

func (mr *MyReader) Read(p []byte) (n int, err error) {
	if len(mr.data) == 0 {
		return 0, io.EOF
	}

	n = copy(p, mr.data)
	mr.data = mr.data[n:]

	return n, nil
}

func demo_1() {
	reader := &MyReader{data: []byte("Hello, World!")}
	buf := make([]byte, 5)

	for {
		n, err := reader.Read(buf)
		if err != nil && err != io.EOF {
			fmt.Println("Error:", err)
			break
		}
		fmt.Print(string(buf[:n])) // 打印读取到的数据
		if err == io.EOF {
			break // 读取完毕
		}
	}
}

// reader_demo_test.go 文件
package reader_demo

import "testing"

func Test_demo_1(t *testing.T) {
	demo_1()
}