Go Generate 代替 Makefile使用方法详解
介绍
图灵完备性(Turing completeness)是通用计算机的一个属性，它表示一个程序可以写另一个程序。比如 go test 命令：它会扫描被测试的包，写一个包含测试内容的程序，然后编译运行。
可能你听得比较多的是元编程(meta-program)。这里不细究他们的区别。我们重点是，用程序生成另一个程序的场景，越来越广泛了。比如：
- protobufs: 根据 pb 文件（.proto）生成 go 代码文件(.pb.go)
- yacc: 根据 yacc 文件（.y）生成 go 代码文件
- bindata: 二进制文件（如 JPEG）转成 go 的 bytes 数组
- mockery: 根据 go 的 interface 生成 Mock 对象（依赖
stretchr/testify/mock包）。
自动生成代码的命令，该如何集成进项目里面？一般来说，我们可以借助外部的工具，如 Make。使用 Go 1.4 新增的 go generate 命令，就可以避免外部工具了。
Mockery
我们以 mockery 为例，关于 mockery 生成的 Mock 对象，我之前的文章有介绍过：Go 库：单元测试利器 testify。
比如我们定义了 Greeter 接口，作为 Hello 的参数（代码本身无意义，仅做示例）：
// greet.go 文件
package greet
type Greeter interface {
Greet() string
}
// 加上"hello"前缀
func Hello(g Greeter) string {
return "hello " + g.Greet()
}
我们要给 Hello 函数写单元测试的话，就需要为 Greeter 写一个 Mock 对象。我们可以使用 mockery 来生成。
安装 mockery：
go install github.com/vektra/mockery/v2@latest
为当前包下的所有 interface 生成 mock 对象，输出到 mocks 目录。
mockery --output mocks/ --dir . --all
我们查看目录文件：
➜ tree
.
├── greet.go
└── mocks // mockery 生成的 mock 对象
└── Greeter.go
1 directory, 2 files
关于 mockery 的说明，我们可以查看仓库：github.com/vektra/mock…。现在，我们可以为 Hello 写单元测试了：
// greet_test.go 文件
package greet
import (
"example/greet/mocks"
"testing"
"github.com/stretchr/testify/assert"
)
func TestHello(t *testing.T) {
// 实例化 mock 对象
greeter := new(mocks.Greeter)
// 设置预期，当请求 greeter.Greet() 时，返回 "world"
greeter.On("Greet").Return("world")
want := "hello world"
got := Hello(greeter)
// 断言相等
assert.Equal(t, want, got)
}
Go Generate
我们接下来的问题是，Mockery 命令需要集成到项目里，我们可以写 shell 脚本、或者 Make 文件，但这些都不是 go tool 的工具。
用法
go generate 非常方便使用，只要当前目录的 .go 文件（如 greet.go 文件），加上备注：
//go:generate mockery --output mocks/ --dir . --all
我们先把刚刚生成的 mocks 目录删除，当前目录结构是：
➜ tree . ├── greet.go └── greet_test.go 0 directories, 2 files
然后进入 greet 包，执行 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
打印目录结构，会发现 mocks 对象又生成了：
➜ tree
.
├── greet.go
├── greet_test.go
└── mocks
└── Greeter.go
1 directory, 3 files
总结
Rob Pike 大神在 go generate 的提案有说过，希望 go generate 能替换 go 仓库中的 Makefile。本人没有明显的偏向，但是 go generate 确实不失为一个优秀的工具。
引用
以上就是Go Generate 代替 Makefile使用方法详解的详细内容，更多关于Go Generate代替Makefile的资料请关注脚本之家其它相关文章！
相关文章
相信大家都知道不同语言之间的通信方式有很多种，这篇文章详细的介绍了PHP与Go语言之间如何通信，有需要的朋友们可以参考借鉴，下面来一起看看吧。2016-10-10
备忘录是一种行为设计模式, 允许生成对象状态的快照并在以后将其还原,本文就通过代码示例给大家讲讲Go备忘录模式,感兴趣的小伙伴跟着小编一起来看看吧2023-08-08
golang 定时任务方面time.Sleep和time.Tick的优劣对比分析
这篇文章主要介绍了golang 定时任务方面time.Sleep和time.Tick的优劣对比分析，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧2021-05-05
在golang当中，defer代码块会在函数调用链表中增加一个函数调用。这个函数调用不是普通的函数调用，而是会在函数正常返回，也就是return之后添加一个函数调用。因此，defer通常用来释放函数内部变量2022-10-10
本文主要介绍了go写文件后出现大量NUL字符问题解决,由于每次写的时候设置的长度都是64,在某次不足64时,byte切片空余位置被填充为空字符,下面就来介绍一下如何解决2023-12-12
golang中import cycle not allowed解决的一种思路
这篇文章主要给大家介绍了关于golang中import cycle not allowed解决的一种思路，文中通过示例代码介绍的非常详细，需要的朋友可以参考借鉴，下面随着小编来一起学习学习吧2018-08-08
这篇文章主要介绍了解决Golang全局变量加锁的问题，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧2021-05-05
本文主要介绍了GO利用channel协调协程的实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2023-05-05
这篇文章主要介绍了golang 并发安全Map以及分段锁的实现方法，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧2019-03-03
这篇文章主要介绍了go语言简单网络程序实现方法,实例分析了服务器端与客户端的实现技巧,具有一定参考借鉴价值,需要的朋友可以参考下2015-02-02
最新评论