大家好，我是煎魚。

風水輪流轉，Go 程序寫多了。總是會這有點問題，那有點問題。問題積累久了就容易出點事件，甚至是事故。

這種時候大家往往會想著引入一些靜態(tài)分析工具來解決這個問題。元旦假期時剛好看到這個新輪子，分享給大家！

NilAway 分析工具

最近 Uber 開發(fā)和開源了一個挺不錯的靜態(tài)分析工具 NilAway：

圖片

使用場景是：在 Go 程序編譯時就能捕獲 nil，達到幫助開發(fā)人員規(guī)避在生產中出現(xiàn) nil panic 的問題。

官方認為其具備以下三個重要的特點，讓其脫穎而出：

1. 完全自動化：該分析工具只需要用戶提供標準的 Go 代碼就可以使用了。不需要其他任何額外的信息。
2. 速度快：在設計上，NilAway 保持速度快且可擴展，目標是大型代碼庫也可以使用。在官方的性能測量中，啟用 NilAway 時構建時間開銷不到 5%。
3. 很實用：它不能防止代碼中所有可能的 nil panic，但能捕獲我們在生產中觀察到的大部分潛在 nil panic，從而使 NilAway 在實用性和構建時間開銷之間保持良好的平衡。

安裝

我們只需要在命令行執(zhí)行如下命令安裝：

$ go install go.uber.org/nilaway/cmd/nilaway@latest

nilaway 能夠遍歷掃描目錄下的所有文件：

$ nilaway ./...

也可以掃描單獨的文件：

$ nilaway demo.go

注：本文安裝 @latest 的原因，是因為寫此文時 nilaway 還在積極開發(fā)階段，暫時沒有發(fā)布正式的版本。如果后續(xù)有正式版本，也可以指定相應版本號。

代碼示例

案例一

看看如下的代碼，是在什么場景下有問題：

var p *P
if someCondition {
      p = &P{}
}
print(p.f) // nilness reports NO error here, but NilAway does.

在上述代碼中，當 someCondition 變量值為 true 時，才會初始化結構體 P。如果 someCondition 變量為 false 時，就會出現(xiàn)空指針調用的 panic 問題。

NilAway 工具可以捕獲這種錯誤并報告，會報告如下錯誤：

go.uber.org/example.go:12:9: error: Potential nil panic detected. Observed nil flow from source to dereference point:
    -> go.uber.org/example.go:12:9: unassigned variable `p` accessed field `f`

如果我們增加 if p != nil 來做防御，報告的錯誤就會消失。

案例二

看看如下的代碼，是為什么有問題：

func foo() *int {
 return nil
}
func bar() {
 print(*foo())
}

func main() {
 // 煎魚正在干點什么...
 bar() // nilness reports NO error here, but NilAway does.
}

函數(shù) foo 返回了一個 nil 指針，該指針在函數(shù) bar 中被直接取消引用，導致每當調用函數(shù) bar 時都會出現(xiàn) panic 問題。

NilAway 工具也能捕獲這類跨函數(shù)的的問題，會報告如下錯誤：

?  ~ nilaway demo.go 
/Users/eddycjy/demo.go:7:9: error: Potential nil panic detected. Observed nil flow from source to dereference point: 
 -> eddycjy/demo.go:4:9: literal `nil` returned from `foo()` in position 0
 -> eddycjy/demo.go:7:9: result 0 of `foo()` dereferenced

上面的例子雖然是同 package 內跨函數(shù)的問題識別，但實際上該工具也嫩能夠分析跨 package 的調用。

總結

今天針對 Go 里最常見的 nil 指針問題進行了靜態(tài)分析工具 NilAway 的分享。雖然目前該工具還沒有正式的生產可用。

可以明確的是這是大家在 Go 應用上常碰到的場景，可以多加關注后續(xù)的更新。另外 NilAway 是基于 go/analysis 標準開發(fā)的，后續(xù)可以接入 golangci-lint 等相關工具。大家可以繼續(xù)保持關注！