首頁 > 軟體

Go中Writer和Reader介面的使用入門

2022-04-20 13:01:32

引言

我們學習其他語言程式設計時,會學到一個 io 包,這個包可以以流的方式高效處理資料,而不用考慮資料是什麼,資料來自哪裡,以及資料要傳送到哪裡的問題。

io 是一個 Golang 標準庫包,它為圍繞輸入和輸出的許多操作和用例定義了靈活的介面。

io 包參見:golang.org/pkg/io/

與 stdout 和 stdin 對應,Go 語言實現了 io.Writerio.Reader 兩個介面。通過實現這兩個介面,其他介面都可以使用 io 包提供的所有功能,也可以用於其他包裡接收著兩個介面的函數以及方法。

Go 還提供了名為 bufioioutil 的包,其中包含與使用這些介面相關的有用功能。

Writer 介面

io.Writer 介面是 Go 非常小的介面之一。它只有一種方法。寫入方法。 Go 標準庫中的許多包都使用 io.Writer 介面,它表示將位元組切片寫入資料流的能力。更一般地,允許您將資料寫入實現 io.Writer 介面的東西。io.Writer 介面的宣告如下:

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

這個介面宣告了唯一一個方法 Writer,這個方法接收一個 byte 切片,並返回一個寫入的位元組數 n 和 error 錯誤值。

這裡會有兩個點需要注意:

  • Writer 從 p 位元組切片的資料流寫入 len(p) 位元組的資料。這個方法返回從 p 裡寫出的位元組數(0 <= n <= len(p) ),以及任何可能導致寫入提起結束的錯誤。
  • Writer 在返回 n < len(p) 的時候,必須返回某個 nil 值的 error。Writer 絕不能改寫切片裡的資料,也不能臨時修改。

現在來看一個例子,看在 Go 中將資料寫入檔案時如何使用 io.Writer

package main

import (
	"fmt"
	"os"
)

func main() {

	f, err := os.OpenFile("hello.txt", os.O_WRONLY|os.O_CREATE|os.O_APPEND, 0600)
	if err != nil {
		panic(err)
	}
	defer f.Close()

	n, err := f.Write([]byte("Hello, My name is LeeLei!"))
	if err != nil {
		panic(err)
	}
	fmt.Printf("wrote %d bytes", n)
}

執行結果:wrote 25 bytes, 同時我們可以檢視 hello.txt 檔案內容:

os.File 的 Read 確實是同一個 io.Writer 介面的實現,用於將位元組切片寫入底層檔案的資料流。這是 os.File.Write 的定義:

func (f *File) Write(b []byte) (n int, err error)

Reader 介面

然後來看一下 Reader 介面的宣告:

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

Reader 是一個帶有強抽象的小介面!那個抽象到底是什麼? Read 方法的想法是它表示從某個源讀取資料位元組,以便我們可以在程式碼中使用這些位元組。該來源可能是檔案、相機、網路連線,或者只是一個普通的舊字串。例如,如果我們從檔案中讀取資料,我們將使用的 io.Reader*os.File

io.Reader 介面宣告了一個方法 Read,這個方法同樣接受一個 byte 切片,返回兩個值。第一個值是讀入的位元組數,第二個值是 error 錯誤值。

  • p []byte 是我們傳遞給 Read 方法的位元組切片。 Reader 將從其資料來源(如檔案)讀取的資料複製到該位元組片。
  • 返回的 n int 告訴我們在這個 Read 呼叫中讀取了多少位元組。
  • 返回的 err error 是讀取資料時可能發生的任何錯誤,例如到達檔案末尾。

讓我們用一個檔案來嘗試一下,看看我們是如何使用它的。複製此文字並將其儲存到名為 hello.txt 的新目錄中的檔案中:

Hello, My name is LeeLei!

現在,讓我們編寫一些 Go 程式碼來使用 File 的 Read 方法讀取它。複製此程式碼並將其儲存到與 hello.txt 位於同一目錄中的檔案 main.go 中:

package main

import (
	"log"
	"os"
)

func main() {
	file, err := os.OpenFile("hello.txt", os.O_RDWR|os.O_CREATE|os.O_RDONLY, 0600)
	if err != nil {
		log.Fatalf("error opening hello.txt: %v", err)
	}
	defer file.Close()

	// Make a byte slice that's big enough to store a few words of the message
	// we're reading
	bytesRead := make([]byte, 33)

	// Now read some data, passing in our byte slice
	n, err := file.Read(bytesRead)
	if err != nil {
		log.Fatalf("error reading from hello.txt: %v", err)
	}

	// Take a look at the bytes we copied into the byte slice
	log.Printf("We read "%s" into bytesRead (%d bytes)",
		string(bytesRead), n)
}

執行該程式碼:go run main.go,然後可以看到如下輸出:

$ go run main.go     
2022/04/18 22:56:29 We read "Hello, My name is LeeLei!" into bytesRead (25 bytes)

那麼當我們呼叫 os.File.Read 時,Go 會從檔案中讀取資料,並將其複製到 bytesRead 中,由於沒有發生錯誤,因此返回的錯誤為 nil。我們將 bytesRead 切片傳遞給 Read 函數,就像我們將杯子傳遞給汽水噴泉一樣!

總結

本篇文章簡單介紹了 Go 語言 io 包中的兩個很實用的介面:Writer 和 Reader,分別給出了這兩個介面的宣告和解釋,然後以一個簡單的例子在程式碼中使用這兩個小巧的介面,但是 Go 語言設計這兩個介面的用法遠遠不止這些,也需要我們不斷去探索其他功能,甚至學有餘力去理解 Go 這樣的設計的原理。

到此這篇關於Go中Writer和Reader介面的使用入門的文章就介紹到這了,更多相關Go Writer和Reader介面內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com!


IT145.com E-mail:sddin#qq.com