Golang 單元測試和基準測試範例詳解

2022-08-24 14:01:14

前言

多人共同作業的專案裡，要保證程式碼的質量，自然離不開單元測試。開發完一個功能後肯定要對所寫的程式碼進行測試，測試沒有問題之後再合併到程式碼庫供他人使用。如果強行合併到程式碼庫可能會影響其他人開發，被上線的話肯定也會導致線上 Bug ，影響使用者使用。

所以，單元測試也是一個很重要的事情。單元測試是指在開發中，對一個函數或模組的測試。其強調的是對單元進行測試。

Go 單元測試

Go 語言提供了單元測試的框架，只要遵循其規則即可：

測試檔案命名：

單元測試的程式碼檔案都必須以 _test.go 結尾，這樣才能被 Go 語言測試工具識別
單元測試的檔案命名都與被測試函數所在的 go 檔案的檔名一樣，然後再加 _test.go。比如 main.go 的測試檔案 main_test.go

測試函數命名：

單元測試的函數名必須以 Test 開頭，再加上要測試函數名，且必須是公有的。比如main.go中有函數 func add(){}, 其函數名應為 TestAdd
測試函數的簽名必須接收一個指向 testing.T 型別的指標，並且不能返回任何值

# main.go
func Add(){
    // to do something
}
# main_test.go
func TestAdd(t *testing.T) {
    result := Add()
    if result == 3 {
        println("success")
    } else {
        println("error")
    }
}

根據以上規則，就可以進行對某測試檔案執行命令，進行單元測試:

go test -v ./main_test.go

如果顯示的測試結果有 PASS 標記，說明單元測試通過。

單元測試覆蓋率

函數是否被全面測試，還需要覆蓋率進行檢測。單元測試命令增加 --coverprofile 標記，就可以得到一個單元測試覆蓋檔案，且會在控制檯列印出程式碼覆蓋率是多少。

go test -v --coverprofile=main.cover ./main_test.go

Go 框架還可以生成 html 檔案的覆蓋率報告，這樣就可以對單元測試覆蓋率的結果更清晰，更明白。

go tool cover -html=main.cover -o=main.html

開啟 html 檔案就可以看到紅色標記是沒有被覆蓋到，綠色是被測試到的。

以上是簡單的功能的單元測試，驗證功能邏輯的正確。但有時候還有效能的要求，這時就可以使用基準測試來評估程式碼的效能。

基準測試

基準測試是一項用於測試和評估軟體效能指標的方法，主要測試程式碼的效能。基準測試的規則和單元測試的規則是不一樣的：

基準測試函數必須以 Benchmark 開頭，且必須是可匯出的
函數的簽名必須接收一個指向 testing.B 型別的指標，並且不能返回任何值；
最後的 for 迴圈很重要，被測試的程式碼要放到迴圈裡；
b.N 是基準測試框架提供的，表示迴圈的次數，因為需要反覆呼叫測試的程式碼，才可以評估效能。

func BenchmarkAdd(b *testing.B) {
    for i := 0; i &lt; b.N; i++ {
        Add()
    }
}

寫完基準測試，就可以執行命令進行測試：

go test -bench=. ./

使用 go test 命令，再加上 -bench 這個 Flag，它接受一個表示式作為引數，以匹配基準測試的函數，"."表示執行所有基準測試。

BenchmarkAdd-10, 其中的 -10 是執行基準測試時對應的 GOMAXPROCS 的值。基準測試的時間預設是 1 秒，也就是 1 秒呼叫 1000000000 次、每次呼叫花費 311 納秒。如果想讓測試執行的時間更長，可以通過 -benchtime 指定，比如 3 秒。

go test -bench=. -benchtime=3s ./

重置計時方法

進行基準測試之前，需要進行一些資料準備，如構建測試資料，而這部分準備工作不屬於效能測試計算範圍內所以需要排除在外。通過使用充值計數器 ResetTimer重新計算。也支援使用 StartTimer 和 StopTimer 方法，控制何時開始計時何時結束。

記憶體統計

記憶體統計主要是統計每次操作分配記憶體的次數和分配的位元組數。使用 ReportAllocs() 方法

func BenchmarkAdd(b *testing.B) {
    b.ResetTimer() // 重置計時時間
    b.ReportAllocs() // 記憶體統計
    for i := 0; i &lt; b.N; i++ {
        Add()
    }
}

對以上命令執行後可在控制檯上得到結果。多了兩個指標。

第一個表示：每次操作分配多少位元組記憶體
第二個表示：每次操作分配記憶體的次數

兩個指標沒有統一標準區說明越小越好還是越大越好，主要還是需要根據業務場景來判斷的。

並行基準測試

在並行的情況下，Go 也支援基準測試。Go 語言通過 RunParallel 方法執行並行基準測試。建立多個 goroutine 然後將 b.N 分配給這些 goroutine 執行。

func BenchmarkAdd(b *testing.B) {
    b.RunParallel(func(pb *testing.PB) {
        for pb.Next() {
            Add()
        }
    })
}

單元測試可以保證程式碼質量，但其也不是萬能的，還需要 code Review 和人工測試才能更好的保證程式碼的質量。

參考資料：https://www.jb51.net/article/260482.htm

以上就是Golang 單元測試和基準測試範例詳解的詳細內容，更多關於Golang 單元測試基準測試的資料請關注it145.com其它相關文章！

Golang 單元測試和基準測試範例詳解

目錄

前言

Go 單元測試

單元測試覆蓋率

基準測試

熱門文章