go并发map - sync.Map

并发访问map是不安全的。所以如果希望在多协程中并发访问map，必须提供某种同步机制，常用的协程安全的访问map的方式：读写锁实现并发安全Map。一般情况下通过读写锁sync.RWMutex实现对map的并发访问控制，将map和sync.RWMutex封装一下，可以实现对map的安全并发访问。

type M struct {
     
    Map    map[interface{
     }]interface{
     }
    mu     sync.RWMutex
}
//set
	mu.Lock()
	defer mu.Unlock()
	Map = data
//get
	mu.RLock()
	defer mu.RUnlock()
	return Map[" "]

sync.Map
go1.9之后加入了支持并发安全的Map sync.Map。
sync.Map 通过一份只使用原子操作的数据和一份冗余了只读数据的加锁数据实现一定程度上的读写分离，使得大多数读操作和更新操作是原子操作，写入新数据才加锁的方式来提升性能。
1、Store 存 key,value
2、LoadOrStore 取&存
3、Load 取key对应的value
4、Range 遍历所有的key,value
5、Delete 删除key,及其value

package main
import (
    "sync"
    "fmt"
)

func main() {
     
    //开箱即用
    var sm sync.Map
    //store 方法,添加元素
    sm.Store(1,"a")
    //Load 方法，获得value
    if v,ok:=sm.Load(1);ok{
     
        fmt.Println(v)
    }
    //LoadOrStore方法，获取或者保存
    //参数是一对key：value，如果该key存在且没有被标记删除则返回原先的value（不更新）和true；不存在则store，返回该value 和false
    if vv,ok:=sm.LoadOrStore(1,"c");ok{
     
        fmt.Println(vv)
    }
    if vv,ok:=sm.LoadOrStore(2,"c");!ok{
     
        fmt.Println(vv)
    }
    //遍历该map，参数是个函数，该函数参的两个参数是遍历获得的key和value，返回一个bool值，当返回false时，遍历立刻结束。
    sm.Range(func(k,v interface{
     })bool{
     
        fmt.Print(k)
        fmt.Print(":")
        fmt.Print(v)
        fmt.Println()
        return true
    })
}

sync.Map的数据结构：

  type Map struct {
     
    // 该锁用来保护dirty
    mu Mutex
    // 存读的数据，因为是atomic.value类型，只读类型，所以它的读是并发安全的
    read atomic.Value // readOnly
    //包含最新的写入的数据，并且在写的时候，会把read 中未被删除的数据拷贝到该dirty中，因为是普通的map存在并发安全问题，需要用到上面的mu字段。
    dirty map[interface{
     }]*entry
    // 从read读数据的时候，会将该字段+1，当等于len（dirty）的时候，会将dirty拷贝到read中（从而提升读的性能）。
    misses int
}

type readOnly struct {
     
    m  map[interface{
     }]*entry
    // 如果Map.dirty的数据和m 中的数据不一样是为true
    amended bool 
}

type entry struct {
     
    //可见value是个指针类型，虽然read和dirty存在冗余情况（amended=false），但是由于是指针类型，存储的空间应该不是问题
    p unsafe.Pointer // *interface{}
}

1、Store

func (m *Map) Store(key, value interface{
     }) {
     
    // 如果m.read存在这个key，并且没有被标记删除，则尝试更新。
    read, _ := m.read.Load().(readOnly)
    if e, ok := read.m[key]; ok && e.tryStore(&value) {
     
        return
    }
    // 如果read不存在或者已经被标记删除
    m.mu.Lock()
    read, _ = m.read.Load().(readOnly)
    if e, ok := read.m[key]; ok {
     
    //如果entry被标记expunge，则表明dirty没有key，可添加入dirty，并更新entry
        if e.unexpungeLocked() {
      
            //加入dirty中
            m.dirty[key] = e
        }
        //更新value值
        e.storeLocked(&value) 
        //dirty 存在该key，更新
    } else if e, ok := m.dirty[key]; ok {
      
        e.storeLocked(&value)
        //read 和dirty都没有，新添加一条
    } else {
     
     //dirty中没有新的数据，往dirty中增加第一个新键
        if !read.amended {
      
            //将read中未删除的数据加入到dirty中
            m.dirtyLocked() 
            m.read.Store(readOnly{
     m: read.m, amended: true})
        }
        m.dirty[key] = newEntry(value) 
    }
    m.mu.Unlock()
}

//将read中未删除的数据加入到dirty中
func (m *Map) dirtyLocked() {
     
    if m.dirty != nil {
     
        return
    }
    read, _ := m.read.Load().(readOnly)
    m.dirty = make(map[interface{
     }]*entry, len(read.m))
    //read如果较大的话，可能影响性能
    for k, e := range read.m {
     
    //通过此次操作，dirty中的元素都是未被删除的，可见expunge的元素不在dirty中
        if !e.tryExpungeLocked() {
     
            m.dirty[k] = e
        }
    }
}
//判断entry是否被标记删除，并且将标记为nil的entry更新标记为expunge
func (e *entry) tryExpungeLocked() (isExpunged bool) {
     
    p := atomic.LoadPointer(&e.p)
    for p == nil {
     
        // 将已经删除标记为nil的数据标记为expunged
        if atomic.CompareAndSwapPointer(&e.p, nil, expunged) {
     
            return true
        }
        p = atomic.LoadPointer(&e.p)
    }
    return p == expunged
}
//对entry 尝试更新
func (e *entry) tryStore(i *interface{
     }) bool {
     
    p := atomic.LoadPointer(&e.p)
    if p == expunged {
     
        return false
    }
    for {
     
        if atomic.CompareAndSwapPointer(&e.p, p, unsafe.Pointer(i)) {
     
            return true
        }
        p = atomic.LoadPointer(&e.p)
        if p == expunged {
     
            return false
        }
    }
}
//read里 将标记为expunge的更新为nil
func (e *entry) unexpungeLocked() (wasExpunged bool) {
     
    return atomic.CompareAndSwapPointer(&e.p, expunged, nil)
}
//更新entry
func (e *entry) storeLocked(i *interface{
     }) {
     
    atomic.StorePointer(&e.p, unsafe.Pointer(i))
}

新加元素会先判断m.read是否存在，存在则更新，不存在添加到dirty

Delete

func (m *Map) Delete(key interface{
     }) {
     
    read, _ := m.read.Load().(readOnly)
    e, ok := read.m[key]
    //如果read中没有，并且dirty中有新元素，那么就去dirty中去找
    if !ok && read.amended {
     
        m.mu.Lock()
        //这是双检查（上面的if判断和锁不是一个原子性操作）
        read, _ = m.read.Load().(readOnly)
        e, ok = read.m[key]
        if !ok && read.amended {
     
            //直接删除
            delete(m.dirty, key)
        }
        m.mu.Unlock()
    }
    if ok {
     
    //如果read中存在该key，则将该value 赋值nil（采用标记的方式删除！）
        e.delete()
    }
}
func (e *entry) delete() (hadValue bool) {
     
    for {
     
        p := atomic.LoadPointer(&e.p)
        if p == nil || p == expunged {
     
            return false
        }
        if atomic.CompareAndSwapPointer(&e.p, p, nil) {
     
            return true
        }
    }
}

删除元素会先判断m.read是否存在，存在则从m.read中删除，不存在到dirty中删除

func (m *Map) Load(key interface{
     }) (value interface{
     }, ok bool) {
     
    //因read只读，线程安全，先查看是否满足条件
    read, _ := m.read.Load().(readOnly)
    e, ok := read.m[key]
    //如果read没有，并且dirty有新数据，那从dirty中查找，由于dirty是普通map，线程不安全，这个时候用到互斥锁了
    if !ok && read.amended {
     
        m.mu.Lock()
        // 双重检查
        read, _ = m.read.Load().(readOnly)
        e, ok = read.m[key]
        // 如果read中还是不存在，并且dirty中有新数据
        if !ok && read.amended {
     
            e, ok = m.dirty[key]
            // mssLocked（）函数是性能是sync.Map 性能得以保证的重要函数，目的讲有锁的dirty数据，替换到只读线程安全的read里
            m.missLocked()
        }
        m.mu.Unlock()
    }
    if !ok {
     
        return nil, false
    }
    return e.load()
}
//dirty 提升至read 关键函数，当misses 经过多次因为load之后，大小等于len（dirty）时候，讲dirty替换到read里，以此达到性能提升。
func (m *Map) missLocked() {
     
    m.misses++
    if m.misses < len(m.dirty) {
     
        return
    }
    //原子操作，耗时很小
    m.read.Store(readOnly{
     m: m.dirty})
    m.dirty = nil
    m.misses = 0
}

获取元素先从m.read中判断是否存在，存在读取，不存在从dirty中读取，标记misses次数，当misses>len(dirty)，将dirty替换m.read，同时清空dirty

sync.Map中的load、delete、store操作都可以保证m.read和m.dirty中不存在重复数据；sync.Map适用于读操作远大于写操作的场景