介紹

圖靈完備性(Turing completeness)是通用計(jì)算機(jī)的一個(gè)屬性，它表示一個(gè)程序可以寫(xiě)另一個(gè)程序。比如 go test 命令：它會(huì)掃描被測(cè)試的包，寫(xiě)一個(gè)包含測(cè)試內(nèi)容的程序，然后編譯運(yùn)行。

可能你聽(tīng)得比較多的是元編程(meta-program)。這里不細(xì)究他們的區(qū)別。我們重點(diǎn)是，用程序生成另一個(gè)程序的場(chǎng)景，越來(lái)越廣泛了。比如：

• protobufs: 根據(jù) pb 文件（.proto）生成 go 代碼文件(.pb.go)
• yacc: 根據(jù) yacc 文件（.y）生成 go 代碼文件
• bindata: 二進(jìn)制文件（如 JPEG）轉(zhuǎn)成 go 的 bytes 數(shù)組
• mockery: 根據(jù) go 的 interface 生成 Mock 對(duì)象（依賴 stretchr/testify/mock 包）。

自動(dòng)生成代碼的命令，該如何集成進(jìn)項(xiàng)目里面？一般來(lái)說(shuō)，我們可以借助外部的工具，如 Make。使用 Go 1.4 新增的 go generate 命令，就可以避免外部工具了。

Mockery

我們以 mockery 為例，關(guān)于 mockery 生成的 Mock 對(duì)象，我之前的文章有介紹過(guò)：Go 庫(kù)：?jiǎn)卧獪y(cè)試?yán)?testify。

比如我們定義了 Greeter 接口，作為 Hello 的參數(shù)（代碼本身無(wú)意義，僅做示例）：

// greet.go 文件
package greet
type Greeter interface {
	Greet() string
}
// 加上"hello"前綴
func Hello(g Greeter) string {
	return "hello " + g.Greet()
}

我們要給 Hello 函數(shù)寫(xiě)單元測(cè)試的話，就需要為 Greeter 寫(xiě)一個(gè) Mock 對(duì)象。我們可以使用 mockery 來(lái)生成。

安裝 mockery：

go install github.com/vektra/mockery/v2@latest

為當(dāng)前包下的所有 interface 生成 mock 對(duì)象，輸出到 mocks 目錄。

mockery --output mocks/ --dir . --all

我們查看目錄文件：

? tree
.
├── greet.go
└── mocks             // mockery 生成的 mock 對(duì)象
    └── Greeter.go
1 directory, 2 files

關(guān)于 mockery 的說(shuō)明，我們可以查看倉(cāng)庫(kù)：github.com/vektra/mock…?，F(xiàn)在，我們可以為 Hello 寫(xiě)單元測(cè)試了：

// greet_test.go 文件
package greet
import (
	"example/greet/mocks"
	"testing"
	"github.com/stretchr/testify/assert"
)
func TestHello(t *testing.T) {
  // 實(shí)例化 mock 對(duì)象
	greeter := new(mocks.Greeter)
  // 設(shè)置預(yù)期，當(dāng)請(qǐng)求 greeter.Greet() 時(shí)，返回 "world"
	greeter.On("Greet").Return("world")
	want := "hello world"
	got := Hello(greeter)
  // 斷言相等
	assert.Equal(t, want, got)
}

Go Generate

我們接下來(lái)的問(wèn)題是，Mockery 命令需要集成到項(xiàng)目里，我們可以寫(xiě) shell 腳本、或者 Make 文件，但這些都不是 go tool 的工具。

用法

go generate 非常方便使用，只要當(dāng)前目錄的 .go 文件（如 greet.go 文件），加上備注：

//go:generate mockery --output mocks/ --dir . --all

我們先把剛剛生成的 mocks 目錄刪除，當(dāng)前目錄結(jié)構(gòu)是：

?   tree
.
├── greet.go
└── greet_test.go
0 directories, 2 files

然后進(jìn)入 greet 包，執(zhí)行 go generate:

?  go generate  
01 Dec 22 20:06 CST INF Starting mockery dry-run=false version=v2.10.0
01 Dec 22 20:06 CST INF Walking dry-run=false version=v2.10.0
01 Dec 22 20:06 CST INF Generating mock dry-run=false interface=Greeter qualified-name=example/greet version=v2.10.0

打印目錄結(jié)構(gòu)，會(huì)發(fā)現(xiàn) mocks 對(duì)象又生成了：

? tree
.
├── greet.go
├── greet_test.go
└── mocks
    └── Greeter.go
1 directory, 3 files

總結(jié)

Rob Pike 大神在 go generate 的提案有說(shuō)過(guò)，希望 go generate 能替換 go 倉(cāng)庫(kù)中的 Makefile。本人沒(méi)有明顯的偏向，但是 go generate 確實(shí)不失為一個(gè)優(yōu)秀的工具。

引用

• go.dev/blog/genera…
• go.googlesource.com/proposal/+/…

以上就是Go Generate 代替 Makefile使用方法詳解的詳細(xì)內(nèi)容，更多關(guān)于Go Generate代替Makefile的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

最新評(píng)論