译文 Go 100 mistakes 之意外的变量隐藏(variable shadowing)

yudotyang · 2021年07月26日 · 84 次阅读

本文是对《100 Go Mistackes:How to Avoid Them》一书的翻译。因翻译水平有限,难免存在翻译准确性问题,敬请谅解。 本文首发于微信公众号 “Go 学堂”,想获取更多信息,请关注该公众号。

变量的作用域是指它的可见性。换句话说,程序中的名称在哪部分是有效的。在 Go 中,在块中声明的变量名称可以在内部块中重新声明。这种被称为变量隐藏的原则很容易出现错误。

在下面的例子中,我们将看到一个关于变量隐藏产生的 bug。我们将使用两种不同的方式创建一个 HTTP 客户端,具体取决于 tracing 布尔值:

var client *http.Client 
if tracing {
    client, err := createClientWithTracing()    
    if err != nil {
        return err
    }
    log.Println(client)
}else {
    client, err := createDefaultClient()    
    if err != nil {
        return err
    }
    log.Println(client)
}

//use client

① 生命一个 client 变量

② 使用带 tracing 的创建一个 HTTP 客户端,client 变量在该块内被隐藏了

③ 创建一个默认的 HTTP 客户端,client 变量在该模块依然被隐藏掉了。

首先,我们声明了一个 client 变量。然后,在两个内部块中,我们使用 := 操作符,也叫做短变量声明运算符。该操作符使用和开始的时候相同的名称创建了一个新的 client 变量;它不会为第①行中的 client 变量赋值。因此,在该示例中,HTTP 客户端将始终是 nil 值。

注意:该代码之所以可以编译成功,是因为在 logging 调用中使用了内部变量 client。否则,我们就会有编译错误:client declared and not used。

我们如何确保给 client 赋值了呢?有两种不同的方法。 第一种方法是在内部块中使用临时变量,像下面这样:

var client *http.Client
if tracing {
    c, err := createClientWithTracing() 
    if err != nil {
        return err
    }
    client = c 
} else {
    c, err := createDefaultClient()
    if err != nil {
        return err
    }
    client = c
}
// Use client

① 创建了一个临时变量 c

② 将临时变量赋给变量 client 变量 c 的生命周期只在 if/else 块中。然后,我们将这些变量赋值给 client。

第二种方式是在内部块中使用赋值操作符(=)来将函数的返回值直接赋值给 client 变量。然而,它需要创建一个 error 变量,因为赋值运算符仅在已声明变量时才起作用。

var client *http.Client
var err error   
if tracing {
    client, err = createClientWithTracing() 
    if err != nil {
        return err
    }
} else {
    client, err = createDefaultClient()
    if err != nil {
        return err
    }
}

① 声明变量 err

② 使用赋值操作符将返回来的 *http.Client 直接赋值给 client 变量

在这个例子中,我们也将内部调用的结果赋值给了 client。哪种方法最好呢?第一种方法在大多数情况下都是更方便的,但是没有强迫说要是用哪种方法。

当在内部块中将一个变量名重新声明时就会发生变量隐藏,我们已经看到这种做法很容易出错。应根据项目和上下文制定避免隐藏变量的规则。例如,有时候,重用现有的变量名可能会很方便,像 err 错误。然而,一般来说,我们应该保持谨慎,因为我们已经看到我们可能会面临这样一种错误:代码可以编译,但可能不会对我们期望的变量进行赋值。在本章后面,我们将看到该如何检测变量隐藏,以帮助我们发现可能的错误。

更多原创文章干货分享,请关注公众号
  • 加微信实战群请加微信(注明:实战群):gocnio
暂无回复。
需要 登录 后方可回复, 如果你还没有账号请点击这里 注册