前言

多人協(xié)作的項(xiàng)目里，要保證代碼的質(zhì)量，自然離不開單元測(cè)試。開發(fā)完一個(gè)功能后肯定要對(duì)所寫的代碼進(jìn)行測(cè)試，測(cè)試沒有問題之后再合并到代碼庫供他人使用。如果強(qiáng)行合并到代碼庫可能會(huì)影響其他人開發(fā)，被上線的話肯定也會(huì)導(dǎo)致線上 Bug ，影響用戶使用。

所以，單元測(cè)試也是一個(gè)很重要的事情。單元測(cè)試是指在開發(fā)中，對(duì)一個(gè)函數(shù)或模塊的測(cè)試。其強(qiáng)調(diào)的是對(duì)單元進(jìn)行測(cè)試。

Go 單元測(cè)試

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

測(cè)試文件命名：

• 單元測(cè)試的代碼文件都必須以 _test.go 結(jié)尾，這樣才能被 Go 語言測(cè)試工具識(shí)別
• 單元測(cè)試的文件命名都與被測(cè)試函數(shù)所在的 go 文件的文件名一樣，然后再加 _test.go。比如 main.go 的測(cè)試文件 main_test.go

測(cè)試函數(shù)命名：

• 單元測(cè)試的函數(shù)名必須以 Test 開頭，再加上要測(cè)試函數(shù)名，且必須是公有的。比如main.go中有函數(shù) func add(){},   其函數(shù)名應(yīng)為 TestAdd
• 測(cè)試函數(shù)的簽名必須接收一個(gè)指向 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")
    }
}

根據(jù)以上規(guī)則，就可以進(jìn)行對(duì)某測(cè)試文件執(zhí)行命令，進(jìn)行單元測(cè)試:

go test -v ./main_test.go

如果顯示的測(cè)試結(jié)果有 PASS 標(biāo)記，說明單元測(cè)試通過。

單元測(cè)試覆蓋率

函數(shù)是否被全面測(cè)試，還需要覆蓋率進(jìn)行檢測(cè)。單元測(cè)試命令增加 --coverprofile 標(biāo)記，就可以得到一個(gè)單元測(cè)試覆蓋文件，且會(huì)在控制臺(tái)打印出代碼覆蓋率是多少。

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

Go 框架還可以生成 html 文件的覆蓋率報(bào)告，這樣就可以對(duì)單元測(cè)試覆蓋率的結(jié)果更清晰，更明白。

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

打開 html 文件就可以看到紅色標(biāo)記是沒有被覆蓋到，綠色是被測(cè)試到的。

以上是簡單的功能的單元測(cè)試，驗(yàn)證功能邏輯的正確。但有時(shí)候還有性能的要求，這時(shí)就可以使用基準(zhǔn)測(cè)試來評(píng)估代碼的性能。

基準(zhǔn)測(cè)試

基準(zhǔn)測(cè)試是一項(xiàng)用于測(cè)試和評(píng)估軟件性能指標(biāo)的方法，主要測(cè)試代碼的性能?；鶞?zhǔn)測(cè)試的規(guī)則和單元測(cè)試的規(guī)則是不一樣的：

• 基準(zhǔn)測(cè)試函數(shù)必須以 Benchmark 開頭，且必須是可導(dǎo)出的
• 函數(shù)的簽名必須接收一個(gè)指向 testing.B 類型的指針，并且不能返回任何值；
• 最后的 for 循環(huán)很重要，被測(cè)試的代碼要放到循環(huán)里；
• b.N 是基準(zhǔn)測(cè)試框架提供的，表示循環(huán)的次數(shù)，因?yàn)樾枰磸?fù)調(diào)用測(cè)試的代碼，才可以評(píng)估性能。

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

寫完基準(zhǔn)測(cè)試，就可以執(zhí)行命令進(jìn)行測(cè)試：

go test -bench=. ./

使用 go test 命令，再加上 -bench 這個(gè) Flag，它接受一個(gè)表達(dá)式作為參數(shù)，以匹配基準(zhǔn)測(cè)試的函數(shù)，"."表示運(yùn)行所有基準(zhǔn)測(cè)試。

BenchmarkAdd-10, 其中的 -10 是運(yùn)行基準(zhǔn)測(cè)試時(shí)對(duì)應(yīng)的 GOMAXPROCS 的值?；鶞?zhǔn)測(cè)試的時(shí)間默認(rèn)是 1 秒，也就是 1 秒調(diào)用 1000000000 次、每次調(diào)用花費(fèi) 311 納秒。如果想讓測(cè)試運(yùn)行的時(shí)間更長，可以通過 -benchtime 指定，比如 3 秒。

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

• 重置計(jì)時(shí)方法

進(jìn)行基準(zhǔn)測(cè)試之前，需要進(jìn)行一些數(shù)據(jù)準(zhǔn)備，如構(gòu)建測(cè)試數(shù)據(jù)，而這部分準(zhǔn)備工作不屬于性能測(cè)試計(jì)算范圍內(nèi)所以需要排除在外。通過使用充值計(jì)數(shù)器 ResetTimer重新計(jì)算。也支持使用 StartTimer 和 StopTimer 方法，控制何時(shí)開始計(jì)時(shí)何時(shí)結(jié)束。

• 內(nèi)存統(tǒng)計(jì)

內(nèi)存統(tǒng)計(jì)主要是統(tǒng)計(jì)每次操作分配內(nèi)存的次數(shù)和分配的字節(jié)數(shù)。使用 ReportAllocs() 方法

func BenchmarkAdd(b *testing.B) {
    b.ResetTimer() // 重置計(jì)時(shí)時(shí)間
    b.ReportAllocs() // 內(nèi)存統(tǒng)計(jì)
    for i := 0; i < b.N; i++ {
        Add()
    }
}

對(duì)以上命令執(zhí)行后可在控制臺(tái)上得到結(jié)果。多了兩個(gè)指標(biāo)。

• 第一個(gè)表示：每次操作分配多少字節(jié)內(nèi)存
• 第二個(gè)表示：每次操作分配內(nèi)存的次數(shù)

兩個(gè)指標(biāo)沒有統(tǒng)一標(biāo)準(zhǔn)區(qū)說明越小越好還是越大越好，主要還是需要根據(jù)業(yè)務(wù)場(chǎng)景來判斷的。

• 并發(fā)基準(zhǔn)測(cè)試

在并發(fā)的情況下，Go 也支持基準(zhǔn)測(cè)試。Go 語言通過 RunParallel 方法運(yùn)行并發(fā)基準(zhǔn)測(cè)試。創(chuàng)建多個(gè) goroutine 然后將 b.N 分配給這些 goroutine 執(zhí)行。

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

單元測(cè)試可以保證代碼質(zhì)量，但其也不是萬能的，還需要 code Review 和人工測(cè)試才能更好的保證代碼的質(zhì)量。

參考資料：http://www.dbjr.com.cn/article/260482.htm

以上就是Golang 單元測(cè)試和基準(zhǔn)測(cè)試實(shí)例詳解的詳細(xì)內(nèi)容，更多關(guān)于Golang 單元測(cè)試基準(zhǔn)測(cè)試的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

最新評(píng)論