Go语言数据I/O对象操作

为什么需要

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

ReadWriter对象

• ReadWriter 对象可以对数据 I/O 接口 io.ReadWriter 进行输入输出缓冲操作，ReadWriter 结构定义如下：

  type ReadWriter struct {
    *Reader
    *Writer
  }
  

  • 默认情况下，ReadWriter 对象中存放了一对 Reader 和 Writer 指针，它同时提供了对数据 I/O 对象的读写缓冲功能

  • 可以使用 NewReadWriter() 函数创建 ReadWriter 对象，该函数的功能是根据指定的 Reader 和 Writer 创建一个 ReadWriter 对象，ReadWriter 对象将会向底层 io.ReadWriter 接口写入数据，或者从 io.ReadWriter 接口读取数据。该函数原型声明如下：

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

    在函数 NewReadWriter() 中，参数 r 是要读取的来源 Reader 对象，参数 w 是要写入的目的 Writer 对象

Reader对象

基础概念

• Reader 对象可以对数据 I/O 接口 io.Reader 进行输入缓冲操作，Reader 结构定义如下

  type Reader struct {
  )
  

  默认情况下 Reader 对象没有定义初始值，输入缓冲区最小值为 16。当超出限制时，另创建一个二倍的存储空间

创建Reader对象

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

  • NewReader()

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

      func NewReader(rd io.Reader) *Reader
      

      其中，参数 rd 是 io.Reader 接口，Reader 对象将从该接口读取数据。

  • NewReaderSize() 函数

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

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

      其中，参数 rd 是 io.Reader 接口，参数 size 是指定的缓冲区字节长度

操作 Reader 对象

• 操作 Reader 对象的方法共有 11 个，分别是 Read()、ReadByte()、ReadBytes()、ReadLine()、ReadRune ()、ReadSlice()、ReadString()、UnreadByte()、UnreadRune()、Buffered()、Peek()

1. Read()

   • Read() 方法的功能是读取数据，并存放到字节切片 p 中。Read() 执行结束会返回已读取的字节数，因为最多只调用底层的 io.Reader 一次，所以返回的 n 可能小于 len§，当字节流结束时，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("i am here")
         rd := bytes.NewReader(data) //读取数据存储至rd之中
         r := bufio.NewReader(rd) //创建rd对象
     
         var buf [128]byte //创建切片	
         n, err := r.Read(buf[:]) //从rd读取数据存入切片之中
         fmt.Println(string(buf[:n]), n, err) //i am here 9 <nil>
     }
     

2. ReadByte() 方法

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

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

     func main() {
         data := []byte("i am here")
         rd := bytes.NewReader(data) //创建读取对象
         r := bufio.NewReader(rd) //创建rd对象
     
     	c,err := r.ReadByte()
     	fmt.Println(string(c),err) //i <nil>
     
     }
     

3. ReadBytes() 方法

   • ReadBytes() 方法的功能是读取数据直到遇到第一个分隔符“delim”，并返回读取的字节序列（包括“delim”）。如果 ReadBytes 在读到第一个“delim”之前出错，它返回已读取的数据和那个错误（通常是 io.EOF）。只有当返回的数据不以“delim”结尾时，返回的 err 才不为空值。该方法原型如下

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

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

     func main() {
         data := []byte("i am here")
         rd := bytes.NewReader(data) //创建读取对象
         r := bufio.NewReader(rd) //创建rd对象
     
     	c,err := r.ReadBytes('e') //以e为分隔符
     	fmt.Println(string(c),err) //i am he <nil>
     }
     

4. ReadLine() 方法

• ReadLine() 是一个低级的用于读取一行数据的方法，大多数调用者应该使用 ReadBytes(’\n’) 或者 ReadString(’\n’)。ReadLine 返回一行，不包括结尾的回车字符，如果一行太长（超过缓冲区长度），参数 isPrefix 会设置为 true 并且只返回前面的数据，剩余的数据会在以后的调用中返回。当返回最后一行数据时，参数 isPrefix 会置为 false。返回的字节切片只在下一次调用 ReadLine 前有效。ReadLine 会返回一个非空的字节切片或一个错误，方法原型如下

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

  func main() {
  	data := []byte("i am here \r\n hello")
  	rd := bytes.NewReader(data) //创建读取对象
  	r := bufio.NewReader(rd)    //创建rd对象
  
  	c, prefix, err := r.ReadLine()      //读取一行
  	fmt.Println(string(c), prefix, err) //i am here  false <nil>
  
  	c2, prefix2, err2 := r.ReadLine()      //读取一行
  	fmt.Println(string(c2), prefix2, err2) // hello false <nil>
  
  	//无效了，已经进行了下一次调用
  	fmt.Println(string(c), prefix, err) // helloere  false <nil>
  }
  
  

5. ReadRune() 方法

   • 读取一个 UTF-8 编码的字符，并返回其 Unicode 编码和字节数。如果编码错误，ReadRune 只读取一个字节并返回 unicode.ReplacementChar(U+FFFD) 和长度 1。该方法原型如下

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

     func main() {
     	data := []byte("i am here \r\n hello")
     	rd := bytes.NewReader(data) //创建读取对象
     	r := bufio.NewReader(rd)    //创建rd对象
     
     	c, size, err := r.ReadRune()    //读取一个 UTF-8 编码的字符
     	fmt.Println(string(c), size, err) //i 1 <nil>
     }
     

6. 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)
  

  func main() {
  	data := []byte("i am here,hello")
  	rd := bytes.NewReader(data) //创建读取对象
  	r := bufio.NewReader(rd)    //创建rd对象
  
  	var delim byte = ','
  
  	c, err := r.ReadSlice(delim) 
  	fmt.Println(string(c), err)  
  
  	c, err = r.ReadSlice(delim)
  	fmt.Println(string(c), err)  
  
  	c, err = r.ReadSlice(delim) 
  	fmt.Println(string(c), err)  
  }
  
  //结果
  i am here, <nil>
  hello EOF
   EOF
  

7. ReadString() 方法

   • ReadString() 方法的功能是读取数据直到分隔符“delim”第一次出现，并返回一个包含“delim”的字符串。如果 ReadString 在读取到“delim”前遇到错误，它返回已读字符串和那个错误（通常是 io.EOF）。只有当返回的字符串不以“delim”结尾时，ReadString 才返回非空 err。该方法原型如下

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

     func main() {
     	data := []byte("i am here,hello")
     	rd := bytes.NewReader(data) //创建读取对象
     	r := bufio.NewReader(rd)    //创建rd对象
     
     	var delim byte = ','
     
     	c, err := r.ReadString(delim) 
     	fmt.Println(string(c), err)  
     
     	c, err = r.ReadString(delim)
     	fmt.Println(string(c), err)  
     
     	c, err = r.ReadString(delim) 
     	fmt.Println(string(c), err)  
     }
     
     //结果
     i am here, <nil>
     hello EOF
      EOF
     
     

8. UnreadByte() 方法

   • UnreadByte() 方法的功能是取消已读取的最后一个字节（即把字节重新放回读取缓冲区的前部）。只有最近一次读取的单个字节才能取消读取。该方法原型如下

     func (b *Reader) UnreadByte() error
     

     func main() {
     	data := []byte("i am here,hello")
     	rd := bytes.NewReader(data) //创建读取对象
     	r := bufio.NewReader(rd)    //创建rd对象
     
     	var delim byte = ','
     
     	c, err := r.ReadString(delim) 
     	fmt.Println(string(c), err)  
     
     	r.UnreadByte() //将,放回
     
     	c, err = r.ReadString(delim)
     	fmt.Println(string(c), err)  
     
     	c, err = r.ReadString(delim) 
     	fmt.Println(string(c), err)  
     }
     
     //结果
     i am here, <nil>
     , <nil>
     hello EOF
     

9. UnreadRune() 方法

• UnreadRune() 方法的功能是取消读取最后一次读取的 Unicode 字符。如果最后一次读取操作不是 ReadRune，UnreadRune 会返回一个错误（在这方面它比 UnreadByte 更严格，因为 UnreadByte 会取消上次任意读操作的最后一个字节）。该方法原型如下

  func (b *Reader) UnreadRune() error
  

  func main() {
  	data := []byte("i am here,hello")
  	rd := bytes.NewReader(data) //创建读取对象
  	r := bufio.NewReader(rd)    //创建rd对象
  
  	var delim byte = ','
  
  	c, err := r.ReadString(delim) 
  	fmt.Println(string(c), err)  
  
  	err2:=r.UnreadRune() //将Unicode 放回
  	fmt.Println(err2)  
  
  }
  //结果
  i am here, <nil>
  bufio: invalid use of UnreadRune
  

10. Buffered() 方法

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

      func main() {
      	data := []byte("i am here,hello")
      	rd := bytes.NewReader(data) //创建读取对象
      	r := bufio.NewReader(rd)    //创建rd对象
      
      	var delim byte = ','
      
      	c, err := r.ReadString(delim) 
      	fmt.Println(string(c), err)  
      
      	rn := r.Buffered()
          fmt.Println(rn)
      	
      	c, err = r.ReadString(delim)
      	fmt.Println(string(c), err)  
      
      	rn = r.Buffered()
          fmt.Println(rn)
      
      	c, err = r.ReadString(delim) 
      	fmt.Println(string(c), err)  
      
      	rn = r.Buffered()
          fmt.Println(rn)
      }
      
      //结果
      i am here, <nil>
      5
      hello EOF
      0
       EOF
      0
      
      

11. Peek() 方法

    • Peek() 方法的功能是读取指定字节数的数据，这些被读取的数据不会从缓冲区中清除。在下次读取之后，本次返回的字节切片会失效。如果 Peek 返回的字节数不足 n 字节，则会同时返回一个错误说明原因，如果 n 比缓冲区要大，则错误为 ErrBufferFull。该方法原型如下

      func (b *Reader) Peek(n int) ([]byte, error)
      

      在方法 Peek() 中，参数 n 是希望读取的字节数

      func main() {
      	data := []byte("i am here,hello")
      	rd := bytes.NewReader(data) //创建读取对象
      	r := bufio.NewReader(rd)    //创建rd对象
      
      	c, err := r.Peek(2)
      	fmt.Println(string(c), err)  
      
      	c, err = r.Peek(3)
      	fmt.Println(string(c), err)  
      
      	c, err = r.Peek(18)
      	fmt.Println(string(c), err)  
      }
      //结果
      i  <nil>
      i a <nil>
      i am here,hello EOF
      

Writer 对象

基础概念

• Writer 对象可以对数据 I/O 接口 io.Writer 进行输出缓冲操作，Writer 结构定义如下

  type Writer struct {
  }
  

  默认情况下 Writer 对象没有定义初始值，如果输出缓冲过程中发生错误，则数据写入操作立刻被终止，后续的写操作都会返回写入异常错误

创建Writer对象

• 创建 Writer 对象的函数共有两个分别是 NewWriter() 和 NewWriterSize()

  • NewWriter() 函数

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

      func NewWriter(wr io.Writer) *Writer
      

      其中，参数 wr 是 io.Writer 接口，Writer 对象会将数据写入该接口

  • NewWriterSize() 函数

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

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

      其中，参数 wr 是 io.Writer 接口，参数 size 是指定的缓冲区字节长度

操作Writer对象

• 操作 Writer 对象的方法共有 7 个，分别是 Available()、Buffered()、Flush()、Write()、WriteByte()、WriteRune() 和 WriteString() 方法

1. Available() 方法

   • Available() 方法的功能是返回缓冲区中未使用的字节数，该方法原型如下

     func (b *Writer) Available() int
     

     func main() {
     	wr := bytes.NewBuffer(nil)
     	w := bufio.NewWriter(wr)
     	v := []byte("i am here")
     
     	fmt.Println("写入前未使用的缓冲区为：", w.Available())
     	w.Write(v)
     	fmt.Printf("写入%q后，未使用的缓冲区为：%d\n", string(v), w.Available())
     }
     //结果
     写入前未使用的缓冲区为： 4096
     写入"i am here"后，未使用的缓冲区为：4087
     

2. Buffered() 方法

   • Buffered() 方法的功能是返回已写入当前缓冲区中的字节数，该方法原型如下

     func (b *Writer) Buffered() int
     

     func main() {
     	wr := bytes.NewBuffer(nil)
     	w := bufio.NewWriter(wr)
     	v := []byte("i am here")
     
     	fmt.Println("写入前缓冲区字节数为：", w.Buffered())
     	w.Write(v)
     	fmt.Printf("写入%q后，缓冲区字节数：%d\n", string(v), w.Buffered())
     }
     //结果
     写入前缓冲区字节数为： 0
     写入"i am here"后，缓冲区字节数：9
     

3. Flush() 方法

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

     func (b *Writer) Flush() error
     

     func main() {
     	wr := bytes.NewBuffer(nil)
     	w := bufio.NewWriter(wr)
     	v := []byte("i am here")
     
     	w.Write(v)
     
     	fmt.Printf("未执行 Flush 缓冲区输出 %q\n", string(wr.Bytes()))
         w.Flush()
         fmt.Printf("执行 Flush 后缓冲区输出 %q\n", string(wr.Bytes()))
     }
     
     //结果
     未执行 Flush 缓冲区输出 ""
     执行 Flush 后缓冲区输出 "i am here"
     

4. Write() 方法

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

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

5. WriteByte() 方法

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

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

  func main() {
  	wr := bytes.NewBuffer(nil)
  	w := bufio.NewWriter(wr)
  
  	var v byte = 'a'
  	err := w.WriteByte(v)
  	w.Flush()
  	fmt.Println(string(wr.Bytes()), err)
  }
  //结果
  a <nil>
  

6. WriteRune() 方法

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

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

     其中，参数 r 是要写入的 Unicode 字符

     func main() {
     	wr := bytes.NewBuffer(nil)
     	w := bufio.NewWriter(wr)
     
     	var v rune = 'a'
     	size,err := w.WriteRune(v)
     	w.Flush()
     	fmt.Println(string(wr.Bytes()), size,err)
     }
     //结果
     a 1 <nil>
     

7. WriteString() 方法

• WriteString() 方法的功能是写入一个字符串，并返回写入的字节数和错误信息。如果返回的字节数小于 len(s)，则同时返回一个错误说明原因

  func (b *Writer) WriteString(s string) (int, error)
  

  func main() {
  	wr := bytes.NewBuffer(nil)
  	w := bufio.NewWriter(wr)
  
  	var v string = "i am here"
  	size,err := w.WriteString(v)
  	w.Flush()
  	fmt.Println(string(wr.Bytes()), size,err)
  }
  //结果
  i am here 9 <nil>