“合并”字段是两个相同类型的结构

时间:2017-11-20 15:26:18

标签: go struct

查看此struct

type Config struct {
  path string
  id   string
  key  string
  addr string
  size uint64
}

现在我有一个DefaultConfig初始化了一些值,一个从文件加载,让我们说FileConfig。 我希望两个结构合并到一起,这样我得到一个Config两个结构的内容。 FileConfig应覆盖DefaultConfig中设置的任何内容,而FileConfig 可能未设置所有字段。 (为什么会这样?因为潜在用户可能不知道默认值,所以删除该条目相当于设置默认值 - 我认为)

我以为我需要反思这个:

 func merge(default *Config, file *Config) (*Config) {
  b := reflect.ValueOf(default).Elem()
  o := reflect.ValueOf(file).Elem()

  for i := 0; i < b.NumField(); i++ {
    defaultField := b.Field(i)
    fileField := o.Field(i)
    if defaultField.Interface() != reflect.Zero(fileField.Type()).Interface() {
     defaultField.Set(reflect.ValueOf(fileField.Interface()))
    }
  }

  return default
 }

我不确定:

  • 如果需要反思
  • 可能有更简单的方法来执行此操作

我在这里看到的另一个问题是检查零值可能很棘手:如果覆盖结构打算覆盖零值会怎么样?幸运的是,我不认为它适用于我的情况 - 但这成为一个功能,它可能会成为一个问题

4 个答案:

答案 0 :(得分:10)

前言encoding/json包使用反射(包reflect)来读取/写入值,包括结构。其他也使用反射的库(例如TOML和YAML的实现)可以以类似的方式(或甚至以相同的方式)操作,因此这里呈现的原理也可以应用于那些库。您需要使用您使用的库进行测试。

为简单起见,此处介绍的解决方案使用标准的lib encoding/json

优雅且“零努力”的解决方案是使用encoding/json包并将解组为“准备好的”默认配置的值。

这可以处理您需要的一切:

  • 配置文件中缺少值:默认适用
  • 文件中给出的值覆盖默认配置(无论是什么)
  • 显式覆盖文件中的零值优先(覆盖非零默认配置)

为了演示,我们将使用此配置结构:

type Config struct {
    S1 string
    S2 string
    S3 string
    S4 string
    S5 string
}

默认配置:

var defConfig = &Config{
    S1: "", // Zero value
    S2: "", // Zero value
    S3: "abc",
    S4: "def",
    S5: "ghi",
}

让我们说该文件包含以下配置:

const fileContent = `{"S2":"file-s2","S3":"","S5":"file-s5"}`

文件配置会覆盖S2S3S5字段。

加载配置的代码:

conf := new(Config) // New config
*conf = *defConfig  // Initialize with defaults

err := json.NewDecoder(strings.NewReader(fileContent)).Decode(&conf)
if err != nil {
    panic(err)
}

fmt.Printf("%+v", conf)

输出(在Go Playground上试试):

&{S1: S2:file-s2 S3: S4:def S5:file-s5}

分析结果:

  • S1默认为零,文件中缺少,结果为零
  • S2默认为零,在文件中给出,结果是文件值
  • S3在config中给出,被覆盖为文件中的零,结果为零
  • S4在config中给出,在文件中丢失,结果是默认值
  • S5在config中给出,在文件中给出,结果是文件值

答案 1 :(得分:4)

反思将使你的代码变慢。

对于这个结构,我将实现一个直接Merge()方法:

type Config struct {
  path string
  id   string
  key  string
  addr string
  size uint64
}

func (c *Config) Merge(c2 Config) {
  if c.path == "" {
    c.path = c2.path
  }
  if c.id == "" {
    c.id = c2.id
  }
  if c.path == "" {
    c.path = c2.path
  }
  if c.addr == "" {
    c.addr = c2.addr
  }
  if c.size == 0 {
    c.size = c2.size
  }
}

它的代码数量几乎相同,快速且易于理解。

您可以使用使用反射的uni测试来覆盖此方法,以确保不会遗留新字段。

这就是Go的观点 - 你写得更多,以获得快速和安全易于阅读的代码。

此外,您可能希望查看将从结构定义为您生成方法的go generate。也许在GitHub上已经实现并可以使用某些事件?以下是执行类似操作的代码示例:https://github.com/matryer/moq

GitHub上还有一些我认为在运行时正在做你想做的事情的软件包,例如:https://github.com/imdario/mergo

答案 2 :(得分:1)

  

我在这里看到的另一个问题是检查零值可能是   棘手:如果重写结构打算用零覆盖会怎样   值?

如果您无法使用icza指出的encoding/json或行为相似的其他格式编码器,则可以使用两种不同的类型。

type Config struct {
    Path string
    Id   string
    Key  string
    Addr string
    Size uint64
}

type ConfigParams struct {
    Path *string
    Id   *string
    Key  *string
    Addr *string
    Size *uint64
}

现在有了这样的功能:

func merge(conf *Config, params *ConfigParams)

您可以检查params中的非零字段,并取消引用指针以设置conf中相应字段中的值。这允许您使用conf中的非零零值字段取消设置params中的字段。

答案 3 :(得分:0)

此解决方案不适用于您的特定问题,但它可能会对遇到类似但不同问题的人有所帮助:

您可以拥有一个“默认”结构,并为它创建一个修饰符函数,而不是创建两个单独的结构来合并。所以在你的情况下:

type Config struct {
  path string
  id   string
  key  string
  addr string
  size uint64
}

var defcfg = Config {
  path: "/foo",
  id: "default",
  key: "key",
  addr: "1.2.3.4",
  size: 234,
}

还有你的修饰符函数:

func myCfg(c *Config) {
  c.key = "different key"
}

这适用于我想测试大部分未修改结构的许多小的不同变体的测试:

func TestSomething(t *testing.T) {
  modifiers := []func (*Config){
    .... // modifier functions here
  }
  for _, f := range modifiers {
    tc := defcfg // copy
    f(&tc)
    // now you can use tc.
  }
}

不过,当您将修改后的配置从文件读入结构体时没有用。从好的方面来说:这也适用于零值。