Go Uber靜態(tài)分析工具NilAway使用初體驗

更新時間：2024年01月11日 11:24:31 作者：程序員大兵

這篇文章主要介紹了Go Uber靜態(tài)分析工具NilAway使用詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪

Uber 開源的靜態(tài)分析工具 NilAway

今天給大家介紹以下 Uber 開源的靜態(tài)分析工具 NilAway，下面開魯。

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

NilAway是一個靜態(tài)分析工具，旨在通過在編譯時而不是運行時捕獲nil panic來幫助開發(fā)人員避免在生產(chǎn)中出現(xiàn)這種情況。NilAway類似于標準的nilness分析器，但它采用更復雜和強大的靜態(tài)分析技術來跟蹤包內(nèi)和跨包的nil流，并報告錯誤，為用戶提供更輕松的調(diào)試nilness流程。

NilAway關鍵特性

NilAway具有三個關鍵特性，使其脫穎而出：

完全自動化：NilAway配備有推理引擎，因此除了標準的Go代碼之外，它不需要從開發(fā)人員那里獲取任何其他信息（例如注釋）。

速度快：我們設計NilAway為快速且可擴展，適用于大型代碼庫。在我們的測量中，啟用NilAway時構建時間開銷不到5%。我們還在不斷應用優(yōu)化來進一步減少其占用空間。

實用性：它不能阻止代碼中所有可能的nil panic，但它可以捕獲我們在生產(chǎn)中觀察到的大多數(shù)潛在nil panic，使NilAway在實用性和構建時間開銷之間保持良好平衡。

安裝

NilAway是使用標準的go/analysis框架實現(xiàn)的，因此易于與現(xiàn)有的分析驅動程序集成（例如golangci-lint、nogo或作為獨立檢查器運行）。下面是將NilAway作為獨立檢查器運行的說明。更多集成支持將很快添加。

獨立檢查器

通過以下命令從源代碼安裝二進制文件：

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

然后，通過以下命令運行l(wèi)inter：

nilaway ./...

案例一 NilAway如何幫助防止nil panic

讓我們看一些示例，了解NilAway如何幫助防止nil panic。

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

在這個示例中，局部變量p僅在someCondition為true時初始化。在字段訪問p.f時，如果someCondition為false，則可能發(fā)生panic。NilAway能夠捕獲這個潛在的nil導致的panic并報告以下錯誤：

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`

如果我們使用nil檢查（if p != nil）保護此解引用，錯誤將消失。

案例二 NilAway還能夠捕獲跨函數(shù)的nil流

例如，考慮以下代碼片段：

// Example 2:
func foo() *int {
      return nil
}
func bar() {
     print(*foo()) // nilness reports NO error here, but NilAway does.
}

在這個示例中，函數(shù)foo返回一個nil指針，在bar中直接解引用，無論何時調(diào)用bar都會導致panic。NilAway能夠捕獲這個潛在的nil導致的panic并報告以下錯誤：

go.uber.org/example.go:23:13: error: Potential nil panic detected. Observed nil flow from source to dereference point:
    -> go.uber.org/example.go:20:14: literal `nil` returned from `foo()` in position 0
    -> go.uber.org/example.go:23:13: result 0 of `foo()` dereferenced

請注意，在上面的示例中，foo不一定要與bar位于同一個包中。NilAway還能夠跟蹤跨包的nil流。此外，NilAway處理Go特定的語言構造，如接收器、接口、類型斷言、類型開關等。