一文淺析Golang中的sync.Map-Golang-PHP中文網

這篇文章帶大家學習Golang，深入理解下Golang中的sync.Map，希望對大家有幫助！

一文淺析Golang中的sync.Map

我們知道，go 裡面提供了map 這種類型讓我們可以儲存鍵值對數據，但是如果我們在並發的情況下使用map 的話，就會發現它是不支援並發地進行讀寫的（會報錯）。在這種情況下，我們可以使用 sync.Mutex 來確保並發安全，但是這樣會導致我們在讀寫的時候，都需要加鎖，這樣就會導致效能的下降。除了使用互斥鎖這種相對低效的方式，我們還可以使用sync.Map 來確保並發安全，它在某些場景下有比使用sync.Mutex 更高的性能。本文就來探討 sync.Map 中的一些大家比較有興趣的問題，例如為什麼有了 map 還要 sync.Map？它為什麼快？ sync.Map 的適用場景（注意：不是所有情況下都快。）等。

關於 sync.Map 的設計與實作原理，會在下一篇再做講解。

map 在並發下的問題

如果我們看過map 的源碼，就會發現其中有不少會引起fatal 錯誤的地方，例如mapaccess1（從map 中讀取key 的函數）裡面，如果發現正在寫map，則會有fatal 錯誤。【相關推薦：Go影片教學、程式設計教學】

if h.flags&hashWriting != 0 {
    fatal("concurrent map read and map write")
}

登入後複製

map 並發讀寫異常的範例

下面是一個實際使用中的範例：

var m = make(map[int]int)

// 往 map 写 key 的协程
go func() {
   // 往 map 写入数据
    for i := 0; i < 10000; i++ {
        m[i] = i
    }
}()

// 从 map 读取 key 的协程
go func() {
   // 从 map 读取数据
    for i := 10000; i > 0; i-- {
        _ = m[i]
    }
}()

// 等待两个协程执行完毕
time.Sleep(time.Second)

登入後複製

這會導致報錯：

fatal error: concurrent map read and map write

登入後複製

這是因為我們同時對map 進行讀寫，而map 不支援並發讀寫，所以會報錯。如果 map 允許並發讀寫，那麼可能在我們使用的時候會有很多錯亂的情況出現。（具體如何錯亂，我們可以比較多執行緒的場景思考一下，本文不展開了）。

使用sync.Mutex 保證並發安全性

對於map 並發讀寫錯誤的問題，其中一個解決方案就是使用sync.Mutex#來保證並發安全，但是這樣會導致我們在讀寫的時候，都需要加鎖，這樣就會導致效能的下降。

使用sync.Mutex 來保證並發安全，上面的程式碼可以改成下面這樣：

var m = make(map[int]int)
// 互斥锁
var mu sync.Mutex

// 写 map 的协程
go func() {
    for i := 0; i < 10000; i++ {
        mu.Lock() // 写 map，加互斥锁
        m[i] = i
        mu.Unlock()
    }
}()

// 读 map 的协程序
go func() {
    for i := 10000; i > 0; i-- {
        mu.Lock() // 读 map，加互斥锁
        _ = m[i]
        mu.Unlock()
    }
}()

time.Sleep(time.Second)

登入後複製

這樣就不會報錯了，但是效能會有所下降，因為我們在讀寫的時候都需要加鎖。（如果需要更高效能，可以繼續讀下去，不要急著使用sync.Mutex）

sync.Mutex 的常見的用法是在結構體中嵌入sync.Mutex，而不是定義獨立的兩個變數。

使用sync.RWMutex 保證並發安全

在上一小節中，我們使用了sync.Mutex 來確保並發安全，但是在讀和寫的時候我們都需要加互斥鎖。這就意味著，就算多個協程進行並發讀，也需要等待鎖定。但是互斥鎖的粒度太大了，但實際上，並發讀是沒有什麼太大問題的，應該被允許才對，如果我們允許並發讀，那麼就可以提高性能。

當然go 的開發者也考慮到了這一點，所以在sync 套件中提供了sync.RWMutex，這個鎖定可以允許進行並發讀，但寫的時候還是需要等待鎖。也就是說，一個協程在持有寫鎖的時候，其他協程是既不能讀也不能寫的，只能等待寫鎖釋放才能進行讀寫。

使用sync.RWMutex 來確保並發安全，我們可以改成下面這樣：

var m = make(map[int]int)
// 读写锁（允许并发读，写的时候是互斥的）
var mu sync.RWMutex

// 写入 map 的协程
go func() {
    for i := 0; i < 10000; i++ {
        // 写入的时候需要加锁
        mu.Lock()
        m[i] = i
        mu.Unlock()
    }
}()

// 读取 map 的协程
go func() {
    for i := 10000; i > 0; i-- {
        // 读取的时候需要加锁，但是这个锁是读锁
        // 多个协程可以同时使用 RLock 而不需要等待
        mu.RLock()
        _ = m[i]
        mu.RUnlock()
    }
}()

// 另外一个读取 map 的协程
go func() {
    for i := 20000; i > 10000; i-- {
        // 读取的时候需要加锁，但是这个锁是读锁
        // 多个协程可以同时使用 RLock 而不需要等待
        mu.RLock()
        _ = m[i]
        mu.RUnlock()
    }
}()

time.Sleep(time.Second)

登入後複製

這樣就不會報錯了，而且效能也提高了，因為我們在讀的時候，不需要等待鎖。

說明：

多個協程可以同時使用 RLock 而不需要等待，這是讀鎖定。
只有一個協程可以使用 Lock，這是寫鎖，有寫鎖的時候，其他協程不能讀也不能寫。
持有寫鎖的協程，可以使用 Unlock 來釋放鎖定。
寫入鎖定釋放之後，其他協程才能取得到鎖定（讀取鎖定或寫入鎖定）。

也就是說，使用 sync.RWMutex 的時候，讀取操作是可以並發執行的，但是寫入操作是互斥的。這樣一來，比起 sync.Mutex 來說等待鎖的次數就少了，自然也就能獲得更好的效能了。

gin 框架里面就使用了 sync.RWMutex 来保证 Keys 读写操作的并发安全。

有了读写锁为什么还要有 sync.Map？

通过上面的内容，我们知道了，有下面两种方式可以保证并发安全：

使用 sync.Mutex，但是这样的话，读写都是互斥的，性能不好。
使用 sync.RWMutex，可以并发读，但是写的时候是互斥的，性能相对 sync.Mutex 要好一些。

但是就算我们使用了 sync.RWMutex，也还是有一些锁的开销。那么我们能不能再优化一下呢？答案是可以的。那就是使用 sync.Map。

sync.Map 在锁的基础上做了进一步优化，在一些场景下使用原子操作来保证并发安全，性能更好。

使用原子操作替代读锁

但是就算使用 sync.RWMutex，读操作依然还有锁的开销，那么有没有更好的方式呢？答案是有的，就是使用原子操作来替代读锁。

举一个很常见的例子就是多个协程同时读取一个变量，然后对这个变量进行累加操作：

var a int32

var wg sync.WaitGroup
wg.Add(2)

go func() {
    for i := 0; i < 10000; i++ {
        a++
    }
    wg.Done()
}()

go func() {
    for i := 0; i < 10000; i++ {
        a++
    }
    wg.Done()
}()

wg.Wait()

// a 期望结果应该是 20000才对。
fmt.Println(a) // 实际：17089，而且每次都不一样

登入後複製

这个例子中，我们期望的结果是 a 的值是 20000，但是实际上，每次运行的结果都不一样，而且都不会等于 20000。其中很简单粗暴的一种解决方法是加锁，但是这样的话，性能就不好了，但是我们可以使用原子操作来解决这个问题：

var a atomic.Int32

var wg sync.WaitGroup
wg.Add(2)

go func() {
    for i := 0; i < 10000; i++ {
        a.Add(1)
    }
    wg.Done()
}()

go func() {
    for i := 0; i < 10000; i++ {
        a.Add(1)
    }
    wg.Done()
}()

wg.Wait()

fmt.Println(a.Load()) // 20000

登入後複製

锁跟原子操作的性能差多少？

我们来看一下，使用锁和原子操作的性能差多少：

func BenchmarkMutexAdd(b *testing.B) {
   var a int32
   var mu sync.Mutex

   for i := 0; i < b.N; i++ {
      mu.Lock()
      a++
      mu.Unlock()
   }
}

func BenchmarkAtomicAdd(b *testing.B) {
   var a atomic.Int32
   for i := 0; i < b.N; i++ {
      a.Add(1)
   }
}

登入後複製

结果：

BenchmarkMutexAdd-12       100000000          10.07 ns/op
BenchmarkAtomicAdd-12      205196968           5.847 ns/op

登入後複製

我们可以看到，使用原子操作的性能比使用锁的性能要好一些。

也许我们会觉得上面这个例子是写操作，那么读操作呢？我们来看一下：

func BenchmarkMutex(b *testing.B) {
   var mu sync.RWMutex

   for i := 0; i < b.N; i++ {
      mu.RLock()
      mu.RUnlock()
   }
}

func BenchmarkAtomic(b *testing.B) {
   var a atomic.Int32
   for i := 0; i < b.N; i++ {
      _ = a.Load()
   }
}

登入後複製

结果：

BenchmarkMutex-12      100000000          10.12 ns/op
BenchmarkAtomic-12     1000000000          0.3133 ns/op

登入後複製

我们可以看到，使用原子操作的性能比使用锁的性能要好很多。而且在 BenchmarkMutex 里面甚至还没有做读取数据的操作。

sync.Map 里面的原子操作

sync.Map 里面相比 sync.RWMutex，性能更好的原因就是使用了原子操作。在我们从 sync.Map 里面读取数据的时候，会先使用一个原子 Load 操作来读取 sync.Map 里面的 key（从 read 中读取）。注意：这里拿到的是 key 的一份快照，我们对其进行读操作的时候也可以同时往 sync.Map 中写入新的 key，这是保证它高性能的一个很关键的设计（类似读写分离）。

sync.Map 里面的 Load 方法里面就包含了上述的流程：

// Load 方法从 sync.Map 里面读取数据。
func (m *Map) Load(key any) (value any, ok bool) {
   // 先从只读 map 里面读取数据。
   // 这一步是不需要锁的，只有一个原子操作。
   read := m.loadReadOnly()
   e, ok := read.m[key]
   if !ok && read.amended { // 如果没有找到，并且 dirty 里面有一些 read 中没有的 key，那么就需要从 dirty 里面读取数据。
      // 这里才需要锁
      m.mu.Lock()
      read = m.loadReadOnly()
      e, ok = read.m[key]
      if !ok && read.amended {
         e, ok = m.dirty[key]
         m.missLocked()
      }
      m.mu.Unlock()
   }
   
   // key 不存在
   if !ok {
      return nil, false
   }
   // 使用原子操作读取
   return e.Load()
}

登入後複製

上面的代码我们可能还看不懂，但是没关系，这里我们只需要知道的是，从 sync.Map 读取数据的时候，会先做原子操作，如果没找到，再进行加锁操作，这样就减少了使用锁的频率了，自然也就可以获得更好的性能（但要注意的是并不是所有情况下都能获得更好的性能）。至于具体实现，在下一篇文章中会进行更加详细的分析。

也就是说，sync.Map 之所以更快，是因为相比 RWMutex，进一步减少了锁的使用，而这也就是 sync.Map 存在的原因了

sync.Map 的基本用法

现在我们知道了，sync.Map 里面是利用了原子操作来减少锁的使用。但是我们好像连 sync.Map 的一些基本操作都还不了解，现在就让我们再来看看 sync.Map 的基本用法。

sync.Map 的使用还是挺简单的，map 中有的操作，在 sync.Map 都有，只不过区别是，在 sync.Map 中，所有的操作都需要通过调用其方法来进行。sync.Map 里面几个常用的方法有（CRUD）：

Store：我们新增或者修改数据的时候，都可以使用 Store 方法。
Load：读取数据的方法。
Range：遍历数据的方法。
Delete：删除数据的方法。

var m sync.Map

// 写入/修改
m.Store("foo", 1)

// 读取
fmt.Println(m.Load("foo")) // 1 true

// 遍历
m.Range(func(key, value interface{}) bool {
    fmt.Println(key, value) // foo 1
    return true
})

// 删除
m.Delete("foo")
fmt.Println(m.Load("foo")) // nil false

登入後複製

注意：在 sync.Map 中，key 和 value 都是 interface{} 类型的，也就是说，我们可以使用任意类型的 key 和 value。而不像 map，只能存在一种类型的 key 和 value。从这个角度来看，它的类型类似于 map[any]any。

另外一个需要注意的是，Range 方法的参数是一个函数，这个函数如果返回 false，那么遍历就会停止。

sync.Map 的使用场景

在 sync.Map 源码中，已经告诉了我们 sync.Map 的使用场景：

The Map type is optimized for two common use cases: (1) when the entry for a given
key is only ever written once but read many times, as in caches that only grow,
or (2) when multiple goroutines read, write, and overwrite entries for disjoint
sets of keys. In these two cases, use of a Map may significantly reduce lock
contention compared to a Go map paired with a separate Mutex or RWMutex.

登入後複製

翻译过来就是，Map 类型针对两种常见用例进行了优化：

当给定 key 的条目只写入一次但读取多次时，如在只会增长的缓存中。（读多写少）
当多个 goroutine 读取、写入和覆盖不相交的键集的条目。（不同 goroutine 操作不同的 key）

在这两种情况下，与 Go map 与单独的 Mutex 或 RWMutex 配对相比，使用 sync.Map 可以显著减少锁竞争（很多时候只需要原子操作就可以）。

总结

普通的 map 不支持并发读写。
有以下两种方式可以实现 map 的并发读写：
- 使用 sync.Mutex 互斥锁。读和写的时候都使用互斥锁，性能相比 sync.RWMutex 会差一些。
- 使用 sync.RWMutex 读写锁。读的锁是可以共享的，但是写锁是独占的。性能相比 sync.Mutex 会好一些。
sync.Map 里面会先进行原子操作来读取 key，如果读取不到的时候，才会需要加锁。所以性能相比 sync.Mutex 和 sync.RWMutex 会好一些。
sync.Map 里面几个常用的方法有（CRUD）：
- Store：我们新增或者修改数据的时候，都可以使用 Store 方法。
- Load：读取数据的方法。
- Range：遍历数据的方法。
- Delete：删除数据的方法。
sync.Map 的使用场景，sync.Map 针对以下两种场景做了优化：
- key 只会写入一次，但是会被读取多次的场景。
- 多个 goroutine 读取、写入和覆盖不相交的键集的条目。