脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 脚本专栏 → Golang → Go Generate代替Makefile

Go Generate 代替 Makefile使用方法详解

 更新时间：2022年12月15日 11:05:16   作者：小马别过河  
这篇文章主要为大家介绍了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的资料请关注脚本之家其它相关文章！

您可能感兴趣的文章:

相关文章

  • Golang切片连接成字符串的实现示例

    Golang切片连接成字符串的实现示例

    本文主要介绍了Golang切片连接成字符串的实现示例,可以使用Go语言中的内置函数"String()"可以将字节切片转换为字符串,具有一定的参考价值,感兴趣的可以了解一下
    2023-11-11
  • Go语言图片处理和生成缩略图的方法

    Go语言图片处理和生成缩略图的方法

    这篇文章主要介绍了Go语言图片处理和生成缩略图的方法,涉及Go语言针对图片操作的技巧,具有一定参考借鉴价值,需要的朋友可以参考下
    2015-02-02
  • go语言中的指针自动解引用

    go语言中的指针自动解引用

    Go语言中,编译器会自动解引用指针来访问字段,自动解引用使得使用指针访问结构体字段和方法变得更加直观,降低了编程错误的风险,并使代码更易于理解和维护
    2024-10-10
  • Golang切片删除指定元素的三种方法对比

    Golang切片删除指定元素的三种方法对比

    Go语言并没有提供用于删除元素的语法或接口,而是通过利用切片本身的特性来删除元素—追加元素,这篇文章主要给大家介绍了关于Golang切片删除指定元素的三种方法,需要的朋友可以参考下
    2022-06-06
  • Go GORM 事务详细介绍

    Go GORM 事务详细介绍

    这篇文章主要介绍了Go GORM事务详细介绍，GORM 会在事务里执行写入操作创建、更新、删除，具体详细介绍需要的朋友可以参考下面文章的简单介绍
    2022-07-07
  • goland Duration 和time的区别说明

    goland Duration 和time的区别说明

    这篇文章主要介绍了goland Duration 和time的区别说明，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
    2020-12-12
  • Go 切片导致内存泄露的几种原因

    Go 切片导致内存泄露的几种原因

    某些情况下，对一个已存在的切片或数组进行切分操作可能会导致内存泄漏，本文主要介绍了Go 切片导致内存泄露的几种原因，感兴趣的可以了解一下
    2023-05-05
  • Go实现分布式系统高可用限流器实战

    Go实现分布式系统高可用限流器实战

    这篇文章主要为大家介绍了Go实现分布式系统高可用限流器实战，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
    2022-06-06
  • Go语言实战之切片内存优化

    Go语言实战之切片内存优化

    Go 语言的切片是一个动态的数据结构，可以方便地对其进行扩容和缩容操作。这篇文章主要为大家详细介绍了Go语言如何实现切片内存优化，需要的可以参考一下
    2023-03-03
  • Go 高效截取字符串的一些思考

    Go 高效截取字符串的一些思考

    这篇文章主要介绍了Go 高效截取字符串的一些思考，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2019-10-10

最新评论