介绍

  1. 实际开发过程中，无论是 web 程序，还是控制台输入输出，或者是网络操作，都不可避免的会遇到 I/O 操作。
  2. Go语言标准库的 bufio 包中，实现了对数据 I/O 接口的缓冲功能。这些功能封装于接口 io.ReadWriter、io.Reader 和 io.Writer 中，并对应创建了 ReadWriter、Reader 或 Writer 对象，在提供缓冲的同时实现了一些文本基本 I/O 操作功能。


ReadWriter 对象

介绍

ReadWriter 对象中存放了一对 Reader 和 Writer 指针，它同时提供了对数据 I/O 接口 io.ReadWriter 的读写缓冲功能。

  1. type ReadWriter struct {
  2.     *Reader
  3.     *Writer
  4. }

创建

可以使用 NewReadWriter() 函数创建 ReadWriter 对象，该函数的功能是根据指定的 Reader 和 Writer 创建一个 ReadWriter 对象。

  1. func NewReadWriter(r *Reader, w *Writer) *ReadWriter

Reader 对象

介绍

  1. Reader 对象可以对数据 I/O 接口 io.Reader 进行输入缓冲操作。
  2. 默认情况 Reader 对象没有定义初始值，输入缓冲区最小值为 16。当超出限制时，创建一个二倍的存储空间。
    1. type Reader struct {
    2.  //contains filtered or unexported fields
    3. )

    创建

    可以创建 Reader 对象的函数一共有两个，分别是 NewReader() 和 NewReaderSize()，下面分别介绍。

NewReader()

NewReader() 函数的功能是按照缓冲区默认长度创建 Reader 对象，Reader 对象会从底层 io.Reader 接口读取尽量多的数据进行缓存。该函数原型如下：

  1. func NewReader(rd io.Reader) *Reader

NewReaderSize()

NewReaderSize() 函数的功能是按照指定的缓冲区长度创建 Reader 对象，Reader 对象会从底层 io.Reader 接口读取尽量多的数据进行缓存。该函数原型如下：

  1. func NewReaderSize(rd io.Reader, size int) *Reader

操作

操作 Reader 对象的方法共有 11 个：

1. Read()

  1. Read() 方法的功能是读取数据，并存放到字节切片 p 中。
  2. Read() 执行结束会返回已读取的字节数，因为最多只调用底层的 io.Reader 一次，所以返回的 n 可能小于 len(p)，当字节流结束时，n 为 0，err 为 io. EOF。
    1. func (b *Reader) Read(p []byte) (n int, err error)
    示例：
    1. package main
    2. import (
    3.  "bufio"
    4.  "bytes"
    5.  "fmt"
    6. )
    7. func main() {
    8.  data := []byte("C语言中文网")
    9.  rd := bytes.NewReader(data)
    10.  r := bufio.NewReader(rd)
    11.  var buf [128]byte
    12.  n, err := r.Read(buf[:])
    13.  fmt.Println(string(buf[:n]), n, err) // C语言中文网 16 <nil>
    14. }

2. ReadByte()

ReadByte() 方法的功能是读取并返回一个字节，如果没有字节可读，则返回错误信息。

  1. func (b *Reader) ReadByte() (c byte,err error)

示例：

  1. package main
  2. import (
  3.     "bufio"
  4.     "bytes"
  5.     "fmt"
  6. )
  7. func main() {
  8.     data := []byte("Go语言入门教程")
  9.     rd := bytes.NewReader(data)
  10.     r := bufio.NewReader(rd)
  11.     c, err := r.ReadByte()
  12.     fmt.Println(string(c), err) // G <nil>
  13. }

3. ReadBytes()

  1. ReadBytes() 方法的功能是读取数据直到遇到第一个分隔符“delim”，并返回读取的字节序列（包括“delim”）。
  2. 如果 ReadBytes 在读到第一个“delim”之前出错，它返回已读取的数据和那个错误（通常是 io.EOF）。

  3. 只有当返回的数据不以“delim”结尾时，返回的 err 才不为空值。

    1. func (b *Reader) ReadBytes(delim byte) (line []byte, err error)

    其中，参数 delim 用于指定分割字节。示例代码如下：

    1. package main
    2. import (
    3.  "bufio"
    4.  "bytes"
    5.  "fmt"
    6. )
    7. func main() {
    8.  data := []byte("C语言中文网, Go语言入门教程")
    9.  rd := bytes.NewReader(data)
    10.  r := bufio.NewReader(rd)
    11.  var delim byte = ','
    12.  line, err := r.ReadBytes(delim)
    13.  fmt.Println(string(line), err) // C语言中文网, <nil>
    14. }

    4. ReadLine()

  4. ReadLine() 是一个低级的用于读取一行数据的方法。

  5. ReadLine 返回一行，不包括结尾的回车字符，如果一行太长（超过缓冲区长度），参数 isPrefix 会设置为 true 并且只返回前面的数据，剩余的数据会在以后的调用中返回。
  6. 大多数调用者应该使用 ReadBytes(‘\n’) 或者 ReadString(‘\n’)。

  7. 当返回最后一行数据时，返回值 isPrefix 会置为 false。返回的字节切片只在下一次调用 ReadLine 前有效。ReadLine 会返回一个非空的字节切片或一个错误。

    1. func (b *Reader) ReadLine() (line []byte, isPrefix bool, err error)

    示例：

    1. package main
    2. import (
    3.  "bufio"
    4.  "bytes"
    5.  "fmt"
    6. )
    7. func main() {
    8.  data := []byte("Golang is a beautiful language. \r\n I like it!")
    9.  rd := bytes.NewReader(data)
    10.  r := bufio.NewReader(rd)
    11.  line, prefix, err := r.ReadLine()
    12.  fmt.Println(string(line), prefix, err) // Golang is a beautiful language.  false <nil>
    13. }

    5. ReadRune()

  8. ReadRune() 方法的功能是读取一个 UTF-8 编码的字符，并返回其 Unicode 编码和字节数。

  9. 如果编码错误，ReadRune 只读取一个字节并返回 unicode.ReplacementChar(U+FFFD) 和长度 1。

    1. func (b *Reader) ReadRune() (r rune, size int, err error)

    示例：

    1. package main
    2. import (
    3.  "bufio"
    4.  "bytes"
    5.  "fmt"
    6. )
    7. func main() {
    8.  data := []byte("C语言中文网")
    9.  rd := bytes.NewReader(data)
    10.  r := bufio.NewReader(rd)
    11.  ch, size, err := r.ReadRune()
    12.  fmt.Println(string(ch), size, err) // C 1 <nil>
    13. }

    6. ReadSlice()

  10. ReadSlice() 方法的功能是读取数据直到分隔符“delim”处，并返回读取数据的字节切片，下次读取数据时返回的切片会失效。如果 ReadSlice 在查找到“delim”之前遇到错误，它返回读取的所有数据和那个错误（通常是 io.EOF）。

  11. 如果缓冲区满时也没有查找到“delim”，则返回 ErrBufferFull 错误。ReadSlice 返回的数据会在下次 I/O 操作时被覆盖，大多数调用者应该使用 ReadBytes 或者 ReadString。只有当 line 不以“delim”结尾时，ReadSlice 才会返回非空 err。

    1. func (b *Reader) ReadSlice(delim byte) (line []byte, err error)

    示例：

    1. package main
    2. import (
    3.  "bufio"
    4.  "bytes"
    5.  "fmt"
    6. )
    7. func main() {
    8.  data := []byte("C语言中文网, Go语言入门教程")
    9.  rd := bytes.NewReader(data)
    10.  r := bufio.NewReader(rd)
    11.  var delim byte = ','
    12.  line, err := r.ReadSlice(delim)
    13.  fmt.Println(string(line), err) // C语言中文网, <nil>
    14.  line, err = r.ReadSlice(delim)
    15.  fmt.Println(string(line), err) // Go语言入门教程 EOF
    16.  line, err = r.ReadSlice(delim)
    17.  fmt.Println(string(line), err) // EOF
    18. }

    7. ReadString()

  12. ReadString() 方法的功能是读取数据直到分隔符“delim”第一次出现，并返回一个包含“delim”的字符串。

  13. 如果 ReadString 在读取到“delim”前遇到错误，它返回已读字符串和那个错误（通常是 io.EOF）。只有当返回的字符串不以“delim”结尾时，ReadString 才返回非空 err。

    1. func (b *Reader) ReadString(delim byte) (line string, err error)

    示例：

    1. package main
    2. import (
    3.  "bufio"
    4.  "bytes"
    5.  "fmt"
    6. )
    7. func main() {
    8.  data := []byte("C语言中文网, Go语言入门教程")
    9.  rd := bytes.NewReader(data)
    10.  r := bufio.NewReader(rd)
    11.  var delim byte = ','
    12.  line, err := r.ReadString(delim)
    13.  fmt.Println(line, err) // C语言中文网, <nil>
    14. }

    8. UnreadByte()

  14. UnreadByte() 方法的功能是取消已读取的最后一个字节（即把字节重新放回读取缓冲区的前部）。

  15. 只有最近一次读取的单个字节才能取消读取。

    1. func (b *Reader) UnreadByte() error

    9. UnreadRune()

  16. UnreadRune() 方法的功能是取消读取最后一次读取的 Unicode 字符。

  17. 如果最后一次读取操作不是 ReadRune，UnreadRune 会返回一个错误（在这方面它比 UnreadByte 更严格，因为 UnreadByte 会取消上次任意读操作的最后一个字节）。

    1. func (b *Reader) UnreadRune() error

    10. Buffered()

    Buffered() 方法的功能是返回可从缓冲区读出数据的字节数

    1. package main
    2. import (
    3.  "bufio"
    4.  "bytes"
    5.  "fmt"
    6. )
    7. func main() {
    8.  data := []byte("Go语言入门教程")
    9.  rd := bytes.NewReader(data)
    10.  r := bufio.NewReader(rd)
    11.  var buf [14]byte
    12.  n, err := r.Read(buf[:])
    13.  fmt.Println(string(buf[:n]), n, err) // Go语言入门 14 <nil>
    14.  rn := r.Buffered()
    15.  fmt.Println(rn) // 6
    16.  n, err = r.Read(buf[:])
    17.  fmt.Println(string(buf[:n]), n, err) // 教程 6 <nil>
    18.  rn = r.Buffered()
    19.  fmt.Println(rn) // 0
    20. }

    11. Peek()

  18. Peek() 方法的功能是读取指定字节数的数据，这些被读取的数据不会从缓冲区中清除。在下次读取之后，本次返回的字节切片会失效。

  19. 如果 Peek 返回的字节数不足 n 字节，则会同时返回一个错误说明原因，如果 n 比缓冲区要大，则错误为 ErrBufferFull。
    1. func (b *Reader) Peek(n int) ([]byte, error)
    示例：
    1. package main
    2. import (
    3.  "bufio"
    4.  "bytes"
    5.  "fmt"
    6. )
    7. func main() {
    8.  data := []byte("Go语言入门教程")
    9.  rd := bytes.NewReader(data)
    10.  r := bufio.NewReader(rd)
    11.  bl, err := r.Peek(8)
    12.  fmt.Println(string(bl), err) // Go语言 <nil>
    13.  bl, err = r.Peek(14)
    14.  fmt.Println(string(bl), err) // Go语言入门 <nil>
    15.  bl, err = r.Peek(20)
    16.  fmt.Println(string(bl), err) // Go语言入门教程 <nil>
    17. }

Writer 对象

介绍

  1. Writer 对象可以对数据 I/O 接口 io.Writer 进行输出缓冲操作。
  2. 默认情况下 Writer 对象没有定义初始值，如果输出缓冲过程中发生错误，则数据写入操作立刻被终止，后续的写操作都会返回写入异常错误。
    1. type Writer struct {
    2.  //contains filtered or unexported fields
    3. }

创建

共有两个分别是 NewWriter() 和 NewWriterSize()

NewWriter()

NewWriter() 函数的功能是按照默认缓冲区长度创建 Writer 对象，Writer 对象会将缓存的数据批量写入底层 io.Writer 接口。

  1. func NewWriter(wr io.Writer) *Writer

NewWriterSize()

NewWriterSize() 函数的功能是按照指定的缓冲区长度创建 Writer 对象，Writer 对象会将缓存的数据批量写入底层 io.Writer 接口。

  1. func NewWriterSize(wr io.Writer, size int) *Writer

操作

操作 Writer 对象的方法共有 7 个：

1. Available()

Available() 方法的功能是返回缓冲区中未使用的字节数。

  1. func (b *Writer) Available() int

示例

  1. package main
  2. import (
  3.     "bufio"
  4.     "bytes"
  5.     "fmt"
  6. )
  7. func main() {
  8.     wr := bytes.NewBuffer(nil)
  9.     w := bufio.NewWriter(wr)
  10.     p := []byte("C语言中文网")
  11.     fmt.Println("写入前未使用的缓冲区为：", w.Available()) // 写入前未使用的缓冲区为： 4096
  12.     w.Write(p)
  13.     fmt.Printf("写入%q后，未使用的缓冲区为：%d\n", string(p), w.Available()) // 写入"C语言中文网"后，未使用的缓冲区为：4080
  14. }

2. Buffered()

Buffered() 方法的功能是返回已写入当前缓冲区中的字节数。

  1. func (b *Writer) Buffered() int

示例：

  1. package main
  2. import (
  3.     "bufio"
  4.     "bytes"
  5.     "fmt"
  6. )
  7. func main() {
  8.     wr := bytes.NewBuffer(nil)
  9.     w := bufio.NewWriter(wr)
  10.     p := []byte("C语言中文网")
  11.     fmt.Println("写入前未使用的缓冲区为：", w.Buffered()) // 写入前未使用的缓冲区为： 0
  12.     w.Write(p)
  13.     fmt.Printf("写入%q后，未使用的缓冲区为：%d\n", string(p), w.Buffered()) // 写入"C语言中文网"后，未使用的缓冲区为：16
  14.     w.Flush()
  15.     fmt.Println("执行 Flush 方法后，写入的字节数为：", w.Buffered()) // 执行 Flush 方法后，写入的字节数为： 0
  16. }

3. Flush()

Flush() 方法的功能是把缓冲区中的数据写入底层的 io.Writer，并返回错误信息。如果成功写入，error 返回 nil，否则 error 返回错误原因。

  1. func (b *Writer) Flush() error

示例：

  1. package main
  2. import (
  3.     "bufio"
  4.     "bytes"
  5.     "fmt"
  6. )
  7. func main() {
  8.     wr := bytes.NewBuffer(nil)
  9.     w := bufio.NewWriter(wr)
  10.     p := []byte("C语言中文网")
  11.     w.Write(p)
  12.     fmt.Printf("未执行 Flush 缓冲区输出 %q\n", string(wr.Bytes())) // 未执行 Flush 缓冲区输出 ""
  13.     w.Flush()
  14.     fmt.Printf("执行 Flush 后缓冲区输出 %q\n", string(wr.Bytes())) // 执行 Flush 后缓冲区输出 "C语言中文网"
  15. }

4. Write()

Write() 方法的功能是把字节切片 p 写入缓冲区，返回已写入的字节数 nn。如果 nn 小于 len(p)，则同时返回一个错误原因。

  1. func (b *Writer) Write(p []byte) (nn int, err error)

示例：

  1. package main
  2. import (
  3.     "bufio"
  4.     "bytes"
  5.     "fmt"
  6. )
  7. func main() {
  8.     wr := bytes.NewBuffer(nil)
  9.     w := bufio.NewWriter(wr)
  10.     p := []byte("C语言中文网")
  11.     n, err := w.Write(p)
  12.     w.Flush()
  13.     fmt.Println(string(wr.Bytes()), n, err) // C语言中文网 16 <nil>
  14. }

5. WriteByte()

WriteByte() 方法的功能是写入一个字节，如果成功写入，error 返回 nil，否则 error 返回错误原因。

  1. func (b *Writer) WriteByte(c byte) error

示例：

  1. package main
  2. import (
  3.     "bufio"
  4.     "bytes"
  5.     "fmt"
  6. )
  7. func main() {
  8.     wr := bytes.NewBuffer(nil)
  9.     w := bufio.NewWriter(wr)
  10.     var c byte = 'G'
  11.     err := w.WriteByte(c)
  12.     w.Flush()
  13.     fmt.Println(string(wr.Bytes()), err) // G <nil>
  14. }

6. WriteRune()

WriteRune() 方法的功能是以 UTF-8 编码写入一个 Unicode 字符，返回写入的字节数和错误信息。

  1. func (b *Writer) WriteRune(r rune) (size int,err error)

示例：

  1. package main
  2. import (
  3.     "bufio"
  4.     "bytes"
  5.     "fmt"
  6. )
  7. func main() {
  8.     wr := bytes.NewBuffer(nil)
  9.     w := bufio.NewWriter(wr)
  10.     var r rune = 'G'
  11.     size, err := w.WriteRune(r)
  12.     w.Flush()
  13.     fmt.Println(string(wr.Bytes()), size, err) // G 1 <nil>
  14. }

7. WriteString()

  1. WriteString() 方法的功能是写入一个字符串，并返回写入的字节数和错误信息。
  2. 如果返回的字节数小于 len(s)，则同时返回一个错误说明原因。
    1. func (b *Writer) WriteString(s string) (int, error)
    示例：
    1. package main
    2. import (
    3.  "bufio"
    4.  "bytes"
    5.  "fmt"
    6. )
    7. func main() {
    8.  wr := bytes.NewBuffer(nil)
    9.  w := bufio.NewWriter(wr)
    10.  s := "C语言中文网"
    11.  n, err := w.WriteString(s)
    12.  w.Flush()
    13.  fmt.Println(string(wr.Bytes()), n, err) // C语言中文网 16 <nil>
    14. }