背景

延遲隊(duì)列是一種特殊的隊(duì)列，元素入隊(duì)時(shí)需要指定到期時(shí)間（或延遲時(shí)間），從隊(duì)頭出隊(duì)的元素必須是已經(jīng)到期的，而且最先到期的元素最先出隊(duì)，也就是隊(duì)列里面的元素是按照到期時(shí)間排序的，添加元素和從隊(duì)頭出隊(duì)的時(shí)間復(fù)雜度是O(log(n))。

由于以上性質(zhì)，延遲隊(duì)列一般可以用于以下場(chǎng)景（定時(shí)任務(wù)、延遲任務(wù)）：

• 緩存：用戶(hù)淘汰過(guò)期元素
• 通知：在指定時(shí)間通知用戶(hù)，比如會(huì)議開(kāi)始前30分鐘
• 訂單：30分鐘未支付取消訂單
• 超時(shí)：服務(wù)器自動(dòng)斷開(kāi)太長(zhǎng)時(shí)間沒(méi)有心跳的連接

其實(shí)在Golang中是自帶定時(shí)器的，也就是time.After()、time.AfterFunc()等函數(shù)，它們的性能也是非常好的，隨著Golang版本升級(jí)還會(huì)優(yōu)化。但是對(duì)于某些場(chǎng)景來(lái)說(shuō)確實(shí)不夠方便，比如緩存場(chǎng)景我們需要能夠支持隨機(jī)刪除定時(shí)器，隨機(jī)重置過(guò)期時(shí)間，更加靈活的刪除一小批過(guò)期元素。而且像Kafka的時(shí)間輪算法(TimeWheel)里面也用到了延遲隊(duì)列，因此還是有必要了解下如何實(shí)現(xiàn)延遲隊(duì)列。

原理

堆

延遲隊(duì)列每次出隊(duì)的是最小到期時(shí)間的元素，而堆就是用來(lái)獲取最值的數(shù)據(jù)結(jié)構(gòu)。使用堆我們可以實(shí)現(xiàn)O(log(n))時(shí)間復(fù)雜度添加元素和移除最小到期時(shí)間元素。

隨機(jī)刪除

有時(shí)候延遲隊(duì)列還需要具有隨機(jī)刪除元素的能力，可以通過(guò)以下方式實(shí)現(xiàn)：

• 元素添加刪除標(biāo)記字段：堆中每個(gè)元素都添加一個(gè)刪除標(biāo)記字段，并把這個(gè)元素的地址返回給用戶(hù)，用戶(hù)就可以標(biāo)記元素的這個(gè)字段為true，這樣元素到達(dá)堆頂時(shí)如果判斷到這個(gè)字段為true就會(huì)被清除，而延遲隊(duì)列里的元素邏輯上是一定會(huì)到達(dá)堆頂?shù)模ㄒ驗(yàn)闀r(shí)間會(huì)流逝）。這是一種懶刪除的方式。
• 元素添加堆中下標(biāo)字段（或用map記錄下標(biāo)）：堆中每個(gè)元素都添加一個(gè)堆中下標(biāo)字段，并把這個(gè)元素的地址返回給用戶(hù)，這樣我們就可以通過(guò)這個(gè)元素里面記錄的下標(biāo)快速定位元素在堆中的位置，從而刪除元素。詳細(xì)可以看文章如何實(shí)現(xiàn)一個(gè)支持O(log(n))隨機(jī)刪除元素的堆。

重置元素到期時(shí)間

如果需要重置延遲隊(duì)列里面元素的到期時(shí)間，則必須知道元素在堆中的下標(biāo)，因?yàn)橹刂玫狡跁r(shí)間之后必須對(duì)堆進(jìn)行調(diào)整，因此只能是元素添加堆中下標(biāo)字段。

Golang實(shí)現(xiàn)

這里我們實(shí)現(xiàn)一個(gè)最簡(jiǎn)單的延遲隊(duì)列，也就是不支持隨機(jī)刪除元素和重置元素的到期時(shí)間，因?yàn)橛行﹫?chǎng)景只需要添加元素和獲取到期元素這兩個(gè)功能，比如Kafka中的時(shí)間輪，而且這種簡(jiǎn)單實(shí)現(xiàn)性能會(huì)高一點(diǎn)。

代碼地址

數(shù)據(jù)結(jié)構(gòu)

主要的結(jié)構(gòu)可以看到就是一個(gè)heap，Entry是每個(gè)元素在堆中的表示，Value是具體的元素值，Expired是為了堆中元素根據(jù)到期時(shí)間排序。

mutex是一個(gè)互斥鎖，主要是保證操作并發(fā)安全。

wakeup是一個(gè)緩沖區(qū)長(zhǎng)度為1的通道，通過(guò)它實(shí)現(xiàn)添加元素的時(shí)候喚醒等待隊(duì)列不為空或者有更小到期時(shí)間元素加入的協(xié)程。（重點(diǎn)）

type Entry[T any] struct {
	Value   T
	Expired time.Time // 到期時(shí)間
}

// 延遲隊(duì)列
type DelayQueue[T any] struct {
	h      *heap.Heap[*Entry[T]]
	mutex  sync.Mutex    // 保證并發(fā)安全
	wakeup chan struct{} // 喚醒通道
}

// 創(chuàng)建延遲隊(duì)列
func New[T any]() *DelayQueue[T] {
	return &DelayQueue[T]{
		h: heap.New(nil, func(e1, e2 *Entry[T]) bool {
			return e1.Expired.Before(e2.Expired)
		}),
		wakeup: make(chan struct{}, 1),
	}
}

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

阻塞獲取元素的時(shí)候如果隊(duì)列已經(jīng)沒(méi)有元素，或者沒(méi)有元素到期，那么協(xié)程就需要掛起等待。而被喚醒的條件是元素到期、隊(duì)列不為空或者有更小到期時(shí)間元素加入。

其中元素到期協(xié)程在阻塞獲取元素時(shí)發(fā)現(xiàn)堆頂元素還沒(méi)到期，因此這個(gè)條件可以自己構(gòu)造并等待。但是條件隊(duì)列不為空和有更小到期時(shí)間元素加入則需要另外一個(gè)協(xié)程在添加元素時(shí)才能滿(mǎn)足，因此必須通過(guò)一個(gè)中間結(jié)構(gòu)來(lái)進(jìn)行協(xié)程間通信，一般Golang里面會(huì)使用Channel來(lái)實(shí)現(xiàn)。

添加元素

一開(kāi)始加了一個(gè)互斥鎖，避免并發(fā)沖突，然后把元素加到堆里。

因?yàn)槲覀僒ake()操作，既阻塞獲取元素操作，在不滿(mǎn)足條件時(shí)會(huì)去等待wakeup通道，但是等待通道前必須釋放鎖，否則Push()無(wú)法寫(xiě)入新元素去滿(mǎn)足條件隊(duì)列不為空和有更小到期時(shí)間元素加入。而從釋放鎖后到開(kāi)始讀取wakeup通道這段時(shí)間是沒(méi)有鎖保護(hù)的，如果Push()在這期間插入新元素，為了保證通道不阻塞同時(shí)又能通知到Take()協(xié)程，我們的通道的長(zhǎng)度需要是1，同時(shí)使用select+default保證在通道里面已經(jīng)有元素的時(shí)候不阻塞Push()協(xié)程。

// 添加延遲元素到隊(duì)列
func (q *DelayQueue[T]) Push(value T, delay time.Duration) {
	q.mutex.Lock()
	defer q.mutex.Unlock()
	entry := &Entry[T]{
		Value:   value,
		Expired: time.Now().Add(delay),
	}
	q.h.Push(entry)
	// 喚醒等待的協(xié)程
	// 這里表示新添加的元素到期時(shí)間是最早的，或者原來(lái)隊(duì)列為空
	// 因此必須喚醒等待的協(xié)程，因?yàn)榭梢阅玫礁绲狡诘脑?
	if q.h.Peek() == entry {
		select {
		case q.wakeup <- struct{}{}:
		default:
		}
	}
}

阻塞獲取元素

這里先判斷堆是否有元素，如果有獲取堆頂元素，然后判斷是否已經(jīng)到期，如果到期則直接出堆并返回。否則等待直到超時(shí)或者元素到期或者有新的元素到達(dá)。

這里在解鎖之前會(huì)清空wakeup通道，這樣可以保證下面讀取的wakeup通道里的元素肯定是新加入的。

// 等待直到有元素到期
// 或者ctx被關(guān)閉
func (q *DelayQueue[T]) Take(ctx context.Context) (T, bool) {
	for {
		var expired *time.Timer
		q.mutex.Lock()
		// 有元素
		if !q.h.Empty() {
			// 獲取元素
			entry := q.h.Peek()
			if time.Now().After(entry.Expired) {
				q.h.Pop()
				q.mutex.Unlock()
				return entry.Value, true
			}
			// 到期時(shí)間，使用time.NewTimer()才能夠調(diào)用Stop()，從而釋放定時(shí)器
			expired = time.NewTimer(time.Until(entry.Expired))
		}
		// 避免被之前的元素假喚醒
		select {
		case <-q.wakeup:
		default:
		}
		q.mutex.Unlock()

		// 不為空，需要同時(shí)等待元素到期
                // 并且除非expired到期，否則都需要關(guān)閉expired避免泄露
		if expired != nil {
			select {
			case <-q.wakeup: // 新的更快到期元素
				expired.Stop()
			case <-expired.C: // 首元素到期
			case <-ctx.Done(): // 被關(guān)閉
				expired.Stop()
				var t T
				return t, false
			}
		} else {
			select {
			case <-q.wakeup: // 新的更快到期元素
			case <-ctx.Done(): // 被關(guān)閉
				var t T
				return t, false
			}
		}
	}
}

Channel方式阻塞讀取

Golang里面可以使用Channel進(jìn)行流式消費(fèi)，因此簡(jiǎn)單包裝一個(gè)Channel形式的阻塞讀取接口，給通道一點(diǎn)緩沖區(qū)大小可以帶來(lái)更好的性能。

// 返回一個(gè)通道，輸出到期元素
// size是通道緩存大小
func (q *DelayQueue[T]) Channel(ctx context.Context, size int) <-chan T {
	out := make(chan T, size)
	go func() {
		for {
			entry, ok := q.Take(ctx)
			if !ok {
				return
			}
			out <- entry
		}
	}()
	return out
}

使用方式

for entry := range q.Channel(context.Background(), 10) {
    // do something
}

性能測(cè)試

這里進(jìn)行一個(gè)簡(jiǎn)單的性能測(cè)試，也就是先添加元素，然后等待到期后全部拿出來(lái)。

func BenchmarkPushAndTake(b *testing.B) {
	q := New[int]()
	b.ResetTimer()
        
        // 添加元素
	for i := 0; i < b.N; i++ {
		q.Push(i, time.Duration(i))
	}
        
        // 等待全部元素到期
	b.StopTimer()
	time.Sleep(time.Duration(b.N))
	b.StartTimer()

        // 獲取元素
	for i := 0; i < b.N; i++ {
		_, ok := q.Take(context.Background())
		if !ok {
			b.Errorf("want %v, but %v", true, ok)
		}
	}
}

測(cè)試結(jié)果：

Benchmark-8      2331534               476.8 ns/op            76 B/op          1 allocs/op

總結(jié)

堆實(shí)現(xiàn)的延遲隊(duì)列是一種實(shí)現(xiàn)起來(lái)比較簡(jiǎn)單的定時(shí)器（當(dāng)然阻塞讀取Take()是比較復(fù)雜的），由于時(shí)間復(fù)雜度是O(log(n))，因此可以滿(mǎn)足定時(shí)任務(wù)數(shù)量不是特別多的場(chǎng)景。堆實(shí)現(xiàn)的延遲隊(duì)列也是可以隨機(jī)刪除元素的，可以根據(jù)具體任務(wù)選擇是否實(shí)現(xiàn)。如果對(duì)定時(shí)器性能要求比較敏感的話(huà)可以選擇使用時(shí)間輪實(shí)現(xiàn)定時(shí)器，它可以在O(1)的時(shí)間復(fù)雜度添加和刪除一個(gè)定時(shí)器，不過(guò)實(shí)現(xiàn)起來(lái)比較復(fù)雜（挖個(gè)坑，下篇文章實(shí)現(xiàn)）。

到此這篇關(guān)于基于Golang實(shí)現(xiàn)延遲隊(duì)列(DelayQueue)的文章就介紹到這了,更多相關(guān)Golang延遲隊(duì)列內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！