在日常工作中，我們經(jīng)常使用 err != nil 來判斷程序或函數(shù)是否報(bào)錯(cuò)氧腰，或者使用 defer {recover = err} 來判斷是否有 panic 嚴(yán)重錯(cuò)誤枫浙，但稍不注意，很容易掉進(jìn) err shadow 的陷阱容贝。
1. 變量作用域
package main
import "fmt"
func main() {
x := 100
func() {
x := 200 // x will shadow outer x
fmt.Println(x)
}()
fmt.Println(x)
}
輸出如下：
200
100
結(jié)果分析：
x 變量在 func 里面打印為 200自脯，在外層打印為 100，這就是變量的作用域(variable scope)斤富。func 里面的變量 x 是一個(gè)新變量膏潮，只不過與外層 x 重名了(variable redeclaration)，此時(shí)里層 x 的作用域僅限于 func {} block满力，而外層 x 的作用域則是 main {} block焕参，此時(shí)里層變量 x 發(fā)生了 variable shadowing，外層 x 不受影響油额，依然是 100叠纷。
改一下寫法：
package main
import "fmt"
func main() {
x := 100
func() {
x = 200 // x will override outer x
fmt.Println(x)
}()
fmt.Println(x)
}
輸出如下：
200
200
此時(shí)，func 里面的變量 x 僅僅是覆蓋了外層 x潦嘶，并沒有定義新的變量涩嚣，所以內(nèi)外層輸出都是 200。
2. err shadow - 無名 error
package main
import (
"fmt"
"os"
)
func main() {
fmt.Println("func err1:", test1())
}
func test1() error {
var err error
defer func() {
fmt.Println("defer err1:", err)
}()
if _, err := os.Open("xxx"); err != nil {
return err
}
return nil
}
輸出如下：
defer err1: <nil>
func err1: open xxx: no such file or directory
結(jié)果分析：
func test1 首先定義了 var err error 變量掂僵，但下面的 os.Open 報(bào)錯(cuò)使用 err := 被局部 err shadow 了航厚，雖然顯式使用了 return err 返回錯(cuò)誤，但由于 test1() error 返回參數(shù)是無名的(unnamed variable)锰蓬，導(dǎo)致 defer 中 err 獲取不到被 err shadow 的錯(cuò)誤 err幔睬，取的仍然是外層初始化 var err error 值，所以輸出為 err1: <nil>芹扭。
只需要將第 19 行改一下麻顶，即可避免 err shadow：
if _, err = os.Open("xxx"); err != nil {
return err
}
輸出如下：
defer err1: open xxx: no such file or directory
func err1: open xxx: no such file or directory
3. err shadow - 有名 error
package main
import (
"fmt"
"os"
)
func main() {
fmt.Println("func err2:", test2())
}
func test2() (err error) {
defer func() {
fmt.Println("defer err2:", err)
}()
if _, err := os.Open("xxx"); err != nil {
return // return without err will compilation error
}
return
}
上面的 test2 運(yùn)行會(huì)有編譯報(bào)錯(cuò)，這是 go compiler 在編譯時(shí)做了 variable shadowing 檢查舱卡，發(fā)現(xiàn)有就直接編譯報(bào)錯(cuò)辅肾。修改一下即可：
func main() {
fmt.Println("func err3:", test3())
}
func test3() (err error) {
defer func() {
fmt.Println("defer err3:", err)
}()
if _, err := os.Open("xxx"); err != nil {
return err
}
return
}
輸出如下：
defer err3: open xxx: no such file or directory
func err3: open xxx: no such file or directory
4. 嵌套 err shadow
package main
import (
"encoding/json"
"fmt"
"os"
)
func main() {
fmt.Println("func err4:", test4())
}
func test4() (err error) {
defer func() {
fmt.Println("defer err4:", err)
}()
if _, err := os.Open("xxx"); err == nil {
if err := json.Unmarshal([]byte("{}"), &struct{}{}); err == nil {
fmt.Println("OK")
}
}
return
}
輸出如下：
defer err4: <nil>
func err4: <nil>
結(jié)果分析：
func test4() 是一個(gè)有名返回 err error，則函數(shù)初始化時(shí)會(huì) var err error 定義對(duì)應(yīng)的有名變量(named variable)轮锥，但下面的 os.Open 或 json.Unmarshal 都使用了 err := 重定義 err 變量宛瞄，造成了 err shadow，因此在函數(shù)退出時(shí)，外層 err 依然是 nil份汗，defer 獲取也就是 nil盈电。
改一下寫法即可：
func main() {
fmt.Println("func err5:", test5())
}
func test5() (err error) {
defer func() {
fmt.Println("defer err5:", err)
}()
if _, err = os.Open("xxx"); err == nil {
if err = json.Unmarshal([]byte("{}"), &struct{}{}); err == nil {
fmt.Println("OK")
}
}
return
}
輸出如下：
defer err5: open xxx: no such file or directory
func err5: open xxx: no such file or directory
5. 小結(jié)
本文通過幾個(gè)實(shí)例，分析了在實(shí)際工作中很容易出現(xiàn)的 err shadow 問題杯活，究其本質(zhì)原因主要是變量作用域引起的匆帚，在官方文檔中提到：An identifier declared in a block may be redeclared in an inner block. While the identifier of the inner declaration is in scope, it denotes the entity declared by the inner declaration.
另外，在函數(shù)返回值命名方面旁钧，我們需要考慮無名吸重、有名參數(shù)的情況，在保證代碼邏輯正確的情況下歪今，建議使用工具 go linter 或 go vet 來檢測(cè)編譯器沒檢測(cè)到的 variable shadowing嚎幸，避免踩到坑。
