在golang中,我们经常会用:=来声明变量,这很方便但也会带来一些问题。当变量遇到作用域时就容易产生shadowing。
比如说我们经常会遇到的:
shadow: declaration of "err" shadows declaration
什么是变量隐藏呢?
就是当年在后面重新声明了前面已经声明的同名变量时,后面的变量值会遮蔽前面的变量值,虽然这两个变量同名但值却不一样。这样是很容易产生问题的。
举个栗子来看一下:
func main() {
n := 0
if true {
n := 1
n++
}
fmt.Println(n) // 0
}
这个结果n=0
这里因为在if的作用域中对n重新声明了,所以里面的n++对外面的n并不起作用。
如果是在里面对n直接赋值而不是重新声明呢?
func main() {
n := 0
if true {
n = 1
n++
}
fmt.Println(n) // 2
}
这里结果n=2
这么明显的情况我们写代码的时候很容易发现,但如果是很复杂的代码呢,尤其是遇到err的时候真的很容易Shadowing。
再举个栗子:
func templateToFile(templateFilename string, filename string, data interface{}) (err error) {
if f, err := os.OpenFile(filename, os.O_WRONLY|os.O_TRUNC|os.O_CREATE, 0666); err == nil {
defer f.Close()
if t, err := template.ParseFiles(templateFilename); err == nil {
return t.Execute(f, data)
}
}
return
}
这里第一个if作用域中的err和第二个作用域中的err不是同一个东西,但又是相同名的变量,所以也会造成变量遮蔽。
如何解决呢,这种一般把第二个err变量改名或者用赋值代理重新声明就可以解决了。
那对于这种变量遮蔽的情况,如何检测呢?
情况严重的话你的代码会直接编译失败,但如果不严重的情况你的代码是跑的起来的,但仍然会存在遮蔽的情况。
1,可以用vet,Go 1.12 以上的版本需要
go install golang.org/x/tools/go/analysis/passes/shadow/cmd/shadow
go vet -vettool=$(which shadow)
2,也可以用goland的tool工具(我一般用这种)
3,还可以用golangci-lint工具,也可以检测出来。