使用 go-zero 優雅地實現併發編排任務

Remember發表於2021-05-23

文章持續更新,微信搜一搜「 吳親強的深夜食堂

業務場景

在做任務開發的時候,你們一定會碰到以下場景:

場景1:呼叫第三方介面的時候, 一個需求你需要呼叫不同的介面,做資料組裝。

場景2:一個應用首頁可能依託於很多服務。那就涉及到在載入頁面時需要同時請求多個服務的介面。
這一步往往是由後端統一呼叫組裝資料再返回給前端,也就是所謂的 BFF(Backend For Frontend) 層。
呼叫這些服務往往沒有前後的依賴關係,可以同時呼叫。

針對以上兩種場景,假設在沒有強依賴關係下,選擇序列話呼叫,那麼總耗時即:

time=s1+s2+....sn

按照當代秒入百萬的有為青年,這麼長時間早就把你祖宗十八代問候了一遍。

為了偉大的KPI,我們往往會選擇併發的呼叫這些依賴介面。那麼總耗時就是:

time=max(s1,s2,s3.....,sn)

當然開始堆業務的時候可以先序列化,等到上面的人著急的時候,亮出絕招。
這樣,年底 PPT 就可以加上濃重的一筆流水賬:為業務某個介面提高百分之XXX效能,間接產生XXX價值。

當然這一切的前提是,做老闆不懂技術,做技術”懂”你。

言歸正傳,

如果修改成併發呼叫,你可能會這麼寫,

package main

import (
    "fmt"
    "sync"
    "time"
)

func main() {
    var wg sync.WaitGroup
    wg.Add(2)

    var userInfo *User
    var productList []Product

    go func() {
        defer wg.Done()
        userInfo, _ = getUser()
    }()

    go func() {
        defer wg.Done()
        productList, _ = getProductList()
    }()
    wg.Wait()
    fmt.Printf("使用者資訊:%+v\n", userInfo)
    fmt.Printf("商品資訊:%+v\n", productList)
}


/********使用者服務**********/

type User struct {
    Name string
    Age  uint8
}

func getUser() (*User, error) {
    time.Sleep(500 * time.Millisecond)
    var u User
    u.Name = "wuqinqiang"
    u.Age = 18
    return &u, nil
}

/********商品服務**********/

type Product struct {
    Title string
    Price uint32
}

func getProductList() ([]Product, error) {
    time.Sleep(400 * time.Millisecond)
    var list []Product
    list = append(list, Product{
        Title: "SHib",
        Price: 10,
    })
    return list, nil
}

先不管其他問題。從實現上來說,需要多少服務,你會開多少個 G,利用 sync.WaitGroup 的特性,
實現併發編排任務的效果。

好像,問題不大。

但是隨著代號 996 業務場景的增加,你會發現,好多模組都有相似的功能,只是對應的業務場景不同而已。

那麼我們能不能抽像出一套針對此業務場景的工具,而把具體業務實現交給業務方。

安排。

使用

本著不重複造輪子的原則,去搜了下開源專案,最終看上了 go-zero 裡面的一個工具 mapreduce
從檔名我們能看出來是什麼了,可以自行 Google 這個名詞。

使用很簡單。我們通過它改造一下上面的程式碼:

package main

import (
    "fmt"
    "github.com/tal-tech/go-zero/core/mr"
    "time"
)

func main() {
    var userInfo *User
    var productList []Product
    _ = mr.Finish(func() (err error) {
        userInfo, err = getUser()
        return err
    }, func() (err error) {
        productList, err = getProductList()
        return err
    })
    fmt.Printf("使用者資訊:%+v\n", userInfo)
    fmt.Printf("商品資訊:%+v\n", productList)
}
使用者資訊:&{Name:wuqinqiang Age:18}
商品資訊:[{Title:SHib Price:10}]

是不是舒服多了。

但是這裡還需要注意一點,假設你呼叫的其中一個服務錯誤,並且你 return err 對應的錯誤,那麼其他呼叫的服務會被取消。
比如我們修改 getProductList 直接響應錯誤。

func getProductList() ([]Product, error) {
    return nil, errors.New("test error")
}
//列印
使用者資訊:<nil>
商品資訊:[]

那麼最終列印的時候連使用者資訊都會為空,因為出現一個服務錯誤,使用者服務請求被取消了。

一般情況下,在請求服務錯誤的時候我們會有保底操作,一個服務錯誤不能影響其他請求的結果。
所以在使用的時候具體處理取決於業務場景。

原始碼

既然用了,那麼就追下原始碼吧。

func Finish(fns ...func() error) error {
    if len(fns) == 0 {
        return nil
    }

    return MapReduceVoid(func(source chan<- interface{}) {
        for _, fn := range fns {
            source <- fn
        }
    }, func(item interface{}, writer Writer, cancel func(error)) {
        fn := item.(func() error)
        if err := fn(); err != nil {
            cancel(err)
        }
    }, func(pipe <-chan interface{}, cancel func(error)) {
        drain(pipe)
    }, WithWorkers(len(fns)))
}
func MapReduceVoid(generator GenerateFunc, mapper MapperFunc, reducer VoidReducerFunc, opts ...Option) error {
    _, err := MapReduce(generator, mapper, func(input <-chan interface{}, writer Writer, cancel func(error)) {
        reducer(input, cancel)
        drain(input)
        // We need to write a placeholder to let MapReduce to continue on reducer done,
        // otherwise, all goroutines are waiting. The placeholder will be discarded by MapReduce.
        writer.Write(lang.Placeholder)
    }, opts...)
    return err
}

對於 MapReduceVoid函式,主要檢視三個閉包引數。

  • 第一個 GenerateFunc 用於生產資料。
  • MapperFunc 讀取生產出的資料,進行處理。
  • VoidReducerFunc 這裡表示不對 mapper 後的資料做聚合返回。所以這個閉包在此操作幾乎0作用。
func MapReduce(generate GenerateFunc, mapper MapperFunc, reducer ReducerFunc, opts ...Option) (interface{}, error) {
    source := buildSource(generate) 
    return MapReduceWithSource(source, mapper, reducer, opts...)
}

func buildSource(generate GenerateFunc) chan interface{} {
    source := make(chan interface{})// 建立無緩衝通道
    threading.GoSafe(func() {
        defer close(source)
        generate(source) //開始生產資料
    })

    return source //返回無緩衝通道
}

buildSource函式中,返回一個無緩衝的通道。並開啟一個 G 執行 generate(source),往無緩衝通道塞資料。 這個generate(source) 不就是一開始 Finish 傳遞的第一個閉包引數。

return MapReduceVoid(func(source chan<- interface{}) {
    // 就這個
        for _, fn := range fns {
            source <- fn
        }
    })

然後檢視 MapReduceWithSource 函式,

func MapReduceWithSource(source <-chan interface{}, mapper MapperFunc, reducer ReducerFunc,
    opts ...Option) (interface{}, error) {
    options := buildOptions(opts...)
    //任務執行結束通知訊號
    output := make(chan interface{})
    //將mapper處理完的資料寫入collector
    collector := make(chan interface{}, options.workers)
    // 取消操作訊號
    done := syncx.NewDoneChan()
    writer := newGuardedWriter(output, done.Done())
    var closeOnce sync.Once
    var retErr errorx.AtomicError
    finish := func() {
        closeOnce.Do(func() {
            done.Close()
            close(output)
        })
    }
    cancel := once(func(err error) {
        if err != nil {
            retErr.Set(err)
        } else {
            retErr.Set(ErrCancelWithNil)
        }

        drain(source)
        finish()
    })

    go func() {
        defer func() {
            if r := recover(); r != nil {
                cancel(fmt.Errorf("%v", r))
            } else {
                finish()
            }
        }()
        reducer(collector, writer, cancel)
        drain(collector)
    }()
    // 真正從生成器通道取資料執行Mapper
    go executeMappers(func(item interface{}, w Writer) {
        mapper(item, w, cancel)
    }, source, collector, done.Done(), options.workers)

    value, ok := <-output
    if err := retErr.Load(); err != nil {
        return nil, err
    } else if ok {
        return value, nil
    } else {
        return nil, ErrReduceNoOutput
    }
}

這段程式碼挺長的,我們說下核心的點。我們看到使用一個G 呼叫 executeMappers 方法。

go executeMappers(func(item interface{}, w Writer) {
        mapper(item, w, cancel)
    }, source, collector, done.Done(), options.workers)
func executeMappers(mapper MapFunc, input <-chan interface{}, collector chan<- interface{},
    done <-chan lang.PlaceholderType, workers int) {
    var wg sync.WaitGroup
    defer func() {
        // 等待所有任務全部執行完畢
        wg.Wait()
        // 關閉通道
        close(collector)
    }()
   //根據指定數量建立 worker池
    pool := make(chan lang.PlaceholderType, workers) 
    writer := newGuardedWriter(collector, done)
    for {
        select {
        case <-done:
            return
        case pool <- lang.Placeholder:
            // 從buildSource() 返回的無緩衝通道取資料
            item, ok := <-input 
            // 當通道關閉,結束
            if !ok {
                <-pool
                return
            }

            wg.Add(1)
            // better to safely run caller defined method
            threading.GoSafe(func() {
                defer func() {
                    wg.Done()
                    <-pool
                }()
                //真正執行閉包函式的地方
               // func(item interface{}, w Writer) {
               //    mapper(item, w, cancel)
               //    }
                mapper(item, writer)
            })
        }
    }
}

具體的邏輯已備註,程式碼很容易懂。

一旦 executeMappers 函式返回,關閉 collector 通道,那麼執行 reducer 不再阻塞。

go func() {
        defer func() {
            if r := recover(); r != nil {
                cancel(fmt.Errorf("%v", r))
            } else {
                finish()
            }
        }()
        reducer(collector, writer, cancel)
        //這裡
        drain(collector)
    }()

這裡的 reducer(collector, writer, cancel) 其實就是從 MapReduceVoid 傳遞的第三個閉包函式。

func MapReduceVoid(generator GenerateFunc, mapper MapperFunc, reducer VoidReducerFunc, opts ...Option) error {
    _, err := MapReduce(generator, mapper, func(input <-chan interface{}, writer Writer, cancel func(error)) {
        reducer(input, cancel)
        //這裡
        drain(input)
        // We need to write a placeholder to let MapReduce to continue on reducer done,
        // otherwise, all goroutines are waiting. The placeholder will be discarded by MapReduce.
        writer.Write(lang.Placeholder)
    }, opts...)
    return err
}

然後這個閉包函式又執行了 reducer(input, cancel),這裡的 reducer 就是我們一開始解釋過的 VoidReducerFunc,從 Finish() 而來

image

等等,看到上面三個地方的 drain(input)了嗎?

// drain drains the channel.
func drain(channel <-chan interface{}) {
    // drain the channel
    for range channel {
    }
}

其實就是一個排空 channel 的操作,但是三個地方都對同一個 channel,也是讓我費解。

還有更重要的一點。

go func() {
        defer func() {
            if r := recover(); r != nil {
                cancel(fmt.Errorf("%v", r))
            } else {
                finish()
            }
        }()
        reducer(collector, writer, cancel)
        drain(collector)
    }()

上面的程式碼,假如執行 reducerwriter 寫入引發 panic,那麼drain(collector) 會直接卡住。

不過作者已經修復了這個問題,直接把 drain(collector) 放入到 defer
image

具體 issues對 mr 其中一段程式碼的疑惑

到這裡,關於 Finish 的原始碼也就結束了。感興趣的可以看看其他原始碼。

很喜歡 go-zero 裡的一些通用業務工具,也看了好多原始碼,從原始碼可以看出,作者業務經驗豐富,抽象能力也很強,抽象了很多超實用的業務工具,使開發人員只需要專注於自己的業務(ps:把你變成傻瓜式操作,達到內卷的效果哈哈)。
但是往往用的一些工具並不獨立,依賴於其他檔案包,導致明明只想使用其中一個工具卻需要安裝整個包。

本作品採用《CC 協議》,轉載必須註明作者和本文連結
吳親庫裡

相關文章