Go语言append缺陷引发的深度拷贝讨论

简介: Go语言append缺陷引发的深度拷贝讨论

看完苏炳添进入总决赛,看得我热血沸腾的,上厕所都不敢耽搁超过 5 分钟。

这历史性的一刻,让本决定休息的我,垂死病中惊坐起,开始肝文章。


引子


今天的文章从我周六加班改的一个bug引入,上下文是在某个struct中有个Labels切片,在组装数据的时候需要为其加上配置变量中的标签。


大家看看会出现什么问题。


for i := range m{
    m[i].Labels = append(r.Config.Relabel, m[i].Labels...)
    ...
}

debug发现,i=0时正常,但第二次乃至第n次会不断变更之前m[?].Labels的内容。


看了append的源码,原来当容量足够的时候,append会把数据直接添加到第一个参数的切片里。


改为如下代码,调换下了位置,一切正常了。


m[i].Labels = append(m[i].Labels,r.Config.Relabel...)

这是一个隐含的陷阱,在 go 语言中赋值拷贝往往都是浅拷贝,开发者很容易不小心忽视这一点,导致这种无法预料的问题出现,以后要多多注意了。

借由这个问题以及上一篇文章的作业中,提到的深度拷贝问题展开今天的文章。


何谓浅?何谓深?


我多年以前是做c++的,它的对象拷贝是浅拷贝,原理是调用了默认的拷贝构造函数,需要人为的重写,进行拷贝的过程,特别是指针需要谨慎的生成的释放,来避免内存泄露的发生。


后来接触了Python 发现深浅拷贝的问题在后端语言中都是存在的,Go 也不例外。


浅拷贝对于值类型是完全拷贝一份,而对于引用类型是拷贝其地址。也就是拷贝的对象修改引用类型的变量同样会影响到源对象。


这就是为什么channel在做参数传递的时候,向内部写入内容,接收端可以成功收到的原因。


在Go中,指针、slice、channel、interface、map、函数都是浅拷贝。最容易出问题的就是指针、切片、map这三种类型。


方便的点是作为参数传递不需要取地址可以直接修改其内容,只要函数内部不出现覆盖就不需要返回值。


但作为结构体中的成员变量,在拷贝结构体后问题就暴露出来了。修改一处导致另一处也变了。


深拷贝的四种方式


有一次和女朋友聊到深拷贝的问题,她告诉我最方便的深拷贝方法就是序列化为json再反序列化。

我听到这种方案,顿时惊为天人,确实挺省事的,但由于序列化会用到反射,效率自然不会太高。


深拷贝有四种方式


1、手写拷贝函数

2、json序列化反序列化

3、gob序列化反序列化

4、使用反射

github上的开源库,大多基于 1、4 两种方式做的优化。这里的反射方法后面再做讨论。


我的github https://github.com/minibear2333/ 后续会专门写一个组件,提供深度拷贝的各种现成的方式。


手写拷贝函数


定义一个包含切片、字典、指针的结构体。


type Foo struct {
  List   []int
  FooMap map[string]string
  intPtr *int
}

手动拷贝函数,把它取名为Duplicate

func (f *Foo) Duplicate() Foo {
  var tmp = Foo{
    List:   make([]int, 0, len(f.List)),
    FooMap: make(map[string]string),
    intPtr: new(int),
  }
  copy(tmp.List, f.List)
  for i := range f.FooMap {
    tmp.FooMap[i] = f.FooMap[i]
  }
  if f.intPtr != nil {
    *tmp.intPtr = *f.intPtr
  } else {
    tmp.intPtr = nil
  }
  return tmp
}


  • 函数内部初始化结构体
  • copy是标准库自带的拷贝函数
  • map只能range来拷贝,这里mapnil不会报错
  • 指针使用前必须判空,为指针的指向赋值,而不能覆盖指针地址

测试

func main() {
  var a = 1
  var t1 = Foo{intPtr: &a}
  t2 := t1.Duplicate()
  a = 2
  fmt.Println(*t1.intPtr)
  fmt.Println(*t2.intPtr)
}

输出说明深拷贝成功


2
1


json序列化反序列化


这种方式完成深度拷贝非常简单,但必须结构体加上注解,而且不允许出现私有字段


type Foo struct {
  List   []int             `json:"list"`
  FooMap map[string]string `json:"foo_map"`
  IntPtr *int              `json:"int_ptr"`
}


提供一个直接的方案

func DeepCopyByJson(dst, src interface{}) error {
  b, err := json.Marshal(src)
  if err != nil {
    return err
  }
  err = json.Unmarshal(b, dst)
  return err
}


  • 其中srcdst是同一种结构体类型
  • dst使用时必须取地址,因为要给地址指向的数据变更新值

用法,我省略了错误处理

a = 3
t1 = Foo{IntPtr: &a}
t2 = Foo{}
_ = DeepCopyByJson(&t2, t1)
fmt.Println(*t1.IntPtr)
fmt.Println(*t2.IntPtr)

输出


3
3


gob序列化反序列化


这是一种标准库提供的编码方法,类似于protobuf,Gob(即 Go binary 的缩写)。类似于 PythonpickleJavaSerialization


在发送端编码,接收端解码。

func DeepCopyByGob(dst, src interface{}) error {
  var buffer bytes.Buffer
  if err := gob.NewEncoder(&buffer).Encode(src); err != nil {
    return err
  }
  return gob.NewDecoder(&buffer).Decode(dst)
}

用法


a = 4
t1 = Foo{IntPtr: &a}
t2 = Foo{}
_ = DeepCopyByGob(&t2, t1)
fmt.Println(*t1.IntPtr)
fmt.Println(*t2.IntPtr)

输出

4
4


基准测试(性能测试)


这三种方式我分别写了基准测试的测试用例,go会自动反复调用,直到测算出一个合理的时间范围。

基准测试代码,这里仅写一个,其他两个函数的测试方式类似:

func BenchmarkDeepCopyByJson(b *testing.B) {
  b.StopTimer()
  var a = 1
  var t1 = Foo{IntPtr: &a}
  t2 := Foo{}
  b.StartTimer()
  for i := 0; i < b.N; i++ {
    _ = DeepCopyByJson(&t2, t1)
  }
}

运行测试

$ go test -test.bench=. -cpu=1,16  -benchtime=2s
goos: darwin
goarch: amd64
pkg: my_copy
cpu: Intel(R) Core(TM) i5-8257U CPU @ 1.40GHz
BenchmarkFoo_Duplicate          35887767                62.64 ns/op
BenchmarkFoo_Duplicate-16       37554250                62.56 ns/op
BenchmarkDeepCopyByGob            104292             22941 ns/op
BenchmarkDeepCopyByGob-16         103060             23049 ns/op
BenchmarkDeepCopyByJson          2052482              1171 ns/op
BenchmarkDeepCopyByJson-16       2057090              1175 ns/op
PASS
ok      my_copy 17.166s


  • mac环境下单核和多核并没有明显差异
  • 运行速度快慢,手动拷贝方式 > json > gob
  • 拷贝方式都相差了 2 个数量级


小结


如果是偶尔使用的程序可以使用json序列化反序列化的方式进行拷贝,但是除了慢以外还有一个缺陷,就是无法拷贝私有成员变量。


如果是频繁拷贝的程序,建议使用手动拷贝方式进行拷贝,而且可以定制化拷贝的过程。甚至可以完成不同结构体之间,字段细微差异的定制化需求。

PS:内置copyreflect.copy都只支持切片或数组的拷贝,内置copy速度是反射方式的两倍以上。


拓展资料


Go 语言使用 Gob 传输数据 http://c.biancheng.net/view/4597.html)

内建copy函数和reflect.Copy函数的区别 https://studygolang.com/topics/13523/comment/43357

基准测试 https://segmentfault.com/a/1190000016354758

相关文章
|
7天前
|
存储 JSON 监控
Viper,一个Go语言配置管理神器!
Viper 是一个功能强大的 Go 语言配置管理库,支持从多种来源读取配置,包括文件、环境变量、远程配置中心等。本文详细介绍了 Viper 的核心特性和使用方法,包括从本地 YAML 文件和 Consul 远程配置中心读取配置的示例。Viper 的多来源配置、动态配置和轻松集成特性使其成为管理复杂应用配置的理想选择。
26 2
|
6天前
|
Go 索引
go语言中的循环语句
【11月更文挑战第4天】
15 2
|
6天前
|
Go C++
go语言中的条件语句
【11月更文挑战第4天】
19 2
|
8天前
|
监控 Go API
Go语言在微服务架构中的应用实践
在微服务架构的浪潮中,Go语言以其简洁、高效和并发处理能力脱颖而出,成为构建微服务的理想选择。本文将探讨Go语言在微服务架构中的应用实践,包括Go语言的特性如何适应微服务架构的需求,以及在实际开发中如何利用Go语言的特性来提高服务的性能和可维护性。我们将通过一个具体的案例分析,展示Go语言在微服务开发中的优势,并讨论在实际应用中可能遇到的挑战和解决方案。
|
6天前
|
Go
go语言中的 跳转语句
【11月更文挑战第4天】
14 4
|
5天前
|
JSON 安全 Go
Go语言中使用JWT鉴权、Token刷新完整示例,拿去直接用!
本文介绍了如何在 Go 语言中使用 Gin 框架实现 JWT 用户认证和安全保护。JWT(JSON Web Token)是一种轻量、高效的认证与授权解决方案,特别适合微服务架构。文章详细讲解了 JWT 的基本概念、结构以及如何在 Gin 中生成、解析和刷新 JWT。通过示例代码,展示了如何在实际项目中应用 JWT,确保用户身份验证和数据安全。完整代码可在 GitHub 仓库中查看。
20 1
|
7天前
|
Go 调度 开发者
探索Go语言中的并发模式:goroutine与channel
在本文中,我们将深入探讨Go语言中的核心并发特性——goroutine和channel。不同于传统的并发模型,Go语言的并发机制以其简洁性和高效性著称。本文将通过实际代码示例,展示如何利用goroutine实现轻量级的并发执行,以及如何通过channel安全地在goroutine之间传递数据。摘要部分将概述这些概念,并提示读者本文将提供哪些具体的技术洞见。
|
11天前
|
JavaScript Java Go
探索Go语言在微服务架构中的优势
在微服务架构的浪潮中,Go语言以其简洁、高效和并发处理能力脱颖而出。本文将深入探讨Go语言在构建微服务时的性能优势,包括其在内存管理、网络编程、并发模型以及工具链支持方面的特点。通过对比其他流行语言,我们将揭示Go语言如何成为微服务架构中的一股清流。
103 53
|
10天前
|
Ubuntu 编译器 Linux
go语言中SQLite3驱动安装
【11月更文挑战第2天】
33 7
|
11天前
|
关系型数据库 Go 网络安全
go语言中PostgreSQL驱动安装
【11月更文挑战第2天】
42 5