go-resiliency源碼解析之-timeout

1.go-resiliency簡介

? 今天看到項目里用到了go-resiliency這個庫，庫整體比較簡單，代碼量不大。主要實現go中幾種常見的模式：

后面分析下這幾種模式的實現

- circuit-breaker 熔斷器 - semaphore 信號量 - timeout 函數超時 - batching 批處理 - retriable 可重復

2.timeout模式

先看看模式的test用例

import ("errors""testing""time" )func takesFiveSecond(stopper <-chan struct{}) error {time.Sleep(5 * time.Second)return nil }func takesTwentySecond(stopper <-chan struct{}) error {time.Sleep(20 * time.Second)return nil }func TestDeadline(t *testing.T) {dl := New(10 * time.Second)//執行takesFiveSecondif err := dl.Run(takesFiveSecond); err != nil {t.Error(err)}//執行takesTwentySecondif err := dl.Run(takesTwentySecond); err == ErrTimedOut {t.Error(err)} }

這里先dl := New(10 * time.Second)創建timeout對象Deadline，可以看到Deadline只有一個變量，就是超時時間。

執行函數調用dl.Run(takesFiveSecond)，如果調用的函數執行時間大于變量timeout，會返回失敗。

3.源碼實現如下

type Deadline struct {timeout time.Duration }func New(timeout time.Duration) *Deadline {return &Deadline{timeout: timeout,} }

Deadline對象只有一個timeout成員變量

Run核心函數：

//1. 可以看到Run函數有一個入參是一個函數，函數的原型為func (<-chan struct{}))error 也就是說我們傳入work變量就需要定義一個這個的簽名函數。 //2. Run函數返回error，這個返回實際是入參work函數返回的。 //3.為什么work函數變量，要有一個chan了？ 這個主要為了能讓work函數里來控制，Run提前退出 func (d *Deadline) Run(work func(<-chan struct{}) error) error {result := make(chan error)stopper := make(chan struct{})//啟動一個協程go func() {value := work(stopper)select {case result <- value:case <-stopper:}}()//這里是判斷是否超時常用手法，通過select監聽2個chan,一個讀取結果，一個為超時定時器。//如果在timeout時間內未讀取到執行結果，就觸發time.After返回超時select {case ret := <-result:return retcase <-time.After(d.timeout):close(stopper)return ErrTimedOut} }

Run函數定義：Run(work func(<-chan struct{}) error) error ：

可以看到Run函數有一個入參是一個函數，函數的原型為func (<-chan struct{}))error 也就是說我們傳入work變量就需要定義一個這個的簽名函數。

Run函數返回error，這個返回實際是入參work函數返回的。

4.擴展一下，go語言里超時控制還有其他常用方式嗎

對就是context.WithTimeout，讓我們使用context.WithTimeout來重新實現上面的對象,只需要修改一個地方

import ("context""errors""time" )var ErrTimedOut = errors.New("timed out waiting for function to finish")type ContextTimeOut struct {timeout time.Duration }// New constructs a new Deadline with the given timeout. func New(timeout time.Duration) *ContextTimeOut {return &ContextTimeOut{timeout: timeout,} }func (d *ContextTimeOut) Run(work func(<-chan struct{}) error) error {result := make(chan error)stopper := make(chan struct{})go func() {value := work(stopper)select {case result <- value:case <-stopper:}}()ctx, _ := context.WithTimeout(context.Background(), d.timeout)select {case ret := <-result:return retcase <-ctx.Done():close(stopper)return ErrTimedOut} }

總結

以上是生活随笔為你收集整理的go-resiliency源码解析之-timeout的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。