如何在 Go 中將 []byte 轉換為 io.Reader?

yongxinz發表於2021-12-29

原文連結: 如何在 Go 中將 []byte 轉換為 io.Reader?

在 stackoverflow 上看到一個問題,題主進行了一個網路請求,介面返回的是 []byte。如果想要將其轉換成 io.Reader,需要怎麼做呢?

這個問題解決起來並不複雜,簡單幾行程式碼就可以輕鬆將其轉換成功。不僅如此,還可以再通過幾行程式碼反向轉換回來。

下面聽我慢慢給你吹,首先直接看兩段程式碼。

[]byte 轉 io.Reader

package main

import (
	"bytes"
	"fmt"
	"log"
)

func main() {
	data := []byte("Hello AlwaysBeta")

	// byte slice to bytes.Reader, which implements the io.Reader interface
	reader := bytes.NewReader(data)

	// read the data from reader
	buf := make([]byte, len(data))
	if _, err := reader.Read(buf); err != nil {
		log.Fatal(err)
	}

	fmt.Println(string(buf))
}

輸出:

Hello AlwaysBeta

這段程式碼先將 []byte 資料轉換到 reader 中,然後再從 reader 中讀取資料,並列印輸出。

io.Reader 轉 []byte

package main

import (
	"bytes"
	"fmt"
	"strings"
)

func main() {
	ioReaderData := strings.NewReader("Hello AlwaysBeta")

	// creates a bytes.Buffer and read from io.Reader
	buf := &bytes.Buffer{}
	buf.ReadFrom(ioReaderData)

	// retrieve a byte slice from bytes.Buffer
	data := buf.Bytes()

	// only read the left bytes from 6
	fmt.Println(string(data[6:]))
}

輸出:

AlwaysBeta

這段程式碼先建立了一個 reader,然後讀取資料到 buf,最後列印輸出。

以上兩段程式碼就是 []byteio.Reader 互相轉換的過程。對比這兩段程式碼不難發現,都有 NewReader 的身影。而且在轉換過程中,都起到了關鍵作用。

那麼問題來了,這個 NewReader 到底是什麼呢?接下來我們通過原始碼來一探究竟。

原始碼解析

Go 的 io 包提供了最基本的 IO 介面,其中 io.Readerio.Writer 兩個介面最為關鍵,很多原生結構都是圍繞這兩個介面展開的。

下面就來分別說說這兩個介面:

Reader 介面

io.Reader 表示一個讀取器,它將資料從某個資源讀取到傳輸緩衝區。在緩衝區中,資料可以被流式傳輸和使用。

介面定義如下:

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

Read() 方法將 len(p) 個位元組讀取到 p 中。它返回讀取的位元組數 n,以及發生錯誤時的錯誤資訊。

舉一個例子:

package main

import (
	"fmt"
	"io"
	"os"
	"strings"
)

func main() {
	reader := strings.NewReader("Clear is better than clever")
	p := make([]byte, 4)

	for {
		n, err := reader.Read(p)
		if err != nil {
			if err == io.EOF {
				fmt.Println("EOF:", n)
				break
			}
			fmt.Println(err)
			os.Exit(1)
		}
		fmt.Println(n, string(p[:n]))
	}
}

輸出:

4 Clea
4 r is
4  bet
4 ter
4 than
4  cle
3 ver
EOF: 0

這段程式碼從 reader 不斷讀取資料,每次讀 4 個位元組,然後列印輸出,直到結尾。

最後一次返回的 n 值有可能小於緩衝區大小。

Writer 介面

io.Writer 表示一個編寫器,它從緩衝區讀取資料,並將資料寫入目標資源。

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

Write 方法將 len(p) 個位元組從 p 中寫入到物件資料流中。它返回從 p 中被寫入的位元組數 n,以及發生錯誤時返回的錯誤資訊。

舉一個例子:

package main

import (
	"bytes"
	"fmt"
	"os"
)

func main() {
	// 建立 Buffer 暫存空間,並將一個字串寫入 Buffer
	// 使用 io.Writer 的 Write 方法寫入
	var buf bytes.Buffer
	buf.Write([]byte("hello world , "))

	// 用 Fprintf 將一個字串拼接到 Buffer 裡
	fmt.Fprintf(&buf, " welcome to golang !")

	// 將 Buffer 的內容輸出到標準輸出裝置
	buf.WriteTo(os.Stdout)
}

輸出:

hello world ,  welcome to golang !

bytes.Buffer 是一個結構體型別,用來暫存寫入的資料,其實現了 io.Writer 介面的 Write 方法。

WriteTo 方法定義:

func (b *Buffer) WriteTo(w io.Writer) (n int64, err error)

WriteTo 方法第一個引數是 io.Writer 介面型別。

轉換原理

再說迴文章開頭的轉換問題。

只要某個例項實現了介面 io.Reader 裡的方法 Read() ,就滿足了介面 io.Reader

bytesstrings 包都實現了 Read() 方法。

// src/bytes/reader.go

// NewReader returns a new Reader reading from b.
func NewReader(b []byte) *Reader { return &Reader{b, 0, -1} }
// src/strings/reader.go

// NewReader returns a new Reader reading from s.
// It is similar to bytes.NewBufferString but more efficient and read-only.
func NewReader(s string) *Reader { return &Reader{s, 0, -1} }

在呼叫 NewReader 的時候,會返回了對應的 T.Reader 型別,而它們都是通過 io.Reader 擴充套件而來的,所以也就實現了轉換。

總結

在開發過程中,避免不了要進行一些 IO 操作,包括列印輸出,檔案讀寫,網路連線等。

在 Go 語言中,也提供了一系列標準庫來應對這些操作,主要封裝在以下幾個包中:

  • io:基本的 IO 操作介面。
  • io/ioutil:封裝了一些實用的 IO 函式。
  • fmt:實現了 IO 格式化操作。
  • bufio:實現了帶緩衝的 IO。
  • net.Conn:網路讀寫。
  • os.Stdinos.Stdout:系統標準輸入輸出。
  • os.File:系統檔案操作。
  • bytes:位元組相關 IO 操作。

除了 io.Readerio.Writer 之外,io 包還封裝了很多其他基本介面,比如 ReaderAtWriterAtReaderFromWriterTo 等,這裡就不一一介紹了。這部分程式碼並不複雜,讀起來很輕鬆,而且還能加深對介面的理解,推薦大家看看。

好了,本文就到這裡吧。關注我,帶你通過問題讀 Go 原始碼。


推薦閱讀:

熱情推薦:

  • 計算機經典書籍(含下載方式)
  • 技術部落格 硬核後端技術乾貨,內容包括 Python、Django、Docker、Go、Redis、ElasticSearch、Kafka、Linux 等。
  • Go 程式設計師 Go 學習路線圖,包括基礎專欄,進階專欄,原始碼閱讀,實戰開發,面試刷題,必讀書單等一系列資源。
  • 面試題彙總 包括 Python、Go、Redis、MySQL、Kafka、資料結構、演算法、程式設計、網路等各種常考題。

參考文章:

相關文章