Golang中的sync.Cond怎么使用

本文小編為大家詳細介紹“Golang中的sync.Cond怎么使用”，內容詳細，步驟清晰，細節處理妥當，希望這篇“Golang中的sync.Cond怎么使用”文章能幫助大家解決疑惑，下面跟著小編的思路慢慢深入，一起來學習新知識吧。

1. 基本使用

1.1 定義

sync.Cond是Go語言標準庫中的一個類型，代表條件變量。條件變量是用于多個goroutine之間進行同步和互斥的一種機制。sync.Cond可以用于等待和通知goroutine，以便它們可以在特定條件下等待或繼續執行。

1.2 方法說明

sync.Cond的定義如下，提供了Wait ,Singal,Broadcast以及NewCond方法

type Cond struct {
   noCopy noCopy
   // L is held while observing or changing the condition
   L Locker

   notify  notifyList
   checker copyChecker
}

func NewCond(l Locker) *Cond {}
func (c *Cond) Wait() {}
func (c *Cond) Signal() {}
func (c *Cond) Broadcast() {}

• NewCond方法： 提供創建Cond實例的方法

• Wait方法: 使當前線程進入阻塞狀態，等待其他協程喚醒

• Singal方法: 喚醒一個等待該條件變量的線程，如果沒有線程在等待，則該方法會立即返回。

• Broadcast方法: 喚醒所有等待該條件變量的線程，如果沒有線程在等待，則該方法會立即返回。

1.3 使用方式

當使用sync.Cond時，通常需要以下幾個步驟：

• 定義一個互斥鎖，用于保護共享數據；

• 創建一個sync.Cond對象，關聯這個互斥鎖；

• 在需要等待條件變量的地方，獲取這個互斥鎖，并使用Wait方法等待條件變量被通知；

• 在需要通知等待的協程時，使用Signal或Broadcast方法通知等待的協程。

• 最后，釋放這個互斥鎖。

1.4 使用例子    

下面是一個使用sync.Cond的簡單示例，實現了一個生產者-消費者模型：

var (
    // 1. 定義一個互斥鎖
    mu    sync.Mutex
    cond  *sync.Cond
    count int
)

func init() {
    // 2.將互斥鎖和sync.Cond進行關聯
    cond = sync.NewCond(&mu)
}

func worker(id int) {
    // 消費者
    for {
        // 3. 在需要等待的地方,獲取互斥鎖，調用Wait方法等待被通知
        mu.Lock()
        // 這里會不斷循環判斷 是否有待消費的任務
        for count == 0 {
            cond.Wait() // 等待任務
        }
        count--
        fmt.Printf("worker %d: 處理了一個任務\n", id)
        // 5. 最后釋放鎖
        mu.Unlock()
    }
}

func main() {
    // 啟動5個消費者
    for i := 1; i <= 5; i++ {
        go worker(i)
    }

    for {
        // 生產者
        time.Sleep(1 * time.Second)
        mu.Lock()
        count++
        // 4. 在需要等待的地方,獲取互斥鎖，調用BroadCast/Singal方法進行通知
        cond.Broadcast() 
        mu.Unlock()
    }
}

在這個示例中，創建一個生產者在生產任務，同時創建五個消費者來消費任務。當任務數為0時，此時消費者會調用Wait方法進入阻塞狀態，等待生產者的通知。

當生產者產生任務后，使用Broadcast方法通知所有的消費者，喚醒處于阻塞狀態的消費者，開始消費任務。這里使用sync.Cond實現多個協程之間的通信和同步。

1.5 為什么Sync.Cond 需要關聯一個鎖，然后調用Wait方法前需要先獲取該鎖

這里的原因在于調用Wait方法前如果不加鎖，有可能會出現競態條件。

這里假設多個協程都處于等待狀態，然后一個協程調用了Broadcast喚醒了其中一個或多個協程，此時這些協程都會被喚醒。

如下，假設調用Wait方法前沒有加鎖的話，那么所有協程都會去調用condition方法去判斷是否滿足條件，然后都通過驗證，執行后續操作。

for !condition() {
    c.Wait()
}
c.L.Lock()
// 滿足條件情況下,執行的邏輯
c.L.Unlock()

此時會出現的情況為，本來是需要在滿足condition方法的前提下，才能執行的操作。現在有可能的效果，為前面一部分協程執行時，還是滿足condition條件的；但是后面的協程，盡管不滿足condition條件，還是執行了后續操作，可能導致程序出錯。

正確的用法應該是，在調用Wait方法前便加鎖，那么即使多個協程被喚醒，一次也只會有一個協程判斷是否滿足condition條件，然后執行后續操作。這樣子就不會出現多個協程同時判斷，導致不滿足條件，也執行后續操作的情況出現。

c.L.Lock()
for !condition() {
    c.Wait()
}
// 滿足條件情況下,執行的邏輯
c.L.Unlock()

2.使用場景

2.1 基本說明

sync.Cond是為了協調多個協程之間對共享數據的訪問而設計的。使用sync.Cond的場景通常都涉及到對共享數據的操作，如果沒有共享數據的操作，那么沒有太大必要使用sync.Cond來進行協調。當然，如果存在重復喚醒的場景，即使沒有對共享數據的操作，也是可以使用sync.Cond來進行協調的。

通常情況下，使用sync.Cond的場景為：多個協程需要訪問同一份共享數據，需要等待某個條件滿足后才能訪問或修改這份共享數據。

在這些場景下，使用sync.Cond可以方便地實現對共享數據的協調，避免了多個協程之間的競爭和沖突，保證了共享數據的正確性和一致性。因此，如果沒有涉及到共享數據的操作，就沒有必要使用sync.Cond來進行協調。

2.2 場景說明

2.2.1 同步和協調多個協程之間共享資源

下面舉一個使用 sync.Cond 的例子，用它來實現生產者-消費者模型。生產者往items放置元素，當items滿了之后，便進入等待狀態，等待消費者喚醒。消費者從items中取數據，當items空了之后，便進入等待狀態，等待生產者喚醒。

這里多個協程對同一份數據進行操作，且需要基于該數據判斷是否喚醒其他協程或進入阻塞狀態，來實現多個協程的同步和協調。sync.Cond就適合在這種場景下使用，其正是為這種場景設計的。

package main

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

type Queue struct {
        items []int
        cap   int
        lock  sync.Mutex
        cond  *sync.Cond
}

func NewQueue(cap int) *Queue {
        q := &Queue{
            items: make([]int, 0),
            cap:   cap,
        }
        q.cond = sync.NewCond(&q.lock)
        return q
}

func (q *Queue) Put(item int) {
        q.lock.Lock()
        defer q.lock.Unlock()

        for len(q.items) == q.cap {
                q.cond.Wait()
        }

        q.items = append(q.items, item)
        q.cond.Broadcast()
}

func (q *Queue) Get() int {
        q.lock.Lock()
        defer q.lock.Unlock()

        for len(q.items) == 0 {
            q.cond.Wait()
        }

        item := q.items[0]
        q.items = q.items[1:]
        q.cond.Broadcast()

        return item
}

func main() {
        q := NewQueue(10)

        // Producer
        go func() {
            for {
                q.Put(i)
                fmt.Printf("Producer: Put %d\n", i)
                time.Sleep(100 * time.Millisecond)
            }
        }()

        // Consumer
        go func() {
            for {
                    item := q.Get()
                    fmt.Printf("Consumer: Get %d\n", item)
                    time.Sleep(200 * time.Millisecond)
            }
        }()

        wg.Wait()
}

2.2.2 需要重復喚醒的場景中使用

在某些場景中，由于不滿足某種條件，此時協程進入阻塞狀態，等待條件滿足后，由其他協程喚醒，再繼續執行。在整個流程中，可能會多次進入阻塞狀態，多次被喚醒的情況。

比如上面生產者和消費者模型的例子，生產者可能會產生一批任務，然后喚醒消費者，消費者消費完之后，會進入阻塞狀態，等待下一批任務的到來。所以這個流程中，協程可能多次進入阻塞狀態，然后再多次被喚醒。

sync.Cond能夠實現即使協程多次進入阻塞狀態，也能重復喚醒該協程。所以，當出現需要實現重復喚醒的場景時，使用sync.Cond也是非常合適的。

3. 原理

3.1 基本原理

在Sync.Cond存在一個通知隊列，保存了所有處于等待狀態的協程。通知隊列定義如下:

type notifyList struct {
   wait   uint32
   notify uint32
   lock   uintptr // key field of the mutex
   head   unsafe.Pointer
   tail   unsafe.Pointer
}

當調用Wait方法時，此時Wait方法會釋放所持有的鎖，然后將自己放到notifyList等待隊列中等待。此時會將當前協程加入到等待隊列的尾部，然后進入阻塞狀態。

當調用Signal 時，此時會喚醒等待隊列中的第一個協程，其他繼續等待。如果此時沒有處于等待狀態的協程，調用Signal不會有其他作用，直接返回。當調用BoradCast方法時，則會喚醒notfiyList中所有處于等待狀態的協程。

sync.Cond的代碼實現比較簡單，協程的喚醒和阻塞已經由運行時包實現了，sync.Cond的實現直接調用了運行時包提供的API。

3.2 實現

3.2.1 Wait方法實現

Wait方法首先調用runtime_notifyListAd方法，將自己加入到等待隊列中，然后釋放鎖，等待其他協程的喚醒。

func (c *Cond) Wait() {
   // 將自己放到等待隊列中
   t := runtime_notifyListAdd(&c.notify)
   // 釋放鎖
   c.L.Unlock()
   // 等待喚醒
   runtime_notifyListWait(&c.notify, t)
   // 重新獲取鎖
   c.L.Lock()
}

3.2.2 Singal方法實現

Singal方法調用runtime_notifyListNotifyOne喚醒等待隊列中的一個協程。

func (c *Cond) Signal() {
   // 喚醒等待隊列中的一個協程
   runtime_notifyListNotifyOne(&c.notify)
}

3.2.3 Broadcast方法實現

Broadcast方法調用runtime_notifyListNotifyAll喚醒所有處于等待狀態的協程。

func (c *Cond) Broadcast() {
   // 喚醒等待隊列中所有的協程
   runtime_notifyListNotifyAll(&c.notify)
}

4.使用注意事項

4.1 調用Wait方法前未加鎖

在上面2.5已經說明了，調用Sync.Cond方法前需要加鎖，否則有可能出現競態條件。而且，現有的sync.Cond的實現，如果在調用Wait方法前未加鎖，此時會直接panic，下面是一個簡單例子的說明:

package main

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

var (
   count int
   cond  *sync.Cond
   lk    sync.Mutex
)

func main() {
    cond = sync.NewCond(&lk)
    wg := sync.WaitGroup{}
    wg.Add(2)
    go func() {
       defer wg.Done()
       for {
          time.Sleep(time.Second)
          count++
          cond.Broadcast()
       }
    }()
    
    go func() {
       defer wg.Done()
       for {
          time.Sleep(time.Millisecond * 500)          
          //cond.L.Lock() 
          for count%10 != 0 {
               cond.Wait()
          }
          t.Logf("count = %d", count)
          //cond.L.Unlock()  
       }
    }()
    wg.Wait()
}

上面代碼中，協程一每隔1s，將count字段的值自增1，然后喚醒所有處于等待狀態的協程。協程二執行的條件為count的值為10的倍數，此時滿足執行條件，喚醒后將會繼續往下執行。

但是這里在調用sync.Wait方法前，沒有先獲取鎖，下面是其執行結果，會拋出 fatal error: sync: unlock of unlocked mutex 錯誤，結果如下:

count = 0
fatal error: sync: unlock of unlocked mutex

因此，在調用Wait方法前，需要先獲取到與sync.Cond關聯的鎖，否則會直接拋出異常。

4.2 Wait方法接收到通知后，未重新檢查條件變量

調用sync.Wait方法，協程進入阻塞狀態后被喚醒，沒有重新檢查條件變量，此時有可能仍然處于不滿足條件變量的場景下。然后直接執行后續操作，有可能會導致程序出錯。下面舉一個簡單的例子:

package main

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

var (
   count int
   cond  *sync.Cond
   lk    sync.Mutex
)

func main() {
    cond = sync.NewCond(&lk)
    wg := sync.WaitGroup{}
    wg.Add(3)
    go func() {
       defer wg.Done()
       for {
          time.Sleep(time.Second)
          cond.L.Lock()
          // 將flag 設置為true
          flag = true
          // 喚醒所有處于等待狀態的協程
          cond.Broadcast()
          cond.L.Unlock()
       }
    }()
    
    for i := 0; i < 2; i++ {
       go func(i int) {
          defer wg.Done()
          for {
             time.Sleep(time.Millisecond * 500)
             cond.L.Lock()
             // 不滿足條件，此時進入等待狀態
             if !flag {
                cond.Wait()
             }
             // 被喚醒后，此時可能仍然不滿足條件
             fmt.Printf("協程 %d flag = %t", i, flag)
             flag = false
             cond.L.Unlock()
          }
       }(i)
    }
    wg.Wait()
}

在這個例子，我們啟動了一個協程，定時將flag設置為true，相當于每隔一段時間，便滿足執行條件，然后喚醒所有處于等待狀態的協程。

然后又啟動了兩個協程，在滿足條件的前提下，開始執行后續操作，但是這里協程被喚醒后，沒有重新檢查條件變量，具體看第39行。這里會出現的場景是，第一個協程被喚醒后，此時執行后續操作，然后將flag重新設置為false，此時已經不滿足條件了。之后第二個協程喚醒后，獲取到鎖，沒有重新檢查此時是否滿足執行條件，直接向下執行，這個就和我們預期不符，可能會導致程序出錯，代碼執行效果如下:

協程 1 flag = true
協程 0 flag = false
協程 1 flag = true
協程 0 flag = false

可以看到，此時協程0執行時，flag的值均為false,說明此時其實并不符合執行條件，可能會導致程序出錯。因此正確用法應該像下面這樣子，被喚醒后，需要重新檢查條件變量，滿足條件之后才能繼續向下執行。

c.L.Lock()
// 喚醒后,重新檢查條件變量是否滿足條件
for !condition() {
    c.Wait()
}
// 滿足條件情況下,執行的邏輯
c.L.Unlock()

讀到這里，這篇“Golang中的sync.Cond怎么使用”文章已經介紹完畢，想要掌握這篇文章的知識點還需要大家自己動手實踐使用過才能領會，如果想了解更多相關內容的文章，歡迎關注億速云行業資訊頻道。