Go語言io?pipe源碼分析詳情

更新時間：2022年02月09日 10:01:24 作者：zwf193071

這篇文章主要介紹了Go語言io?pipe源碼分析詳情，pipe是一個適配器,用于連接Reader和Writer，pipe的方法不多,新的寫法卻不少，并且結構體分兩塊，讀寫信道和結束標識，下面進入文章了解具體的內容吧

1.結構分析

對外暴露的是一個構造函數和構造的兩個對象. 兩個對象分別暴露了方法,同時這兩個對象還有一個共同的底層對象. 實際上,這兩個對象暴露的方法是直接調用底層對象的, 那么核心還是在底層對象上,只是通過兩個對象和一個構造方法將底層對象的細節(jié)隱藏了.

2.pipe sruct分析

pipe的方法不多,新的寫法卻不少.

 type atomicError struct{ v atomic.Value }

? ? func (a *atomicError) Store(err error) {
? ? ? a.v.Store(struct{ error }{err})
? ? }
? ? func (a *atomicError) Load() error {
? ? ? err, _ := a.v.Load().(struct{ error })
? ? ? return err.error
? ? }

atomicError提供了error的原子讀寫.

? type pipe struct {
? ? ? wrMu sync.Mutex // Serializes Write operations
? ? ? wrCh chan []byte
? ? ? rdCh chan int

? ? ? once sync.Once // Protects closing done
? ? ? done chan struct{}
? ? ? rerr atomicError
? ? ? werr atomicError
? ? }

可以看到pipe結構體中主要分兩塊:

讀寫信道
- 兩個無緩沖信道
- 一個互斥量(保護暴露的寫函數)
結束標識
- once保證done的關閉只執(zhí)行一次
- done標志整個讀寫的結束
- 剩下兩個用于存儲讀寫錯誤
- PipeReader/PipeWriter的分析

3.PipeReader對外暴露的是讀/關閉

? ? type PipeReader struct {
? ? ? p *pipe
? ? }

? ? func (r *PipeReader) Read(data []byte) (n int, err error) {
? ? ? return r.p.Read(data)
? ? }

? ? func (r *PipeReader) Close() error {
? ? ? return r.CloseWithError(nil)
? ? }

? ? func (r *PipeReader) CloseWithError(err error) error {
? ? ? return r.p.CloseRead(err)
? ? }

PipeWriter對外暴露的是寫/關閉

 ? ?type PipeWriter struct {
? ? ? ?p *pipe
? ? ?}

? ? func (w *PipeWriter) Write(data []byte) (n int, err error) {
? ? ? return w.p.Write(data)
? ? }

? ? func (w *PipeWriter) Close() error {
? ? ? return w.CloseWithError(nil)
? ? }

? ? func (w *PipeWriter) CloseWithError(err error) error {
? ? ? return w.p.CloseWrite(err)
? ? }

他們的方法集都是指針接收者.具體方法的實現是通過pipe的方法完成的. pipe的方法更加明確:讀/獲取讀錯誤/結束讀寫并設置讀錯誤; 寫/獲取寫錯誤/結束讀寫并設置寫錯誤.思路相當明確.

下面主要分析pipe的讀寫

 ? func (p *pipe) Read(b []byte) (n int, err error) {
? ? ? select {
? ? ? case <-p.done:
? ? ? ? return 0, p.readCloseError()
? ? ? default:
? ? ? }

? ? ? select {
? ? ? case bw := <-p.wrCh:
? ? ? ? nr := copy(b, bw)
? ? ? ? p.rdCh <- nr
? ? ? ? return nr, nil
? ? ? case <-p.done:
? ? ? ? return 0, p.readCloseError()
? ? ? }
? ? }

? ? func (p *pipe) Write(b []byte) (n int, err error) {
? ? ? select {
? ? ? case <-p.done:
? ? ? ? return 0, p.writeCloseError()
? ? ? default:
? ? ? ? p.wrMu.Lock()
? ? ? ? defer p.wrMu.Unlock()
? ? ? }

? ? ? for once := true; once || len(b) > 0; once = false {
? ? ? ? select {
? ? ? ? case p.wrCh <- b:
? ? ? ? ? nw := <-p.rdCh
? ? ? ? ? b = b[nw:]
? ? ? ? ? n += nw
? ? ? ? case <-p.done:
? ? ? ? ? return n, p.writeCloseError()
? ? ? ? }
? ? ? }
? ? ? return n, nil
? ? }

讀寫都是利用兩個階段的select來完成,第一個階段的select是判斷讀寫有沒有結束, 第二階段處理實際的讀寫.

Read

每次將讀的數量寫到讀信道

Write

先將緩沖寫到寫信道,再從讀信道中獲取讀字節(jié)數,最后調整緩沖
如果緩沖太大,一次讀沒讀完,就將寫的過程多來幾遍,知道緩沖全部寫完

4.寫法

PipeWriter/PipeReader對外暴露的關閉,其實只可以保留一個CloseWithError, 但是為了方便客戶(調用者),還是拆成兩個,其實可以做測試比較一下. 性能測試發(fā)現拆成兩個或寫成一個可選參函數,性能上差別不大, 那這種寫法的主要作用是讓暴露的方法更加清晰易懂.

pipe.Write中,for循環(huán)帶有once參數,可以保證循環(huán)至少來一次, 算是do while的一種實現.