Go 1.19x：如何Mock statsd.Client测试emitGauge函数？

问题根源 #

你遇到的类型转换错误，是因为emitGauge函数直接依赖了具体的*statsd.Client类型，而自定义的StubStatsd和该类型属于完全不同的类型体系，Go作为强类型语言不允许这种隐式转换。正确的做法是通过接口解耦，让待测试函数依赖抽象接口而非具体实现。

步骤1：定义适配接口 #

首先定义一个包含Gauge方法的接口，因为*statsd.Client本身就实现了这个方法，所以真实的Statsd客户端可以无缝适配，同时Mock结构体也能实现该接口。

// 定义Statsd客户端的抽象接口，仅包含测试需要用到的方法
type StatsdClient interface {
    Gauge(name string, value float64, tags []string, rate float64) error
}

// 修改待测试函数，将参数改为接口类型
func emitGauge(s StatsdClient, i float64) {
    // 修正原代码中tags参数的错误：原代码传""应为空切片[]string{}
    s.Gauge("name", i, []string{}, 1)
}

步骤2：实现带参数记录的Mock结构体 #

创建Mock结构体，实现StatsdClient接口，同时记录每次Gauge调用的参数，方便后续验证：

// MockStatsd 用于测试的Mock结构体，记录Gauge方法的调用详情
type MockStatsd struct {
    GaugeCalls []struct {
        Name  string
        Value float64
        Tags  []string
        Rate  float64
    }
}

// 实现StatsdClient接口的Gauge方法，记录调用参数
func (m *MockStatsd) Gauge(name string, value float64, tags []string, rate float64) error {
    m.GaugeCalls = append(m.GaugeCalls, struct {
        Name  string
        Value float64
        Tags  []string
        Rate  float64
    }{name, value, tags, rate})
    return nil
}

步骤3：编写测试用例 #

在测试中使用MockStatsd，调用emitGauge后验证参数是否符合预期：

import "testing"

func TestEmitGauge(t *testing.T) {
    mock := &MockStatsd{}
    testValue := 123.45

    // 调用待测试函数
    emitGauge(mock, testValue)

    // 验证Gauge方法调用次数
    if len(mock.GaugeCalls) != 1 {
        t.Errorf("期望Gauge被调用1次，实际调用%d次", len(mock.GaugeCalls))
    }

    // 验证调用参数是否正确
    call := mock.GaugeCalls[0]
    if call.Name != "name" {
        t.Errorf("期望name参数为'name'，实际为'%s'", call.Name)
    }
    if call.Value != testValue {
        t.Errorf("期望value参数为%.2f，实际为%.2f", testValue, call.Value)
    }
    if len(call.Tags) != 0 {
        t.Errorf("期望tags参数为空切片，实际为%v", call.Tags)
    }
    if call.Rate != 1 {
        t.Errorf("期望rate参数为1，实际为%.2f", call.Rate)
    }
}

额外说明 #

如果不想修改原函数的参数类型（比如依赖关系复杂），也可以使用github.com/stretchr/testify/mock这类Mock库直接Mock*statsd.Client类型，但接口解耦的方式更符合Go的依赖倒置原则，代码扩展性更好。

内容的提问来源于stack exchange，提问作者kxasha