避免在结构初始化中遗漏字段

有志者，事竟成！如果你在学习Golang，那么本文《避免在结构初始化中遗漏字段》，就很适合你！文章讲解的知识点主要包括，若是你对本文感兴趣，或者是想搞懂其中某个知识点，就请你继续往下看吧~

考虑这个例子。假设我有一个在我的代码库中无处不在的对象：

type person struct {
    name string
    age  int
    [some other fields]
}

在代码库深处的某个地方，我还有一些创建新 person 结构的代码。也许它类似于以下实用函数（请注意，这只是创建 person 的某些函数的示例 - 我的问题的重点不是专门询问复制函数）：

func copyPerson(origPerson Person) *Person {
    copy := Person{
        Name: origPerson.Name,
        Age:  origPerson.Age,
        [some other fields]
    }
    return &copy
}

另一位开发人员出现并向 person 结构添加了一个新字段 gender。但是，由于 copyperson 函数位于较远的代码段中，因此他们忘记更新 copyperson。由于如果您在创建结构时省略参数，golang 不会抛出任何警告或错误，因此代码将编译并且看起来工作正常；唯一的区别是 copyperson 方法现在无法复制 gender 结构，并且 copyperson 的结果会将 gender 替换为 nil 值（例如空字符串）。

防止这种情况发生的最佳方法是什么？有没有办法要求 golang 在特定的结构初始化中强制不丢失参数？是否有一个 linter 可以检测这种类型的潜在错误？

解决方案

首先，您的 copyperson() 函数名不副实。它复制 person 的一些字段，但不是（不一定）全部。它应该被命名为 copysomefieldsofperson()。

要复制完整的结构值，只需分配该结构值即可。如果您有一个接收非指针 person 的函数，那么它已经是一个副本，因此只需返回其地址即可：

func copyperson(p person) *person {
    return &p
}

就这样，这将复制 person 的所有当前和未来字段。

现在可能存在字段是指针或类似标头的值（如切片）的情况，它们应该与原始字段“分离”（更准确地说是与指向的对象），在这种情况下，您确实需要手动调整，例如

type person struct {
    name string
    age  int
    data []byte
}

func copyperson(p person) *person {
    p2 := p
    p2.data = append(p2.data, p.data...)
    return &p2
}

或者另一种解决方案，它不会制作 p 的另一个副本，但仍会分离 person.data：

func copyperson(p person) *person {
    var data []byte
    p.data = append(data, p.data...)
    return &p
}

当然，如果有人添加了一个也需要手动处理的字段，这对你没有帮助。

您还可以使用未加密的文字，如下所示：

func copyperson(p person) *person {
    return &person{
        p.name,
        p.age,
    }
}

如果有人向 person 添加新字段，这将导致编译时错误，因为无键复合结构文字必须列出所有字段。同样，如果有人更改了可将新字段分配给旧字段的字段（例如，有人交换了彼此相邻的两个具有相同类型的字段），这不会对您有帮助，也不鼓励使用未键入的文字。

最好是包所有者在 person 类型定义旁边提供一个复制构造函数。因此，如果有人更改了 person，他/她应该负责保持 copyperson() 仍可运行。正如其他人提到的，您应该已经有了单元测试，如果 copyperson() 不符合其名称，单元测试应该会失败。

最好的可行选择？

如果您无法将 copyperson() 放在 person 类型旁边并让其作者维护它，请继续进行结构值复制以及手动处理指针和类似标头的字段。

您可以创建一个 person2 类型，它是 person 类型的“快照”。如果原始 person 类型发生更改，请使用空白全局变量来接收编译时警报，在这种情况下，copyperson() 包含的源文件将拒绝编译，因此您会知道它需要调整。

这是可以做到的：

type person2 struct {
    name string
    age  int
}

var _ = person(person2{})

如果 person 和 person2 的字段不匹配，空白变量声明将不会编译。

上述编译时检查的一种变体可以是使用 typed-nil 指针：

var _ = (*person)((*person2)(nil))

我解决这个问题的方法是只使用 newperson(params) 而不是导出该人。这使得获取 person 实例的唯一方法是通过您的 new 方法。

package person

// Struct is not exported
type person struct {
    Name string
    Age  int
    Gender bool
}

// We are forced to call the constructor to get an instance of person
func New(name string, age int, gender bool) person {
    return person{name, age, gender}
}

这迫使每个人都从同一个地方获取一个实例。添加字段时，您可以将其添加到函数定义中，然后在构造新实例的任何地方都会出现编译时错误，因此您可以轻松找到它们并修复它们。

本篇关于《避免在结构初始化中遗漏字段》的介绍就到此结束啦，但是学无止境，想要了解学习更多关于Golang的相关知识，请关注golang学习网公众号！