Go 方法

在 Go 语言中,“方法(method)” 是一种绑定在特定类型上的特殊函数。

前面学习的普通函数定义好之后,可以直接写出函数名来调用。而方法通常绑定在某个结构体上,必须通过该类型的变量,使用英文点号(.)以 变量.方法名() 的形式来调用。

Go 方法语法

在 Go 语言中,结构体的大括号 {} 内部只用来存放数据字段,方法则是定义在结构体外面的。这样结构体只专注描述数据本身,方法也能按功能灵活拆分在同一个包的不同位置。

定义方法时,我们只需要在 func 关键字和方法名之间多加一个小括号,用来指定这个方法归属于哪一个类型。

语法:

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

说明:

紧跟在 func 关键字后面的小括号部分(如 (s Student))称为 “接收者(receiver)”,方法的各部分结构如下图所示。

Go 方法定义的语法结构

在接收者小括号内部,主要包含以下 2 个部分:

  • 接收者变量:代表调用该方法的结构体变量本身,在方法内部我们可以通过它来访问结构体的各个字段。
  • 接收者类型:表示该方法绑定在哪一个类型上,最常见的就是我们自定义的结构体类型。

刚看到在 func 后面写小括号时,小伙伴们可能会觉得有点陌生。其实对比一下前面学过的函数,就很容易看懂方法的结构了:

// 普通函数
func SayHello(s Student) {
    // 函数体
}

// 方法
func (s Student) SayHello() {
    // 函数体
}

可以看到,方法其实就是把原本放在函数参数列表里的结构体参数 (s Student),提前移到了方法名前面作为接收者而已。

提示: 在 Go 官方代码规范中,接收者变量名一般直接取类型名的首字母小写。比如 Student 结构体的接收者变量通常命名为 s,Box 结构体的接收者变量通常命名为 b,既简短又直观,不建议使用其他语言常见的 this 或 self。

Go 方法示例

定义好方法之后,我们就可以通过 变量.方法名() 的形式来调用它。下面我们通过几个例子来看看 Go 方法的具体用法。

示例 1:定义并调用方法

package main

import "fmt"

type Student struct {
    Name string
    Age  int
}

// 绑定 SayHello 方法
func (s Student) SayHello() {
    fmt.Printf("大家好,我是 %s,今年 %d 岁\n", s.Name, s.Age)
}

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

运行结果如下。

大家好,我是 Jack,今年 20 岁

分析:

(s Student) 就是接收者,表示将 SayHello() 方法绑定到 Student 结构体上。执行 stu.SayHello() 时,变量 stu 会自动传给接收者 s,在方法内部就能通过 s.Name 和 s.Age 读取字段值。

小伙伴们要注意,方法不能脱离对应的变量单独调用。如果我们直接写 SayHello(),编译器会报错 undefined: SayHello,提示找不到该名称,必须写成 stu.SayHello() 才行。

如果方法在执行时需要接收额外的参数,或者需要把计算结果返回给调用者,又应该怎么写呢?我们来看一个简单例子就懂了。

示例 2:带参数和返回值的方法

package main

import "fmt"

type Box struct {
    Width  float64
    Height float64
}

// 计算面积
func (b Box) Area() float64 {
    return b.Width * b.Height
}

// 计算放大后的面积
func (b Box) ScaleArea(factor float64) float64 {
    return b.Width * b.Height * factor
}

func main() {
    box := Box{Width: 10, Height: 5}
    fmt.Println(box.Area())
    fmt.Println(box.ScaleArea(2))
}

运行结果如下。

50
100

分析:

在这个例子中,我们为 Box 结构体绑定了两个方法。其中,Area() 直接读取接收者 b 的宽高字段,计算并返回面积 50。ScaleArea() 则额外接收一个倍数参数 factor,计算并返回放大后的面积 100。

除了方法名前面多出一个接收者 (b Box) 之外,方法的参数列表和返回值写法与普通函数完全一样。需要注意的是,上面两个例子中的方法都只是读取字段值。如果希望在方法内部直接修改原结构体的字段,就需要配合下一节要学习的指针接收者来实现。

此外,在同一个包中普通函数是不能重名的,那不同的结构体能不能定义同名的方法呢?我们来看下面的例子。

示例 3:不同结构体定义同名方法

package main

import "fmt"

type Dog struct {
    Name string
}

type Cat struct {
    Name string
}

// 为 Dog 绑定方法
func (d Dog) Speak() {
    fmt.Println(d.Name, "汪汪汪")
}

// 为 Cat 绑定同名方法
func (c Cat) Speak() {
    fmt.Println(c.Name, "喵喵喵")
}

func main() {
    dog := Dog{Name: "旺财"}
    cat := Cat{Name: "咪咪"}

    dog.Speak()
    cat.Speak()
}

运行结果如下。

旺财 汪汪汪
咪咪 喵喵喵

分析:

在同一个包下面,我们不能定义两个同名的普通函数。但是对于方法来说,只要接收者类型不同(如 Dog 和 Cat),就可以各自绑定同名的方法 Speak()。当我们调用方法时,编译器会根据点号左侧变量的类型自动匹配对应的方法,彼此不会发生冲突。

方法与普通函数的区别

刚接触 Go 方法时,很多小伙伴容易把它和普通函数混淆。其实可以这样理解:结构体用来保存事物的 “属性数据”(如姓名、宽高),而绑定在结构体上的方法则用来表示事物的 “行为动作”(如打招呼、算面积)。

在实际开发中,方法与普通函数主要有以下 3 点区别:

  • 定义与调用方式不同:普通函数没有接收者,我们直接按函数名调用(如 SayHello(stu))。方法带有接收者声明,必须通过变量加点号调用(如 stu.SayHello())。
  • 同名规则不同:同一个包内的普通函数不能重名,而不同的接收者类型可以各自绑定同名的方法。
  • 绑定类型的范围限制:方法只能绑定在当前包(package)内部定义的类型上,我们不能直接为内置基本类型(如 int、string)或其他外部包的类型绑定方法。

比如,如果我们像下面这样直接给内置的 int 类型绑定方法,编译时就会报错:

// 不能直接为内置类型 int 绑定方法
func (n int) Double() int {
    return n * 2
}

编译上面这段代码时会直接报错 cannot define new methods on non-local type int,提示不能为非当前包定义的类型绑定方法。如果确实需要给基本类型加方法,我们可以先使用 type 将其定义为自定义类型,后面很快就会介绍。

给站长反馈

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

邮箱:lvyenet@vip.qq.com

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