go unsafe包使用指南

---

前言

与 c 语言相似，go语言为开发人员提供了指针（Pointer）的能力，允许开发人员控制特定数据分配内存空间的数量，以及提供内存访问的模式，这对于构建高性能的程序非常重要。但在 go 语言中使用指针也有着很大的限制，并不能像 c 语言那样直接进行指针的运算。

一、unsafe包作用是什么？

在 golang 中，不同类型的指针是不允许相互赋值的，但是通过合理地使用 unsafe 包，则可以打破这种限制。

1.指针类型转换

func operateVariable() {
	var a int32 = 8
	var f int64 = 20

	// int32 的指针
	ptr := &a

	// 先将 *int64 类型转化为 *Arbitrary 类型再转化为 *int32类型
	ptr = (*int32)(unsafe.Pointer(&f))
	*ptr = 10

	fmt.Println(a)
	fmt.Println(f)
}

2.访问修改结构体私有成员变量

package entity

type User struct {
	name string
	id   int
}

func operateStruct() {
	user := new(entity.User)
	// user.name = "jack"
	fmt.Printf("%+v\n", user)

	// 突破第一个私有变量，因为是结构体的第一个字段，所以不需要额外的指针计算
	*(*string)(unsafe.Pointer(user)) = "张伟"
	fmt.Printf("%+v\n", user)

	// 突破第二个私有变量，因为是第二个成员字段，需要偏移一个字符串占用的长度即 16 个字节
	*(*int)(unsafe.Pointer(uintptr(unsafe.Pointer(user)) + uintptr(16))) = 1
	fmt.Printf("%+v\n", user)
}

二、使用 unsafe 包实现 []byte 和字符串的零拷贝转换

通过查看源码，可以发现 slice 切片类型和 string 字符串类型具有类似的结构。

1.slice 底层结构

// runtime/slice.go
type slice struct {
	array unsafe.Pointer	// 底层数组指针，真正存放数据的地方
	len   int				// 切片长度，通过 len(slice) 返回
	cap   int				// 切片容量，通过 cap(slice) 返回
}

2.string 底层结构

// runtime/string.go
type stringStruct struct {
	str unsafe.Pointer	// 底层数组指针
	len int				// 字符串长度，可以通过 len(string) 返回
}

看到这里，你是不是发现很神奇，这两个数据结构底层实现基本相同，而 slice 只是多了一个cap 字段。可以得出结论：slice 和 string 在内存布局上是对齐的，我们可以直接通过 unsafe 包进行转换，而不需要申请额外的内存空间。

3.具体实现

func StringToBytes(str string) []byte {
	var b []byte
	// 切片的底层数组、len字段，指向字符串的底层数组，len字段
	*(*string)(unsafe.Pointer(&b)) = str

	// 切片的 cap 字段赋值为 len(str)的长度，切片的指针、len 字段各占八个字节，直接偏移16个字节
	*(*int)(unsafe.Pointer(uintptr(unsafe.Pointer(&b)) + 2*uintptr(8))) = len(str)

	return b
}

func BytesToString(data []byte) string {
	// 直接转换
	return *(*string)(unsafe.Pointer(&data))
}

总结

通过 unsafe 包，我们可以绕过 golang 编译器的检查，直接操作地址，实现一些高效的操作。但正如 golang 官方给它的命名一样，它是不安全的，滥用的话可能会导致程序意外的崩溃。关于 unsafe 包，我们应该更关注于它的用法，生产环境不建议使用！此次代码已上传 github，地址：go unsafe 使用，欢迎前往查看，点个 statr 。有问题的话可以评论区讨论。