Go 值接收者与指针接收者

刚学会给结构体编写方法时,很多初学的小伙伴都会遇到一个疑惑:明明在方法内部把年龄字段改成了 25,为什么调用完方法后,外面的结构体年龄还是原来的 20 呢?

这其实是因为 Go 方法的接收者主要有 2 种类型:① 值接收者;② 指针接收者。选择不同的接收者,直接决定了方法内部能不能修改原结构体的数据。

“值接收者” 与 “指针接收者” 的区别

前面学习值传递与指针传递时我们知道,普通参数传递的是数据副本,而指针参数传递的是内存地址。方法的接收者本质上就是把结构体作为第 1 个参数传进函数里,因此普通结构体和结构体指针作为接收者时的表现完全不同。

语法:

// 值接收者
func (接收者变量 结构体类型) 方法名(参数列表) 返回值类型 {
    // 方法体
}

// 指针接收者
func (接收者变量 *结构体类型) 方法名(参数列表) 返回值类型 {
    // 方法体
}

说明:

这两种接收者在写法上只差一个星号 *,分别对应普通结构体与结构体指针,它们的底层行为有着本质区别:

  • 值接收者:小括号内直接写结构体类型,比如 (s Student)。调用方法时,程序会把原结构体完整复制一份传给 s。方法内部读取或修改的都只是这份副本,不会影响外部的原结构体。
  • 指针接收者:在结构体类型前加上星号 *,比如 (s *Student)。调用方法时,传递的是原结构体的内存地址。方法内部通过 s 修改字段时,会直接修改外部的原结构体,还能省去复制整个结构体的内存开销。

这两种接收者在内存中的操作差异如下图所示。

值接收者与指针接收者的内存对比

示例 1:对比值接收者与指针接收者

package main

import "fmt"

type Student struct {
    Name string
    Age  int
}

// 值接收者方法
func (s Student) SetAgeVal(age int) {
    s.Age = age
}

// 指针接收者方法
func (s *Student) SetAgePtr(age int) {
    s.Age = age
}

func main() {
    stu := Student{Name: "Jack", Age: 20}

    stu.SetAgeVal(25)
    fmt.Println(stu.Age)

    stu.SetAgePtr(25)
    fmt.Println(stu.Age)
}

运行结果如下。

20
25

分析:

SetAgeVal() 使用的是值接收者 (s Student)。当我们调用 stu.SetAgeVal(25) 时,程序只是把副本 s 上的年龄改成了 25,外部原结构体 stu.Age 依然输出 20。

而 SetAgePtr() 使用的是指针接收者 (s *Student)。调用 stu.SetAgePtr(25) 时,方法内部通过内存地址直接修改了外部 stu 的字段,因此打印 stu.Age 时就变成了 25。

平时如果发现调用修改方法后原结构体的数据没有变化,小伙伴们首先就应该检查定义方法时接收者是不是漏写了星号 *。

调用方法的简写规则

回头看示例 1 的代码,为什么 stu 明明是一个普通的结构体变量,却不需要加 & 取地址,就能直接调用指针接收者方法 stu.SetAgePtr(25) 呢?

其实这也是 Go 编译器提供的一项语法糖。定义方法时我们必须分清写不写星号 *,但在调用方法时,普通变量和指针变量都可以统一使用英文点号(.)来调用。编译器会在底层自动帮我们取地址或解引用。

示例 2:自动取地址与解引用

package main

import "fmt"

type Student struct {
    Name string
    Age  int
}

// 值接收者方法
func (s Student) SetAgeVal(age int) {
    s.Age = age
}

// 指针接收者方法
func (s *Student) SetAgePtr(age int) {
    s.Age = age
}

func main() {
    // 普通变量调用指针接收者方法
    stu := Student{Name: "Jack", Age: 20}
    stu.SetAgePtr(30)
    fmt.Println(stu.Name, stu.Age)

    // 指针变量调用值接收者方法
    p := &Student{Name: "Lucy", Age: 18}
    p.SetAgeVal(30)
    fmt.Println(p.Name, p.Age)
}

运行结果如下。

Jack 30
Lucy 18

分析:

当我们使用普通结构体变量 stu 调用指针接收者方法 stu.SetAgePtr(30) 时,编译器会自动把代码转换成 (&stu).SetAgePtr(30)。因此,stu.Age 成功被改成了 30。

反过来,当我们使用结构体指针 p 调用值接收者方法 p.SetAgeVal(30) 时,编译器也会自动解引用,将其转换成 (*p).SetAgeVal(30)。对于这个例子来说,下面 2 种写法是等价的。

// 写法 1(推荐)
stu.SetAgePtr(30)
p.SetAgeVal(30)

// 写法 2
(&stu).SetAgePtr(30)
(*p).SetAgeVal(30)

有了这层自动转换,我们平时调用方法时就不用刻意去加 & 或 * 了,统一使用点号调用即可。

同时从运行结果可以看到,即使 p 是一个结构体指针,调用值接收者方法 p.SetAgeVal(30) 后,p.Age 依然保持 18 而没有变成 30。

对于这一点,小伙伴们只需要记住一句话就可以了:方法内部能不能修改原结构体的数据,完全取决于 “定义方法时” 接收者有没有加星号 *。跟 “调用方法时” 使用的是普通变量还是指针变量无关。

提示: 普通结构体能够自动取地址调用指针方法,前提是这个结构体保存在变量里。如果不定义变量,直接写成 Student{Name: "Jack"}.SetAgePtr(30) 对临时字面量调用指针方法,编译时就会因为无法获取内存地址而直接报错。

如何选择接收者类型?

在实际开发中,我们给结构体编写方法时,只要符合以下 3 种情况中的任意一种,就应该优先选择指针接收者:

  • 需要修改接收者字段:当方法内部需要修改结构体自身的字段值时,我们必须使用指针接收者。
  • 结构体包含字段较多:当结构体体积较大时,我们使用指针接收者可以避免每次调用方法都把整个结构体复制一遍。
  • 保持接收者类型统一:如果同一个结构体已经有部分方法使用了指针接收者,建议把其余只读方法也统一写成指针接收者。这样既能让代码风格一致,也能避免下一章学习接口时因为混用接收者类型而踩坑。

下面我们通过一个账户存取款的例子来看看实际项目中的标准写法。

示例 3:实现账户存款与查询

package main

import "fmt"

type Account struct {
    Balance int
}

// 存款:修改余额
func (a *Account) Deposit(amount int) {
    a.Balance += amount
}

// 查询余额
func (a *Account) GetBalance() int {
    return a.Balance
}

func main() {
    acc := Account{Balance: 100}
    acc.Deposit(50)
    fmt.Println(acc.GetBalance())
}

运行结果如下。

150

分析:

在这个例子中,Deposit() 方法需要把存入金额累加到余额 a.Balance 上。由于涉及修改原结构体的字段,这里使用了指针接收者 (a *Account)。为了保持接收者类型一致,只读查询的 GetBalance() 方法也一并采用了指针接收者。

常见问题

1. 既然指针接收者这么方便,那平时还有必要使用值接收者吗?

依然很有用。如果一个结构体本身非常小巧,比如只包含两个坐标字段的 Point 结构体,并且所有方法都只读取数据而不修改字段,使用值接收者反而更合适。

因为值接收者每次操作的都是独立副本,能保证原结构体的数据不会被意外修改,用起来就像 int、string 等基本类型一样安全省心。

2. 空指针 nil 能不能调用指针接收者方法?

可以调用,但前提是方法内部不能直接读写它的字段。在 Go 语言中,把一个值为 nil 的结构体指针当作接收者调用方法时,调用动作本身并不会立刻报错。

如果我们在方法开头先判断 if s == nil 并提前返回,程序就能安全执行。但一旦方法内部直接访问或修改了 s.Age 这类字段,就会触发空指针崩溃。

上一篇:

下一篇:

给站长反馈

绿叶网正在不断完善中,小伙伴们如果发现任何问题,还望多多给站长反馈,谢谢!

邮箱:lvyenet@vip.qq.com

「绿叶网」服务号
绿叶网服务号放大
关注服务号,微信也能看教程。
绿叶网服务号