Golang返回指向接口的指针抛出错误

Question

我在 Go 中有一个基本函数，它打开一个文件并尝试解码其 JSON 内容。

我正在尝试提取默认的 json.NewDecoder() 函数，以便在我的测试中轻松地模拟它。

但是，我的实现似乎返回了一个错误：

不能在 NewConfig 的参数中使用 json.NewDecoder (type func(io.Reader) *json.Decoder) 作为类型 decoderFactory

代码：

package main

import (
    "encoding/json"
    "fmt"
    "io"
    "os"
)

type openFile func(name string) (*os.File, error)

type decoderFactory func(r io.Reader) decoder

type decoder interface {
    Decode(v interface{}) error
}

type Config struct {
    ConsumerKey,
    ConsumerSecret,
    AccessToken,
    AccessTokenSecret string
}

func NewConfig(open openFile, d decoderFactory) (*Config, error) {
    c := new(Config)
    file, err := open("some.file")
    if err != nil {
        return nil, fmt.Errorf("error opening config file")
    }
    defer file.Close()

    decoder := d(file)
    if err := decoder.Decode(&c); err != nil {
        return nil, fmt.Errorf("error decoding config JSON")
    }

    return c, nil
}

func main() {
    _, err := NewConfig(os.Open, json.NewDecoder)
    if err != nil {
        fmt.Fprintf(os.Stderr, "something bad happened: %v\n", err)
    }
}

这是Go playground的链接

我哪里错了？

Answer 1

json.NewDecoder() 是一个具有以下声明的函数：

func NewDecoder(r io.Reader) *Decoder

它的返回类型是*json.Decoder。 json.Decoder 不是一个接口，它是一个具体的类型。如果返回类型不同，则两种函数类型不同：Spec: Function types:

函数类型表示具有相同参数和结果类型的所有函数的集合。

因此，您不能构造返回接口的新类型，并期望与json.NewDecoder 相同，或者它将接受值json.NewDecoder。

但“看似” 的简单解决方法是：将您的 decoderFactory 定义为函数类型，与 json.NewDecoder 完全相同：

type decoderFactory func(r io.Reader) *json.Decoder

这可以编译，好的...但是现在如何模拟？

现在如何模拟？

当然，在这种形式下，您将失去模拟 json.NewDecoder() 的可能性（因为“模拟器”必须返回 *json.Decoder 类型的值，并且不会接受任何其他值）。那该怎么办呢？

您必须使用不同的工厂类型。工厂类型应该是一个返回接口的函数（你可以提供不同的实现），你在正确的轨道上：

type MyDecoder interface {
    Decode(v interface{}) error
    // List other methods that you need from json.Decoder
}

type decoderFactory func(r io.Reader) MyDecoder

但您不能使用json.NewEncoder 按原样 作为decoderFactory 的值传递。但不要害怕，创建 decoderFactory 类型的函数非常容易，它会在后台调用 json.NewEncoder()：

func jsonDecoderFact(r io.Reader) MyDecoder {
    return json.NewDecoder(r)
}

我们在模拟 json.Decoder 的行为，而不是 json.NewDecoder() 工厂函数。

使用这个jsonDecoderFact()：

_, err := NewConfig(os.Open, jsonDecoderFact)
if err != nil {
    fmt.Fprintf(os.Stderr, "something bad happened: %v\n", err)
}

这是有效的并且可以编译，因为jsonDecoderFact 与decoderFactory 具有完全相同的类型。

如果你想用不同的实现来测试/模拟：

type TestDecoder struct {
    r io.Reader
}

func (t TestDecoder) Decode(v interface{}) error {
    // Test / mocking logic here
    return nil
}

func testDecoderFact(r io.Reader) MyDecoder {
    return TestDecoder{r}
}

使用它：

_, err2 := NewConfig(os.Open, testDecoderFact)
if err2 != nil {
    fmt.Fprintf(os.Stderr, "something bad happened: %v\n", err2)
}

试试Go Playground上的例子。