【程式語言 - Go】Retry Policy

更新於 2023/05/16發佈於 2023/04/29閱讀時間約 5 分鐘

Golang，也稱作Go，是一種開源的編程語言，由Google開發。Golang設計的目標是提供一種簡單、高效、可靠的語言，適用於現代軟體開發的需求。

但由於Golang並沒有以完全物件導向的模式進行開發，因此在使用上會與我們熟悉的Javascript/Typescript有點不同，而這次要介紹的是Go語言如何設計一個泛用的Retry函式，以應付複雜的網路環境之下需要進行Retry的需求。

我們開發程式的過程中難免會依賴DB或其他服務，但複雜的網路環境下我們並沒有辦法確保我們發送的請求是否正確的送達，因此我們可以在程式中加入Retry機制，提升我們軟體的強健性。

尤其是面對NoSQL相對弱一致性的DB時更需注意，而在Go語言，我們可以用簡單的技巧來完成Retry的策略，在進行Retry時，我們可能會需要兩個參數：

retryPeriod：每一次重試的等待時間。
maxRetryCount：最大重試次數。

為什麼要以上兩個參數？

既然已經寫入失敗了，那麼在短時間內不斷的重試也是徒勞，因此我們可以等待一段時間後再嘗試請求，減少非必要的動作。

以下的程式碼除了會帶入Retry參數之外，也帶入了job, 而這個job function我們規範會回傳error，我們會偵測這個job的error，當error發生時就進行Retry的循環，並等待一段時間後再執行job，那過程中假設Retry的次數已經超過我們期望的最大次數時，就會回傳error，此時在呼叫retry的地方就能針對error進行處理。

接著會以MongoDB寫入為例，來示範怎麼使用上面設計的retry function。

func retry(maxRetryCount int, retryPeriod int, job func() error) error {
	for retryCount := 1; ; retryCount++ {
		err := job()
		if err == nil {
			return nil
		}
		// 進入retry模式
		if retryCount <= maxRetryCount {
			glog.Errorf("error: %s, retry: %d, max: %d, wait: %ds", err, retryCount, maxRetryCount, retryPeriod)
			time.Sleep(time.Second * time.Duration(retryPeriod))
		} else {
			return err
		}
	}
}

func Update(id string, update bson.M, timeout time.Duration, opts ...*options.FindOneAndUpdateOptions) (*mongo.SingleResult, error) {
	var result *mongo.SingleResult
	if err := b.retry(func() error {
		objID, err := primitive.ObjectIDFromHex(id)
		if err != nil {
			return err
		}
		filter := bson.M{
			"_id": objID,
		}
		ctx, cancel := context.WithTimeout(context.Background(), timeout)
		defer cancel()
		returnDocument := options.After
		defaultOpts := &options.FindOneAndUpdateOptions{
			ReturnDocument: &returnDocument,
		}
		opts = append(opts, defaultOpts)
		result = b.Collection.FindOneAndUpdate(ctx, filter, update, opts...)
		if err := result.Err(); err != nil {
			return err
		}
		return nil
	}); err != nil {
		glog.Fatal("retry失敗， 請進行後續處理")
	}
	return result, nil
}