1. 引言

io.LimitedReader 提供了一個有限的讀取功能，能夠手動設定最多從資料源最多讀取的位元組數，本文我們將從 io.LimitedReader 的基本定義出發，講述其基本使用和實作原理，其次，再簡單講述下具體的使用場景，基于此來完成對io.LimitedReader 的介紹，

2. 基本說明

2.1 基本定義

io.LimitedReader 是Go語言提供的一個Reader型別，其包裝了了一個io.Reader 介面，提供了一種有限的讀取功能，io.LimitedReader的基本定義如下:

type LimitedReader struct {
   R Reader // underlying reader
   N int64  // max bytes remaining
}

func (l *LimitedReader) Read(p []byte) (n int, err error) {}

LimitedReader結構體中包含了兩個欄位，其中R 為底層Reader, 資料都是從Reader 當中讀取的，而 N 則代表了剩余最多可以讀取的位元組數，同時也提供了一個Read 方法，通過該方法來實作對資料進行讀取，在讀取程序中 N 的值會不斷減小，

通過使用io.LimitedReader, 我們可以控制從底層讀取器讀取的位元組數，避免讀取到不應該讀取的資料，這個在某些場景下非常有用，

同時Go語言還提供了一個函式，能夠使用該函式，創建出一個io.LimitedReader 實體，函式定義如下:

func LimitReader(r Reader, n int64) Reader { return &LimitedReader{r, n} }

我們可以通過該函式創建出一個LimitedReader 實體，也能夠提升代碼的可讀性，

2.2 使用示例

下面我們展示如何使用io.LimitedReader 限制讀取的位元組數，代碼示例如下:

package main

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

func main() {
        // 創建一個字串作為底層讀取器
        reader := strings.NewReader("Hello, World!")

        // 創建一個LimitedReader，限制最多讀取5個位元組
        limitReader := io.LimitReader(reader, 5)

        // 使用LimitedReader進行讀取操作
        buffer := make([]byte, 10)
        n, err := limitReader.Read(buffer)

        if err != nil && err != io.EOF {
                fmt.Println("讀取錯誤:", err)
                return
        }

        fmt.Println("讀取的位元組數:", n)
        fmt.Println("讀取的內容:", string(buffer[:n]))
}

在上面示例中，我們使用字串創建了一個底層Reader，然后基于該底層Reader創建了一個io.LimitedReader，同時限制了最多讀取5個位元組，然后呼叫 limitReader 的 Read 方法讀取資料，此時將會讀取資料放到緩沖區當中，程式將讀取到的位元組數和內容列印出來，函式運行結果如下:

讀取的位元組數: 5
讀取的內容: Hello

這里讀取到的位元組數為5，同時也只回傳了前5個字符，通過這個示例，我們展示了使用io.LimitedReader 限制從底層資料源讀取資料數的方法，其實只需要使用io.LimitedReader對源Reader 進行包裝，同時宣告最多讀取的位元組數即可，

3. 實作原理

在了解了io.LimitedReader的基本定義和使用后，下面我們來對io.LimitedReader的實作原理進行基本說明，通過了解其實作原理，能夠幫助我們更好得理解和使用io.LimitedReader，

io.LimitedReader 的實作比較簡單，我們直接看其代碼的實作:

func (l *LimitedReader) Read(p []byte) (n int, err error) {
   // N 代表剩余可讀資料長度，如果小于等于0，此時直接回傳EOF
   if l.N <= 0 {
      return 0, EOF
   }
   // 傳入切片長度 大于 N, 此時通過 p = p[0:l.N] 修改切片長度，保證切片長度不大于 N
   if int64(len(p)) > l.N {
      p = p[0:l.N]
   }
   // 呼叫Read方法讀取資料，Read方法最多讀取 len(p) 位元組的資料
   n, err = l.R.Read(p)
   // 修改 N 的值
   l.N -= int64(n)
   return
}

其實io.LimitedReader的實作還是比較簡單的，首先，它維護了一個剩余可讀位元組數N，也就是LimitedReader 中的N 屬性，該值最開始是由用戶設定的，之后在不斷讀取的程序 N 不斷遞減，直到最后變小為0，

然后LimitedReader 中讀取資料，與其他Reader 一樣，需要用戶傳入一個位元組切片引數p ，為了避免讀取超過剩余可讀位元組數 N 的位元組數，此時會比較len(p) 和 N 的值，如果切片長度大于N，此時會使用p = p[0:l.N] 修改切片的長度，通過這種方式，保證最多只會讀取到N 位元組的資料，

4. 使用場景

當我們需要限制從資料源讀取到的位元組數時，亦或者在某些場景下，我們只需要讀取資料的前幾個位元組或者特定長度的資料，此時使用io.LimitedReader 來實作比較簡單方便，

一個經典的例子，其實是net/http 庫決議HTTP請求時對io.LimitedReader的使用，通過其限制了讀取的位元組數，

當客戶端發送HTTP請求時，可以設定頭部欄位 Content-Length 欄位的值，通過該欄位宣告請求體的長度，服務端就可以根據Content-Length 頭部欄位的值，確定請求體的長度，服務端在讀取請求體資料時，不能讀取超過Content-Length 長度的資料，因為后面的資料可能是下一個請求的資料，這里通過io.LimitedReader 來確保不會讀取超出Content-Length 指定長度的位元組數是非常合適的，而當前net/http 庫的實作也確實如此，下面是其中設定請求體的相關代碼:

// 根據不同的編碼型別來對 t.Body 進行設定
switch {
    // 分塊編碼
    case t.Chunked:
       // 忽略
    case realLength == 0:
       t.Body = NoBody
    // content-length 編碼方式
    case realLength > 0:
       t.Body = &body{src: io.LimitReader(r, realLength), closing: t.Close}
    default:
       // realLength < 0, i.e. "Content-Length" not mentioned in header
       // 忽略
}

這里realLength 便是通過Content-length 頭部欄位來獲取的，能夠取到值，此時便通過io.LimitedReader 來限制HTTP請求體資料的讀取，

后續執行真正的業務流程時，此時直接呼叫t.Body 中 Read 方法讀取資料即可，不需要操心讀取到下一個請求體的資料，非常方便，

5. 總結

io.LimitedReader 是Go語言標準庫提供的一個結構體型別，能夠限制從資料源讀取到的位元組數，我們先從io.LimitedReader的基本定義出發，之后通過一個簡單的示例，展示如何使用io.LimitedReader 來實作讀取資料數的限制，

接著我們講述了io.LimitedReader函式的實作原理，通過對這部分內容的講述，加深了我們對其的理解，最后我們簡單講述了io.LimitedReader 的使用場景，當我們需要限制從資料源讀取到的位元組數時，亦或者在某些場景下，我們只需要讀取資料的前幾個位元組或者特定長度的資料時，使用io.LimitedReader 是非常合適的，

基于此，完成了對io.LimitedReader 的介紹，希望對你有所幫助，

轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/557094.html

標籤：其他

上一篇：一文了解 io.LimitedReader型別

下一篇：返回列表