Uber Go 语言编程规范：在边界处拷贝Slices和Maps

本文讨论了在Go语言中处理Slices和Maps时需要注意的指针问题，强调了在传递和返回这些数据结构时进行深拷贝的重要性，以避免意外的数据修改和数据竞争。通过示例代码展示了如何正确地复制Slices和Maps，确保函数操作不会影响到原始数据。

slices和maps包含了指向底层数据的指针，因此在需要复制它们的时候要特别注意

接收Slices和Maps

当一个map或slice作为一个函数参数传入时，如果你存储了对它们的引用，则用户可以对其进行修改。

Bad

func (d *Driver) SetTrips(trips []Trip) {
  d.trips = trips
}

trips := ...
d1.SetTrips(trips)

// 你是要修改 d1.trips?
trips[0] = ...

Good

func (d *Driver) SetTrips(trips []Trip) {
   //进行了拷贝
  d.trips = make([]Trip, len(trips))
  copy(d.trips, trips)
}

trips := ...
d1.SetTrips(trips)

//现在我们可以修改 trips[0] ，但不会影响到 d1.trips.
trips[0] = ...

返回Slices和Maps

同样，请注意对暴露内部状态的map或slice的修改

Bad

type Stats struct {
  mu sync.Mutex
  counters map[string]int
}

// Snapshot 返回了当前状态
func (s *Stats) Snapshot() map[string]int {
  s.mu.Lock()
  defer s.mu.Unlock()

  return s.counters
}

// snapshot 不再受到 mutex锁的保护, 
// 因此对snapshot的访问都会受到数据竞争的影响
snapshot := stats.Snapshot()

Good

type Stats struct {
  mu sync.Mutex
  counters map[string]int
}

func (s *Stats) Snapshot() map[string]int {
  s.mu.Lock()
  defer s.mu.Unlock()

   //新建 赋值
  result := make(map[string]int, len(s.counters))
  for k, v := range s.counters {
    result[k] = v
  }
  return result
}

// Snapshot 现在是一个拷贝
snapshot := stats.Snapshot()