Go語言如何實(shí)現(xiàn)線程安全的Map

更新時(shí)間：2024年11月26日 09:09:30 作者：熬了夜的程序員

Go語言內(nèi)置的map雖然高效,但并不是線程安全的,若在多線程環(huán)境中直接操作map,可能會(huì)引發(fā)并發(fā)寫入的錯(cuò)誤,下面我們就來看看如何實(shí)現(xiàn)線程安全的Map吧

在并發(fā)編程中，數(shù)據(jù)共享和訪問是一個(gè)重要的主題。Go語言內(nèi)置的map雖然高效，但并不是線程安全的。若在多線程環(huán)境中直接操作map，可能會(huì)引發(fā)并發(fā)寫入的錯(cuò)誤（fatal error: concurrent map writes）。因此，在需要并發(fā)訪問map時(shí)，必須采取措施確保線程安全。

本文將介紹如何使用Go語言的泛型和sync.RWMutex實(shí)現(xiàn)一個(gè)線程安全的Map，同時(shí)支持常見的操作，例如增刪改查、遍歷和轉(zhuǎn)化為普通的Map。

1. 為什么需要線程安全的Map

Go語言內(nèi)置的map在多線程環(huán)境中并不安全。例如，以下代碼可能引發(fā)崩潰：

package main

import (
	"fmt"
	"sync"
)

func main() {
	m := make(map[int]int)
	var wg sync.WaitGroup

	for i := 0; i < 10; i++ {
		wg.Add(1)
		go func(i int) {
			defer wg.Done()
			m[i] = i
		}(i)
	}

	wg.Wait()
	fmt.Println(m)
}

運(yùn)行上述代碼可能會(huì)報(bào)錯(cuò)：fatal error: concurrent map writes。這是因?yàn)閙ap的寫操作沒有加鎖，在多線程中引發(fā)了競態(tài)條件。

2. 如何實(shí)現(xiàn)線程安全的Map

Go標(biāo)準(zhǔn)庫提供了sync.Map，它是線程安全的。但它的API相對(duì)簡單，缺乏泛型支持且性能在某些場(chǎng)景下并不理想。因此，我們可以基于sync.RWMutex和泛型封裝一個(gè)自定義的線程安全Map。

2.1 基本實(shí)現(xiàn)

以下是線程安全SyncMap的完整實(shí)現(xiàn)：

package syncmap

import (
	"sync"
)

// SyncMap 定義了一個(gè)線程安全的泛型Map
type SyncMap[K comparable, V any] struct {
	mu sync.RWMutex
	m  map[K]V
}

// NewSyncMap 創(chuàng)建一個(gè)新的線程安全的SyncMap
func NewSyncMap[K comparable, V any]() *SyncMap[K, V] {
	return &SyncMap[K, V]{
		m: make(map[K]V),
	}
}

// Load 獲取指定key的值，如果存在返回值和true，否則返回零值和false
func (s *SyncMap[K, V]) Load(key K) (V, bool) {
	s.mu.RLock()
	defer s.mu.RUnlock()
	val, ok := s.m[key]
	return val, ok
}

// Store 設(shè)置指定key的值，如果key已存在會(huì)覆蓋舊值
func (s *SyncMap[K, V]) Store(key K, value V) {
	s.mu.Lock()
	defer s.mu.Unlock()
	s.m[key] = value
}

// Has returns true if the key exists in the map.
func (s *SyncMap[K, V]) Has(key K) bool {
	s.mu.RLock()
	defer s.mu.RUnlock()

	_, ok := s.m[key]
	return ok
}


// Delete 刪除指定key的值
func (s *SyncMap[K, V]) Delete(key K) {
	s.mu.Lock()
	defer s.mu.Unlock()
	delete(s.m, key)
}

// Range 遍歷所有的鍵值對(duì)，callback函數(shù)返回false時(shí)停止遍歷
func (s *SyncMap[K, V]) Range(callback func(key K, value V) bool) {
	s.mu.RLock()
	defer s.mu.RUnlock()
	for k, v := range s.m {
		if !callback(k, v) {
			break
		}
	}
}

// Len returns the length of the map.
func (s *SyncMap[K, V]) Len() int {
	s.mu.RLock()
	defer s.mu.RUnlock()
	return len(s.m)
}

// ToMap 轉(zhuǎn)化為普通的map，返回一個(gè)線程安全的副本
func (s *SyncMap[K, V]) ToMap() map[K]V {
	s.mu.RLock()
	defer s.mu.RUnlock()

	copyMap := make(map[K]V, len(s.m))
	for k, v := range s.m {
		copyMap[k] = v
	}
	return copyMap
}

2.2 關(guān)鍵功能說明

線程安全：

讀操作使用sync.RWMutex的RLock，允許并發(fā)讀取。
寫操作使用sync.RWMutex的Lock，確保寫操作互斥。

支持泛型：

通過K和V泛型參數(shù)支持任意鍵值類型，其中K必須是可比較的。

基本操作：

Load：獲取值。
Store：設(shè)置值。
Has：判斷鍵是否存在。
Delete：刪除鍵值對(duì)。
Range：遍歷所有鍵值對(duì)。
Len：獲取map的長度。
ToMap：轉(zhuǎn)化為普通map。

3. 使用示例

以下代碼演示了SyncMap的基本用法：

package main

import (
	"fmt"
	"syncmap"
)

func main() {
	// 創(chuàng)建一個(gè)線程安全的Map
	m := syncmap.NewSyncMap[string, int]()

	// 添加值
	m.Store("one", 1)
	m.Store("two", 2)

	// 獲取值
	if val, ok := m.Load("one"); ok {
		fmt.Println("Key 'one':", val)
	} else {
		fmt.Println("Key 'one' not found")
	}

	// 刪除值
	m.Delete("one")

	// 遍歷所有鍵值對(duì)
	m.Range(func(key string, value int) bool {
		fmt.Printf("Key: %s, Value: %d
", key, value)
		return true
	})

	// 轉(zhuǎn)化為普通map
	ordinaryMap := m.ToMap()
	fmt.Println("Ordinary map:", ordinaryMap)
}

運(yùn)行結(jié)果：