Golang 语言该用命名返回值吗?

01 介绍

Golang 语言支持命名返回值,它与使用普通(匿名)返回值不同的是,命名返回值会被视为定义在函数顶部的变量,并且在使用 return 语句返回时,不再必须在其后面指定参数名,也就是支持“裸”返回。

而使用普通返回值时,使用 return 语句返回时,需要在其后面指定与普通返回值相同类型的参数名。

实际上,命名返回值和普通返回值都有其适用的场景,本文我们介绍 Golang 语言函数或方法使用命名返回值和普通返回值各自的“好处”与“坏处”。

02 命名返回值

使用命名返回值的“好处”是可以提升代码可读性,读者朋友们试想一下,当函数或方法有多个返回值时,尤其是函数体中代码比较长的函数或方法,如果我们使用普通返回值,那么我们想要知道返回值的含义,就需要先阅读函数体中完整代码。

而如果使用具有实际含义的命名返回值,我们只需要阅读函数或方法的签名,就可以知道其含义,甚至可以把它们作为文档使用。

但是,命名返回值也不是没有“坏处”,如果函数体内有变量与命名返回值同名,那么命名返回值会被覆盖,所以我们也需要注意避免“踩坑”。

03 普通返回值

普通(匿名)返回值的“好处”是简洁,当我们写一些简短函数或方法时,使用普通返回值可以使代码更加简洁,在 Golang 语言官方标准库中,有很多使用普通返回值的函数或方法。

但是如果返回值是指针类型时,使用普通返回值,就会使我们函数体中的代码变得不优雅,比如以下这段示例代码。

func c() *int {
 i := 0
 return &i
}

func d() (i *int) {
 return
}

当然这里列举的代码片段是个极端示例,我们在编写 Golang 代码时,也并不会这么使用。

还有就是在编写函数体代码比较长的函数时,使用普通返回值的代码,其可读性比不上使用命名返回值的代码。

04 踩坑

defer 在命名返回值和普通返回值的函数或方法中,返回的结果不一样。

func main() {
 f := fmt.Println
 f(a())
 f(b())
}

func a() int {
 i := 0
 defer func() {
  i += 1
  fmt.Println("a defer:", i)
 }()
 return i
}

func b() (i int) {
 i = 0
 defer func() {
  i += 1
  fmt.Println("b defer:", i)
 }()
 return i
}

输出结果:

a defer: 1
0
b defer: 1
1

阅读上面这段代码,我们可以发现使用普通返回值的函数 a(),返回结果是 0。使用命名返回值的函数 b(),返回结果是 1

我们在之前的文章中,也单独介绍过 defer 。在这里我们简述一下,当我们使用 defer 调用一个函数时,该函数的执行,被推迟到周围函数返回的那一刻,要么是因为周围的函数执行了 return 语句,要么是因为相应的 goroutine 崩溃。

在函数 a() 中,因为我们没有使用命名返回值,所以返回结果 return i,其中 i 是一个静态值,即使我们在 defer 调用的函数中给变量 i 执行 +1 操作,返回结果中的变量 i 是不可访问的,所以也不会修改返回结果中的变量 i

在函数 b() 中,因为我们使用命名返回值,所以变量 i 已被分配,并且被初始化为类型零值。即使 defer 调用的函数在返回结果之后执行,返回结果中的变量 i 仍然是可以被访问的,所以其值仍然可以被修改。

05 总结

在非简短函数或方法的代码中,建议优先使用命名返回值。它不仅可以提升代码的可读性,也可以帮我们避免一些 “踩坑”。

读者朋友们还遇到过什么关于使用命名返回值和普通(匿名)返回值的 “坑”,请在留言区与大家分享。

发表评论

后才能评论