Go 入门很简单:数据 I/O 对象及操作
「这是我参与2022首次更文挑战的第19天,活动详情查看:2022首次更文挑战」
使用通用 I/O 的接口
Go 的标准库提供了大量的 I/O 接口。最佳实践就是尽可能使用这些接口而不是传结构体或者其他类型。 最常用的接口就是 io.Reader 和 io.Writer:
type Reader interface {
Read(p []byte) (n int, err error)
}
type Writer interface {
Write(p []byte) (n int, err error)
}
Go 提供了标准库 bufio 包,实现数据 I/O 接口的缓冲功能。 包括了接口:
io.ReadWriterio.Readerio.Writer
并对应创建:
- ReadWriter
- Reader
- Writer
三个对象
ReadWriter 对象
ReadWriter 对象可以对数据 I/O 接口 io.ReadWriter 进行输入输出缓冲操作,结构:
type ReadWriter struct {
*Reader // Reader 指针
*Writer // Writer 指针
}
可以使用 NewReadWriter() 函数创建 ReadWriter 对象,该函数的功能是根据指定的 Reader 和 Writer 创建一个 ReadWriter 对象,ReadWriter 对象将会向底层 io.ReadWriter 接口写入数据,或者 io.ReadWriter 接口读取数据。该函数的原型:
// 参数 r 是要读取的来源 Reader 对象;参数 w 是要写入的对象的 Writer 对象。
func NewReadWriter(r *Reader, w *Writer) * ReadWriter
Reader 对象
Reader 结构定义如下:
type Reader struct {
// 默认情况下 Reader 对象没有定义初始值,输入缓冲区最小值为 16。当超出限制时,另创建一个二倍的存储空间。
}
Reader 对象创建函数
“Reader 对象的创建函数共有 2 个:NewReader() 和 NewReaderSize():
NewReader()函数: 按照缓冲区默认长度创建 Reader 对象,Reader 对象会从底层io.Reader接口读取尽量多的数据进行缓存。NewReaderSize()函数:按照指定的缓冲区长度创建 Reader 对象,Reader 对象会从底层io.Reader接口读取尽量多的数据进行缓存。
Reader 对象操作方法
Reader 对象的操作方法共有 11 个:
- Read()
- ReadByte()
- ReadBytes()
- ReadLine()
- ReadRune()
- ReadSlice()
- ReadString()
- UnreadByte()
- UnreadRune()
- Buffered()
- Peek()
Read() 方法
Read() 方法的功能是读取数据,并存放到字节切片 p 中。
Read() 执行结束会返回已读取的字节数,因为最多只调用底层的 io.Reader 一次,所以返回的 n 可能小于 len(p),当字节流结束时,n 为 0,err 为 io. EOF。
该方法原型如下:
func (b *Reader) Read(p []byte) (n int, err error)
在方法 Read() 中,参数 p 是用于存放读取数据的字节切片。示例代码如下:
package main
import (
"bufio"
"bytes"
"fmt"
)
func main() {
data := []byte("你好,世界")
rd := bytes.NewReader(data)
r := bufio.NewReader(rd)
var buf [128]byte
n, err := r.Read(buf[:])
fmt.Println(string(buf[:n]), n, err)
}
运行结果:
[Running] go run "/Users/yuzhou_1su/GoProjects/GoArticles/goIO/main.go"
你好,世界 15 <nil>
ReadByte() 方法
ReadByte() 方法的功能是读取并返回一个字节,如果没有字节可读,则返回错误信息。该方法原型如下:
func (b *Reader) ReadByte() (c byte,err error)
测试代码如下:
package main
import (
"bufio"
"bytes"
"fmt"
)
func main() {
data := []byte("Go语言入门很简单")
rd := bytes.NewReader(data)
r := bufio.NewReader(rd)
c, err := r.ReadByte()
fmt.Println(string(c), err)
}
ReadBytes() 方法
ReadBytes() 方法的功能是读取数据直到遇到第一个分隔符 “delim”,并返回读取的字节序列(包括“delim”)。如果 ReadBytes 在读到第一个“delim”之前出错,它返回已读取的数据和那个错误(通常是 io.EOF)。只有当返回的数据不以“delim”结尾时,返回的 err 才不为空值。该方法原型如下:
func (b *Reader) ReadBytes(delim byte) (line []byte, err error)
ReadLine() 方法
ReadLine() 是一个低级的用于读取一行数据的方法,大多数调用者应该使用 ReadBytes('\n') 或者 ReadString('\n')。ReadLine 返回一行,不包括结尾的回车字符,如果一行太长(超过缓冲区长度),参数 isPrefix 会设置为 true 并且只返回前面的数据,剩余的数据会在以后的调用中返回。
当返回最后一行数据时,参数 isPrefix 会置为 false。返回的字节切片只在下一次调用 ReadLine 前有效。ReadLine 会返回一个非空的字节切片或一个错误,方法原型如下:
func (b *Reader) ReadLine() (line []byte, isPrefix bool, err error)
ReadRune() 方法
ReadRune() 方法的功能是读取一个 UTF-8 编码的字符,并返回其 Unicode 编码和字节数。如果编码错误,ReadRune 只读取一个字节并返回 unicode.ReplacementChar(U+FFFD) 和长度 1。该方法原型如下:
func (b *Reader) ReadRune() (r rune, size int, err error)
ReadSlice() 方法
ReadSlice() 方法的功能是读取数据直到分隔符“delim”处,并返回读取数据的字节切片,下次读取数据时返回的切片会失效。如果 ReadSlice 在查找到“delim”之前遇到错误,它返回读取的所有数据和那个错误(通常是 io.EOF)。
如果缓冲区满时也没有查找到“delim”,则返回 ErrBufferFull 错误。ReadSlice 返回的数据会在下次 I/O 操作时被覆盖,大多数调用者应该使用 ReadBytes 或者 ReadString。只有当 line 不以“delim”结尾时,ReadSlice 才会返回非空 err。该方法原型如下:
func (b *Reader) ReadSlice(delim byte) (line []byte, err error)
ReadString() 方法
ReadString() 方法的功能是读取数据直到分隔符“delim”第一次出现,并返回一个包含“delim”的字符串。如果 ReadString 在读取到“delim”前遇到错误,它返回已读字符串和那个错误(通常是 io.EOF)。只有当返回的字符串不以“delim”结尾时,ReadString 才返回非空 err。该方法原型如下:
func (b *Reader) ReadString(delim byte) (line string, err error)
UnreadByte() 方法
UnreadByte() 方法的功能是取消已读取的最后一个字节(即把字节重新放回读取缓冲区的前部)。只有最近一次读取的单个字节才能取消读取。该方法原型如下:
func (b *Reader) UnreadByte() error
UnreadRune() 方法
UnreadRune() 方法的功能是取消读取最后一次读取的 Unicode 字符。如果最后一次读取操作不是 ReadRune,UnreadRune 会返回一个错误(在这方面它比 UnreadByte 更严格,因为 UnreadByte 会取消上次任意读操作的最后一个字节)。该方法原型如下:
func (b *Reader) UnreadRune() error
Buffered() 方法
Buffered() 方法的功能是返回可从缓冲区读出数据的字节数
Peek() 方法
Peek() 方法的功能是读取指定字节数的数据,这些被读取的数据不会从缓冲区中清除。在下次读取之后,本次返回的字节切片会失效。如果 Peek 返回的字节数不足 n 字节,则会同时返回一个错误说明原因,如果 n 比缓冲区要大,则错误为 ErrBufferFull。该方法原型如下:
func (b *Reader) Peek(n int) ([]byte, error)