1. 引言

io.LimitedReader 提供了一個(gè)有限的讀取功能，能夠手動(dòng)設(shè)置最多從數(shù)據(jù)源最多讀取的字節(jié)數(shù)。本文我們將從 io.LimitedReader 的基本定義出發(fā)，講述其基本使用和實(shí)現(xiàn)原理，其次，再簡(jiǎn)單講述下具體的使用場(chǎng)景，基于此來(lái)完成對(duì)io.LimitedReader 的介紹。

2. 基本說(shuō)明

2.1 基本定義

io.LimitedReader 是Go語(yǔ)言提供的一個(gè)Reader類(lèi)型，其包裝了了一個(gè)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結(jié)構(gòu)體中包含了兩個(gè)字段，其中R 為底層Reader, 數(shù)據(jù)都是從Reader 當(dāng)中讀取的，而 N 則代表了剩余最多可以讀取的字節(jié)數(shù)。同時(shí)也提供了一個(gè)Read 方法，通過(guò)該方法來(lái)實(shí)現(xiàn)對(duì)數(shù)據(jù)進(jìn)行讀取，在讀取過(guò)程中 N 的值會(huì)不斷減小。

通過(guò)使用io.LimitedReader, 我們可以控制從底層讀取器讀取的字節(jié)數(shù)，避免讀取到不應(yīng)該讀取的數(shù)據(jù)，這個(gè)在某些場(chǎng)景下非常有用。

同時(shí)Go語(yǔ)言還提供了一個(gè)函數(shù)，能夠使用該函數(shù)，創(chuàng)建出一個(gè)io.LimitedReader 實(shí)例，函數(shù)定義如下:

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

我們可以通過(guò)該函數(shù)創(chuàng)建出一個(gè)LimitedReader 實(shí)例，也能夠提升代碼的可讀性。

2.2 使用示例

下面我們展示如何使用io.LimitedReader 限制讀取的字節(jié)數(shù)，代碼示例如下:

package main
import (
        "fmt"
        "io"
        "strings"
)
func main() {
        // 創(chuàng)建一個(gè)字符串作為底層讀取器
        reader := strings.NewReader("Hello, World!")
        // 創(chuàng)建一個(gè)LimitedReader，限制最多讀取5個(gè)字節(jié)
        limitReader := io.LimitReader(reader, 5)
        // 使用LimitedReader進(jìn)行讀取操作
        buffer := make([]byte, 10)
        n, err := limitReader.Read(buffer)
        if err != nil && err != io.EOF {
                fmt.Println("讀取錯(cuò)誤:", err)
                return
        }
        fmt.Println("讀取的字節(jié)數(shù):", n)
        fmt.Println("讀取的內(nèi)容:", string(buffer[:n]))
}

在上面示例中，我們使用字符串創(chuàng)建了一個(gè)底層Reader，然后基于該底層Reader創(chuàng)建了一個(gè)io.LimitedReader，同時(shí)限制了最多讀取5個(gè)字節(jié)。然后調(diào)用 limitReader 的 Read 方法讀取數(shù)據(jù)，此時(shí)將會(huì)讀取數(shù)據(jù)放到緩沖區(qū)當(dāng)中，程序?qū)⒆x取到的字節(jié)數(shù)和內(nèi)容打印出來(lái)。函數(shù)運(yùn)行結(jié)果如下:

讀取的字節(jié)數(shù): 5
讀取的內(nèi)容: Hello

這里讀取到的字節(jié)數(shù)為5，同時(shí)也只返回了前5個(gè)字符。通過(guò)這個(gè)示例，我們展示了使用io.LimitedReader 限制從底層數(shù)據(jù)源讀取數(shù)據(jù)數(shù)的方法，其實(shí)只需要使用io.LimitedReader對(duì)源Reader 進(jìn)行包裝，同時(shí)聲明最多讀取的字節(jié)數(shù)即可。

3. 實(shí)現(xiàn)原理

在了解了io.LimitedReader的基本定義和使用后，下面我們來(lái)對(duì)io.LimitedReader的實(shí)現(xiàn)原理進(jìn)行基本說(shuō)明，通過(guò)了解其實(shí)現(xiàn)原理，能夠幫助我們更好得理解和使用io.LimitedReader。

io.LimitedReader 的實(shí)現(xiàn)比較簡(jiǎn)單，我們直接看其代碼的實(shí)現(xiàn):

func (l *LimitedReader) Read(p []byte) (n int, err error) {
   // N 代表剩余可讀數(shù)據(jù)長(zhǎng)度，如果小于等于0，此時(shí)直接返回EOF
   if l.N <= 0 {
      return 0, EOF
   }
   // 傳入切片長(zhǎng)度 大于 N, 此時(shí)通過(guò) p = p[0:l.N] 修改切片長(zhǎng)度，保證切片長(zhǎng)度不大于 N
   if int64(len(p)) > l.N {
      p = p[0:l.N]
   }
   // 調(diào)用Read方法讀取數(shù)據(jù)，Read方法最多讀取 len(p) 字節(jié)的數(shù)據(jù)
   n, err = l.R.Read(p)
   // 修改 N 的值
   l.N -= int64(n)
   return
}

其實(shí)io.LimitedReader的實(shí)現(xiàn)還是比較簡(jiǎn)單的，首先，它維護(hù)了一個(gè)剩余可讀字節(jié)數(shù)N，也就是LimitedReader 中的N 屬性，該值最開(kāi)始是由用戶(hù)設(shè)置的，之后在不斷讀取的過(guò)程 N 不斷遞減，直到最后變小為0。

然后LimitedReader 中讀取數(shù)據(jù)，與其他Reader 一樣，需要用戶(hù)傳入一個(gè)字節(jié)切片參數(shù)p ，為了避免讀取超過(guò)剩余可讀字節(jié)數(shù) N 的字節(jié)數(shù)，此時(shí)會(huì)比較len(p) 和 N 的值，如果切片長(zhǎng)度大于N，此時(shí)會(huì)使用p = p[0:l.N] 修改切片的長(zhǎng)度，通過(guò)這種方式，保證最多只會(huì)讀取到N 字節(jié)的數(shù)據(jù)。

4. 使用場(chǎng)景

當(dāng)我們需要限制從數(shù)據(jù)源讀取到的字節(jié)數(shù)時(shí)，亦或者在某些場(chǎng)景下，我們只需要讀取數(shù)據(jù)的前幾個(gè)字節(jié)或者特定長(zhǎng)度的數(shù)據(jù)，此時(shí)使用io.LimitedReader 來(lái)實(shí)現(xiàn)比較簡(jiǎn)單方便。

一個(gè)經(jīng)典的例子，其實(shí)是net/http 庫(kù)解析HTTP請(qǐng)求時(shí)對(duì)io.LimitedReader的使用，通過(guò)其限制了讀取的字節(jié)數(shù)。

當(dāng)客戶(hù)端發(fā)送HTTP請(qǐng)求時(shí)，可以設(shè)置頭部字段 Content-Length 字段的值，通過(guò)該字段聲明請(qǐng)求體的長(zhǎng)度，服務(wù)端就可以根據(jù)Content-Length 頭部字段的值，確定請(qǐng)求體的長(zhǎng)度。服務(wù)端在讀取請(qǐng)求體數(shù)據(jù)時(shí)，不能讀取超過(guò)Content-Length 長(zhǎng)度的數(shù)據(jù)，因?yàn)楹竺娴臄?shù)據(jù)可能是下一個(gè)請(qǐng)求的數(shù)據(jù)，這里通過(guò)io.LimitedReader 來(lái)確保不會(huì)讀取超出Content-Length 指定長(zhǎng)度的字節(jié)數(shù)是非常合適的，而當(dāng)前net/http 庫(kù)的實(shí)現(xiàn)也確實(shí)如此。下面是其中設(shè)置請(qǐng)求體的相關(guān)代碼:

// 根據(jù)不同的編碼類(lèi)型來(lái)對(duì) t.Body 進(jìn)行設(shè)置
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 便是通過(guò)Content-length 頭部字段來(lái)獲取的，能夠取到值，此時(shí)便通過(guò)io.LimitedReader 來(lái)限制HTTP請(qǐng)求體數(shù)據(jù)的讀取。

后續(xù)執(zhí)行真正的業(yè)務(wù)流程時(shí)，此時(shí)直接調(diào)用t.Body 中 Read 方法讀取數(shù)據(jù)即可，不需要操心讀取到下一個(gè)請(qǐng)求體的數(shù)據(jù)，非常方便。

5. 總結(jié)

io.LimitedReader 是Go語(yǔ)言標(biāo)準(zhǔn)庫(kù)提供的一個(gè)結(jié)構(gòu)體類(lèi)型，能夠限制從數(shù)據(jù)源讀取到的字節(jié)數(shù)。 我們先從io.LimitedReader的基本定義出發(fā)，之后通過(guò)一個(gè)簡(jiǎn)單的示例，展示如何使用io.LimitedReader 來(lái)實(shí)現(xiàn)讀取數(shù)據(jù)數(shù)的限制。

接著我們講述了io.LimitedReader函數(shù)的實(shí)現(xiàn)原理，通過(guò)對(duì)這部分內(nèi)容的講述，加深了我們對(duì)其的理解。最后我們簡(jiǎn)單講述了io.LimitedReader 的使用場(chǎng)景，當(dāng)我們需要限制從數(shù)據(jù)源讀取到的字節(jié)數(shù)時(shí)，亦或者在某些場(chǎng)景下，我們只需要讀取數(shù)據(jù)的前幾個(gè)字節(jié)或者特定長(zhǎng)度的數(shù)據(jù)時(shí)，使用io.LimitedReader 是非常合適的。

基于此，完成了對(duì)io.LimitedReader 的介紹，希望對(duì)你有所幫助，更多關(guān)于Go語(yǔ)言io.LimitedReader類(lèi)型的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！