Go语言使用gomock实现逻辑层单元测试Mock

准备工作

在进行逻辑层单元测试之前，首先需要安装用于生成 Mock 代码的命令行工具。使用以下命令安装指定版本的 mockgen：

go install github.com/golang/mock/mockgen@v1.6.0

基本案例：逻辑层接口定义

假设我们已经有一个用户服务层 UserService，它依赖于数据层接口 UserRepo。这是我们需要进行单元测试的目标对象：

package service

import (
    "context"
    "fmt"

    "go-demo/m/unit-test/entity"
)

type UserRepo interface {
    AddUser(ctx context.Context, user *entity.User) (err error)
    DelUser(ctx context.Context, userID int) (err error)
    GetUser(ctx context.Context, userID int) (user *entity.User, exist bool, err error)
}

type UserService struct {
    userRepo UserRepo
}

func NewUserService(userRepo UserRepo) *UserService {
    return &UserService{userRepo: userRepo}
}

func (us *UserService) AddUser(ctx context.Context, username string) (err error) {
    if len(username) == 0 {
        return fmt.Errorf("username not specified")
    }
    return us.userRepo.AddUser(ctx, &entity.User{Username: username})
}

func (us *UserService) GetUser(ctx context.Context, userID int) (user *entity.User, err error) {
    userInfo, exist, err := us.userRepo.GetUser(ctx, userID)
    if err != nil {
        return nil, err
    }
    if !exist {
        return nil, fmt.Errorf("user %d not found", userID)
    }
    return userInfo, nil
}

目标很明确：不实际连接数据库，而是 Mock 掉 UserRepo 接口的方法，从而单独测试 AddUser 和 GetUser 的业务逻辑判断。

第一步：使用 mockgen 生成 Mock 接口

使用 mockgen 命令根据源文件中的接口定义生成对应的 Mock 实现代码。执行以下命令：

mockgen -source=./service/user.go -destination=./mock/user_mock.go -package=mock

• -source: 包含需要 Mock 接口的源文件路径。
• -destination: 生成的 Mock 代码存放位置。
• -package: 生成的代码所属包名。

执行完成后，会在指定目录生成如下的 user_mock.go 文件，其中包含了 MockUserRepo 结构体及其方法拦截逻辑。我们可以简单查看其内部实现以确认生成正确：

// Code generated by MockGen. DO NOT EDIT.
// Source: ./user.go

// Package mock is a generated GoMock package.
package mock

import (
    context "context"
    entity "go-demo/m/unit-test/entity"
    reflect "reflect"

    gomock "github.com/golang/mock/gomock"
)

// MockUserRepo is a mock of UserRepo interface.
type MockUserRepo struct {
    ctrl     *gomock.Controller
    recorder *MockUserRepoMockRecorder
}
// ... (省略部分自动生成的 getter 和 matchers)

第二步：编写 Service 层单元测试

在测试文件中，初始化 gomock.Controller 并创建 Mock 对象。利用 EXPECT() 方法设置预期的方法调用参数和返回值，最后实例化 UserService 进行测试。此处推荐使用 testify/assert 库进行断言。

package service

import (
    "context"
    "testing"

    "github.com/golang/mock/gomock"
    "github.com/stretchr/testify/assert"
    "go-demo/m/unit-test/entity"
    "go-demo/m/unit-test/mock"
)

func TestUserService_AddUser(t *testing.T) {
    ctl := gomock.NewController(t)
    defer ctl.Finish()

    // 创建 Mock 对象
    mockUserRepo := mock.NewMockUserRepo(ctl)
    userInfo := &entity.User{Username: "LinkinStar"}
    
    // 设置预期：无论传入什么参数，AddUser 都返回 nil
    mockUserRepo.EXPECT().AddUser(gomock.Any(), gomock.Any()).Return(nil)

    // 实例化服务对象
    userService := NewUserService(mockUserRepo)
    err := userService.AddUser(context.TODO(), userInfo.Username)
    assert.NoError(t, err)
}

func TestUserService_GetUser(t *testing.T) {
    ctl := gomock.NewController(t)
    defer ctl.Finish()

    userID := 1
    username := "LinkinStar"

    mockUserRepo := mock.NewMockUserRepo(ctl)
    
    // 设置预期：当传入特定 UserID 时，返回具体的用户信息和成功状态
    mockUserRepo.EXPECT().GetUser(context.TODO(), userID).Return(&entity.User{
        ID:       userID,
        Username: username,
    }, true, nil)

    userService := NewUserService(mockUserRepo)
    userInfo, err := userService.GetUser(context.TODO(), userID)
    assert.NoError(t, err)
    assert.Equal(t, username, userInfo.Username)
}

上述测试清晰地展示了如何根据业务逻辑控制 Mock 的返回行为，并利用断言验证最终结果是否符合预期。

优化：使用 go:generate 自动化生成

随着项目迭代，接口修改频繁，手动执行 mockgen 命令容易遗忘且繁琐。可以在源文件上方添加 //go:generate 注释来优化这一流程：

//go:generate mockgen -source=./user.go -destination=../mock/user_mock.go -package=mock
type UserRepo interface {
    AddUser(ctx context.Context, user *entity.User) (err error)
    DelUser(ctx context.Context, userID int) (err error)
    GetUser(ctx context.Context, userID int) (user *entity.User, exist bool, err error)
}

之后，只需在项目根目录运行以下命令，即可一次性生成所有带有该注释文件的 Mock 代码：

go generate ./...

进阶技巧与总结

在实际测试中，除了 gomock.Any()，还可以使用 gomock.Eq() 严格匹配参数，或使用 gomock.Not() 排除特定值，以满足复杂的场景需求。更多关于参数匹配器和高级用法的细节，可参考官方文档：https://pkg.go.dev/github.com/golang/mock/gomock#pkg-index。

排错与注意事项

如果逻辑层测试未通过，常见原因包括：
1. Mock 的预期调用次数与实际不符（默认预期一次，多次调用需使用 Times(n)）。
2. 传入 Mock 的参数类型与预期设定不一致。
3. 忘记调用 ctl.Finish() 导致测试挂起或未检查到未调用的预期方法。

总结来说，虽然逻辑层测试看似简单，但为了覆盖边界条件和异常分支，应当构建多组 Mock 数据来进行全面验证。以上就是 Golang 使用 gomock 实现单元测试逻辑层的详细内容，更多关于 Golang 软件测试的资料请关注本站其它相关文章！