为什么要命名返回参数？

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将返回变量视为函数签名的一部分。