go - 为什么要命名返回参数？

Question

命名函数的返回参数有什么好处？

func namedReturn(i int) (ret int) {
    ret = i
    i += 2
    return
}

func anonReturn(i int) int {
    ret := i
    i += 2
    return ret
}

Answer 1

命名它们有一些好处：

• 它用作文档。
• 它们被自动声明并初始化为零值。
• 如果您有多个返回站点，则如果您更改函数的返回值，则无需全部更改，因为它只会说“返回”。

也有缺点，主要是通过声明一个同名的变量很容易意外地隐藏它们。

Effective Go 有一个关于命名结果参数的部分：

Go 函数的返回或结果“参数”可以指定名称并用作常规变量，就像传入参数一样。当命名时，它们在函数开始时被初始化为它们的类型的零值；如果函数执行没有参数的 return 语句，则使用结果参数的当前值作为返回值。

这些名称不是强制性的，但它们可以使代码更短更清晰：它们是文档。如果我们命名 nextInt 的结果，很明显哪个返回的 int 是哪个。

func nextInt(b []byte, pos int) (value, nextPos int) {

[...]

Answer 2

命名返回变量的另一个特殊用途是由延迟函数字面量捕获。一个简单的例子：

package main

import (
    "errors"
    "fmt"
)

func main() {
    fmt.Println(f())
}

var harmlessError = errors.New("you should worry!")

func f() (err error) {
    defer func() {
        if err == harmlessError {
            err = nil
        }
    }()
    return harmlessError
}

输出是<nil>。在更实际的场景中，延迟函数可能会处理恐慌，并且可能会修改除错误结果之外的其他返回值。然而，共同的魔力在于，延迟的文字有机会在 f 被终止后修改 f 的返回值，无论是正常还是恐慌。

Answer 3

它至少在两种情况下很有用：

1. 每当您必须声明要返回的变量时。例如

   func someFunc() (int, error) {
       var r int
       var e error
       ok := someOtherFunc(&r)  // contrived, I admit
       if !ok {
           return r, someError()
       }
       return r, nil
   }
   

   对比

   func someFunc() (r int, e error) {
       ok := someOtherFunc(&r)
       if !ok {
           e = someError()
       }
       return
   }
   

   随着通过函数的执行路径数量的增加，这一点变得更加重要。

2. 当您记录返回值并希望按名称引用它们时。godoc将返回变量视为函数签名的一部分。

Answer 4

例如，命名返回参数可以通过名称访问。

func foo() (a, b, c T) {
        // ...
        if qux {
                b = bar()
        }
        // ...
        return
}

在没有命名返回参数的情况下，这并不容易复制。必须引入与命名返回参数具有基本相同功能的局部变量：

func foo() (T, T, T) {
        var a, b, c T
        // ...
        if qux {
                b = bar()
        }
        // ...
        return a, b, c
}

所以直接允许它更容易。

此外，它们也可以从另一个方向访问：

func foo() (a, b, c T) {
        // ...
        if a > c {
                b = bar()
        }
        // ...
        return
}

等等。