在实际项目中，需要进行单元测试的时候。却往往发现有一大堆依赖项。这时候就是 Gomock 大显身手的时候了
Gomock 是 Go 语言的一个 mock 框架，官方的那种
安装
1$ go get -u github.com/golang/mock/gomock
2$ go install github.com/golang/mock/mockgen1mockgen -source=foo.go [other options]reflect：通过使用反射程序来生成 mock 接口。它通过传递两个非标志参数来启用：导入路径和逗号分隔的接口列表
1mockgen database/sql/driver Conn,Driver从本质上来讲，两种方式生成的 mock 代码并没有什么区别。因此选择合适的就可以了
写测试用例
在本文将模拟一个简单 Demo 来编写测试用例，熟悉整体的测试流程
步骤
想清楚整体逻辑
定义想要（模拟）依赖项的 interface（接口）
使用 mockgen 命令对所需 mock 的 interface 生成 mock 文件
编写单元测试的逻辑，在测试中使用 mock
进行单元测试的验证
目录
1├── mock
2├── person
3│ └── male.go
4└── user
5 ├── user.go
6 └── user_test.go编写
interface 方法
打开 person/male.go 文件，写入以下内容：
1package person
2
3type Male interface {
4 Get(id int64) error
5}调用方法
打开 user/user.go 文件，写入以下内容：
1package user
2
3import "github.com/EDDYCJY/mockd/person"
4
5type User struct {
6 Person person.Male
7}
8
9func NewUser(p person.Male) *User {
10 return &User{Person: p}
11}
12
13func (u *User) GetUserInfo(id int64) error {
14 return u.Person.Get(id)
15}生成 mock 文件
回到 mockd/ 的根目录下，执行以下命令
1$ mockgen -source=./person/male.go -destination=./mock/male_mock.go -package=mock在执行完毕后，可以发现 mock/ 目录下多出了 male_mock.go 文件，这就是 mock 文件。那么命令中的指令又分别有什么用呢？如下：
-source：设置需要模拟（mock）的接口文件
-destination：设置 mock 文件输出的地方，若不设置则打印到标准输出中
-package：设置 mock 文件的包名，若不设置则为 mock_ 前缀加上文件名（如本文的包名会为 mock_person）
想了解更多的指令符，可参见 官方文档
输出的 mock 文件
1// Code generated by MockGen. DO NOT EDIT.
2// Source: ./person/male.go
3
4// Package mock is a generated GoMock package.
5package mock
6
7import (
8 gomock "github.com/golang/mock/gomock"
9 reflect "reflect"
10)
11
12// MockMale is a mock of Male interface
13type MockMale struct {
14 ctrl *gomock.Controller
15 recorder *MockMaleMockRecorder
16}
17
18// MockMaleMockRecorder is the mock recorder for MockMale
19type MockMaleMockRecorder struct {
20 mock *MockMale
21}
22
23// NewMockMale creates a new mock instance
24func NewMockMale(ctrl *gomock.Controller) *MockMale {
25 mock := &MockMale{ctrl: ctrl}
26 mock.recorder = &MockMaleMockRecorder{mock}
27 return mock
28}
29
30// EXPECT returns an object that allows the caller to indicate expected use
31func (m *MockMale) EXPECT() *MockMaleMockRecorder {
32 return m.recorder
33}
34
35// Get mocks base method
36func (m *MockMale) Get(id int64) error {
37 ret := m.ctrl.Call(m, "Get", id)
38 ret0, _ := ret[0].(error)
39 return ret0
40}
41
42// Get indicates an expected call of Get
43func (mr *MockMaleMockRecorder) Get(id interface{}) *gomock.Call {
44 return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Get", reflect.TypeOf((*MockMale)(nil).Get), id)
45}测试用例
打开 user/user_test.go 文件，写入以下内容：
1package user
2
3import (
4 "testing"
5
6 "github.com/EDDYCJY/mockd/mock"
7
8 "github.com/golang/mock/gomock"
9)
10
11func TestUser_GetUserInfo(t *testing.T) {
12 ctl := gomock.NewController(t)
13 defer ctl.Finish()
14
15 var id int64 = 1
16 mockMale := mock.NewMockMale(ctl)
17 gomock.InOrder(
18 mockMale.EXPECT().Get(id).Return(nil),
19 )
20
21 user := NewUser(mockMale)
22 err := user.GetUserInfo(id)
23 if err != nil {
24 t.Errorf("user.GetUserInfo err: %v", err)
25 }
26}
27}gomock.NewController：返回 gomock.Controller，它代表 mock 生态系统中的顶级控件。定义了 mock 对象的范围、生命周期和期待值。另外它在多个 goroutine 中是安全的
mock.NewMockMale：创建一个新的 mock 实例
gomock.InOrder：声明给定的调用应按顺序进行（是对 gomock.After 的二次封装）
mockMale.EXPECT().Get(id).Return(nil)：这里有三个步骤，EXPECT()返回一个允许调用者设置期望和返回值的对象。Get(id) 是设置入参并调用 mock 实例中的方法。Return(nil) 是设置先前调用的方法出参。简单来说，就是设置入参并调用，最后设置返回值
NewUser(mockMale)：创建 User 实例，值得注意的是，在这里注入了 mock 对象，因此实际在随后的 user.GetUserInfo(id) 调用（入参：id 为 1）中。它调用的是我们事先模拟好的 mock 方法
ctl.Finish()：进行 mock 用例的期望值断言，一般会使用 defer 延迟执行，以防止我们忘记这一操作
测试
回到 mockd/ 的根目录下，执行以下命令
1$ go test ./user
2ok github.com/EDDYCJY/mockd/user看到这样的结果，就大功告成啦！你可以自己调整一下 Return() 的返回值，以此得到不一样的测试结果哦
查看测试情况
测试覆盖率
1$ go test -cover ./user
2ok github.com/EDDYCJY/mockd/user (cached) coverage: 100.0% of statements可通过设置 -cover 标志符来开启覆盖率的统计，展示内容为 coverage: 100.0%。
可视化界面
生成测试覆盖率的 profile 文件
1$ go test ./... -coverprofile=cover.out1$ go tool cover -html=cover.out
更多
一、常用 mock 方法
调用方法
Call.Do()：声明在匹配时要运行的操作
Call.DoAndReturn()：声明在匹配调用时要运行的操作，并且模拟返回该函数的返回值
Call.MaxTimes()：设置最大的调用次数为 n 次
Call.MinTimes()：设置最小的调用次数为 n 次
Call.AnyTimes()：允许调用次数为 0 次或更多次
Call.Times()：设置调用次数为 n 次
参数匹配
gomock.Any()：匹配任意值
gomock.Eq()：通过反射匹配到指定的类型值，而不需要手动设置
gomock.Nil()：返回 nil
建议更多的方法可参见 官方文档
二、生成多个 mock 文件
你可能会想一条条命令生成 mock 文件，岂不得崩溃？
当然，官方提供了更方便的方式，我们可以利用 go:generate 来完成批量处理的功能
1go generate [-run regexp] [-n] [-v] [-x] [build flags] [file.go... | packages]修改 interface 方法
打开 person/male.go 文件，修改为以下内容：
1package person
2
3//go:generate mockgen -destination=../mock/male_mock.go -package=mock github.com/EDDYCJY/mockd/person Male
4
5type Male interface {
6 Get(id int64) error
7}我们关注到 go:generate 这条语句，可分为以下部分：
声明 //go:generate （注意不要留空格）
使用 mockgen 命令
定义 -destination
定义 -package
定义 source，此处为 person 的包路径
定义 interfaces，此处为 Male
重新生成 mock 文件
回到 mockd/ 的根目录下，执行以下命令
1$ go generate ./...再检查 mock/ 发现也已经正确生成了，在多个文件时是不是很方便呢
总结
在单元测试这一环，gomock 给我们提供了极大的便利。能够 mock 掉许许多多的依赖项，其中还有很多的使用方式和功能。你可以 mark 住后详细阅读下官方文档，记忆会更深刻。
原文发布时间为：2018-12-4
本文作者：Golang语言社区
本文来自云栖社区合作伙伴“ Golang语言社区”，了解相关信息可以关注“Golangweb”微信公众号
