当前位置：首页 > 文章列表 > Golang > Go教程 > golang框架的可测试代码依赖管理技巧

golang框架的可测试代码依赖管理技巧

2024-07-31 21:12:42 0浏览收藏

“纵有疾风来，人生不言弃”，这句话送给正在学习Golang的朋友们，也希望在阅读本文《golang框架的可测试代码依赖管理技巧》后，能够真的帮助到大家。我也会在后续的文章中，陆续更新Golang相关的技术文章，有好的建议欢迎大家在评论留言，非常感谢！

在 Go 框架中管理可测试代码依赖项的方法包括：使用 Mocking 包模拟真实依赖项，检查模拟对象是否按预期调用；使用 Stubbing 在真实依赖项的函数上创建桩函数，模拟简单操作；使用依赖注入允许在运行时动态注入依赖项，简化测试。

Go 框架可测试代码依赖管理的技巧

在 Go 框架中编写可测试代码至关重要，因为它使我们能够轻松地隔离和测试我们代码的不同部分。然而，管理测试代码的依赖项可能是一项挑战，尤其是在使用较大的框架和第三方库时。

使用 Mocking 包

使用 Mocking 包（例如 github.com/stretchr/testify/mock）可以模拟测试代码中真实的依赖项。这允许我们根据提供的输入检查模拟对象是否被正确调用，从而隔离特定区域进行测试。

import (
    "testing"

    "github.com/stretchr/testify/mock"

    "my/package"
)

type MyInterface mock.Mock

func (m *MyInterface) MyMethod(input string) string

func TestMyFunction(t *testing.T) {
    mockedInterface := new(MyInterface)
    mockedInterface.On("MyMethod", "foo").Return("bar")

    actual := package.MyFunction(mockedInterface, "foo")
    expected := "bar"

    if actual != expected {
        t.Errorf("Expected %s, got %s", expected, actual)
    }
}

使用 Stubbing

Stubbing 类似于 Mocking，但它直接在真实依赖项的函数上创建桩函数。这用于模拟简单的操作，例如数据库查询或 HTTP 调用。

import (
    "testing"

    "my/package"
)

func TestMyFunction(t *testing.T) {
    package.StubMyMethod = func(input string) string {
        return "stubbed output"
    }

    actual := package.MyFunction("foo")
    expected := "stubbed output"

    if actual != expected {
        t.Errorf("Expected %s, got %s", expected, actual)
    }
}

依赖注入

依赖注入是一种设计模式，允许我们在运行时动态注入依赖项。这允许我们在测试期间轻松地替换真实依赖项的 Mock 或 Stub，从而简化测试过程。

import (
    "testing"

    "my/package"
)

func TestMyFunction(t *testing.T) {
    type MyInterface interface {
        MyMethod(input string) string
    }

    f := func(i MyInterface) string {
        return i.MyMethod("foo")
    }

    mockedInterface := new(MyInterface)
    mockedInterface.On("MyMethod", "foo").Return("bar")

    actual := f(mockedInterface)
    expected := "bar"

    if actual != expected {
        t.Errorf("Expected %s, got %s", expected, actual)
    }
}

实战案例

以一个文件上传服务为例。该服务使用第三方库来处理文件上传。我们可以使用 Mocking 来测试该服务的上传功能，而不依赖于实际的文件上传。

import (
    "context"
    "io"
    "testing"

    "github.com/stretchr/testify/mock"

    "my/package"
)

type FileUploader mock.Mock

func (m *FileUploader) Upload(ctx context.Context, r io.Reader, fileName string) (string, error)

func TestUploadFile(t *testing.T) {
    mockedUploader := new(FileUploader)
    mockedUploader.On("Upload", mock.Anything, mock.Anything, mock.Anything).Return("stubbed-file-id", nil)

    service := mypackage.NewService(mockedUploader)

    id, err := service.UploadFile(context.Background(), nil, "file.txt")

    if err != nil {
        t.Errorf("Expected no error, got: %s", err)
    }

    if id != "stubbed-file-id" {
        t.Errorf("Expected stubbed file id, got: %s", id)
    }
}