Go的方法接收者:值接收者与指针接收者

2,288 阅读4分钟

最近在 review 一些代码中,发现经常某个类型定义的方法,其接收者既有值类型,又有指针类型,然后 Goland 就有提示: Struct Person has methods on both value and pointer receivers. Such usage is not recommended by the Go Documentation.

一般来讲,这个提示对代码的运行并不会产生什么问题。只不过对于有轻微 “代码洁癖” 的人来讲,体感不好,就一定想要改统一。 当然,我并不是想讲要统一的问题,前面说这么多废话,只是为了铺垫一下引出本文的内容:Go中的值接收者与指针接收者有什么关系与区别,该怎么选?

联系与区别

在继续讲下去之前,我们得先明确,Go 里边能够定义方法的必须是自定义类型,而不能是系统内置类型,比如 int、string 这种是不可以为其添加方法的。

那么当我们定义了一个自定义类型,可以为其添加方法,先上代码:

package main

import "fmt"

type Person struct {
   name string
   age  int
}

// 值针接收者
func (p Person) GetName() string {
   return p.name
}

// 指针接收者
func (p *Person) GetAge() int {
   return p.age
}

func main() {
   //  定义了一个【值类型】
   t := Person{
      name: "DaYu",
      age:  int(28),
   }
   
   // 调用值方法
   fmt.Println(t.GetName())
   // 调用指针方法
   fmt.Println(t.GetAge())
}

-----运行结果-------
study/demo01/client go run *
DaYu
28

从使用过程看,值类型的变量,可以调用该类型的值接收者方法,也可以调用指针接收者方法。 反之,我们可以定义一个指针类型,然后看看调用结果:

package main

import "fmt"

type Person struct {
   name string
   age  int
}

func (p *Person) GetName() string {
   return p.name
}

func (p Person) GetAge() int {
   return p.age
}

func main() {
   // 注意,其它地方都没有改,只是这里改变了类型
   t := &Person{
      name: "DaYu",
      age:  int(28),
   }
   fmt.Println(t.GetName())
   fmt.Println(t.GetAge())
}

-----运行结果-------
study/demo01/client go run *
DaYu
28

这段代码告诉我们,指针类型的变量,可以调用该类型的值接收者方法,也可以调用指针接收者方法。

是不是特别有意思?

  • 值类型变量,可以调用值接收的方法,也可以调用指针接收者的方法;
  • 指针类型变量,可以调用值接收的方法,也可以调用指针接收者的方法。

看起来好像两者对等的,并没有差别。那么二者真的没有差别吗?只是一种表达形式上的差异?其实不然,如果引入接口类型后,我们再来看看。

package main

// 新增的接口
type Animal interface {
   GetName() string
   GetAge() int
}

type Person struct {
   name string
   age  int
}

func (p *Person) GetName() string {
   return p.name
}

func (p Person) GetAge() int {
   return p.age
}

func main() {
   // 定义的接口变量
   var ani Animal

   // person 实现了 Animal 接口,赋值给了 ani 变量
   // 但是,这里编译会通不过,错误如下:
   // Cannot use 'Person{ name: "DaYu", age: int(28), }' (type Person) as the type Animal Type does not implement 'Animal' as the 'GetName' method has a pointer receiver
   ani = Person{
      name: "DaYu",
      age:  int(28),
   }

   ani.GetName()
   ani.GetAge()
}

为什么会报错呢? 错误提醒很明显了:Person 没有实现 Animal 的 GetName 方法。因为在上面的代码中,我们实现 GetName 方法的是 (*Person) 类型。

但是为什么 GetAge 方法不报错呢? 那是因为 Go 里边对于 (Type)Method 的方法,会自动让他拥有 (*Type)Method 方法的能力。

总结一下,实现接口时有下面的约束:

  • 如果定义的是 (Type)Method,则该类型会隐式的声明一个 (*Type)Method;
  • 如果定义的是 (*Type)Method ,则不会隐式什么一个 (Type)Method。

至于为什么不也隐式申明一个 (Type)Method ,我觉得有一个原因是,我们一般采用指针接收者时,方法内部改变的值,接收者本身也会改变,那么此时如果隐式有这样一个申明,外部使用值类型时,这个改变就不会生效,语义上就会非常奇怪。

该怎么用

从使用表现上看,指针接收者在方法内部的改变,会体现到其本身。但这并不是决定我们要不要用指针接收者的唯一理由! 最重要的还是看接收者要不要全局共享一个实体,其次某些场景下,如果接收者本身太大,拷贝成本很高,也应该使用指针接收者。

回到文档开篇的问题,为什么不建议值接收者、指针接收者混用,主要还是在于语义不够清晰,存在潜在理解成本的问题。