go - Stringer 方法需要值

Question

The Go FAQ answers a question关于方法中按值与按指针接收器定义的选择。该答案中的陈述之一是:

If some of the methods of the type must have pointer receivers, the rest should too, so the method set is consistent regardless of how the type is used.

这意味着，如果我对一种数据类型有一些改变数据的方法，因此需要按指针接收器，我应该对为该数据类型定义的所有方法使用按指针接收器。

另一方面，“fmt” 包调用 String() 方法，如 Stringer 接口(interface)中定义的那样 值(value)。如果使用接收器指针定义 String() 方法，则当相关数据类型作为参数提供给 fmt.Println(或其他fmt 格式化方法)。这让我们别无选择，只能通过值接收者实现 String() 方法。

在满足 Stringer 接口(interface)的 fmt 要求的同时，如何才能像 FAQ 所建议的那样与按值还是按指针的选择保持一致？

编辑:

为了强调我提到的问题的本质，考虑这样一种情况，其中一个数据类型具有一组用按值接收者定义的方法(包括 String())。然后有人希望添加一个附加方法来改变该数据类型 - 所以他用接收器指针定义它，并且(为了保持一致，每个常见问题解答)他还更新了该数据类型的所有其他方法以使用-指针接收器。此更改对使用此数据类型的方法的任何代码的影响为零 - 但调用 fmt 格式化函数(现在需要传递指向变量的指针而不是其值，就像更改之前一样).因此，一致性要求仅在 fmt 的上下文中存在问题。需要根据接收者类型调整向 fmt.Println(或类似函数)提供变量的方式，这打破了轻松重构包的能力。

Answer 1

如果您使用指针接收器定义您的方法，那么您应该使用和传递指针值，而不是非指针值。这样做传递的值确实实现了 Stringer，fmt 包将没有问题“检测”并调用您的 String() 方法。

例子:

type Person struct {
    Name string
}

func (p *Person) String() string {
    return fmt.Sprintf("Person[%s]", p.Name)
}

func main() {
    p := &Person{Name: "Bob"}
    fmt.Println(p)
}

输出(在 Go Playground 上尝试):

Person[Bob]

如果您将 Person 类型的值传递给 fmt.Println() 而不是 *Person 类型的指针，是的，实际上 Person.String() 不会被调用。但是如果 Person 的所有方法都有指针接收者，那是一个强烈的指示你应该使用类型和它的值作为指针(除非你不打算将它的方法使用)。

是的，您必须知道您是否必须使用Person 或*Person。处理它。如果你想编写正确高效的程序，你必须知道的不仅仅是使用指针值还是非指针值，我不知道为什么这对你来说很重要。如果您不知道，请查找它，如果您很懒惰，请使用指针作为指针值(的类型)的方法集，其中包含具有指针和非指针接收器的方法。

此外，Person 的作者可能会为您提供一个 NewPerson() 工厂函数，您可以依靠它返回正确类型的值(例如 Person 如果方法有值接收者，*Person 如果方法有指针接收者)，所以你不必知道要使用哪个。

稍后将带有指针接收器的方法添加到以前只有带有值接收器的方法的类型的答案:

是的，正如您在问题中所述，这可能不会破坏现有代码，但继续使用非指针值可能不会从后来添加的带有指针接收器的方法中获益。

我们可能会问:这是一个问题吗？使用该类型时，您刚刚添加的新方法不存在。所以原始代码没有假设它的存在。所以这应该不是问题。

第二个考虑因素:该类型只有具有值接收者的方法，因此可以很容易地假设通过使用它们，值是不可变的，因为具有值接收者的方法不能改变值。使用该类型的代码可能以此为基础，假设它没有被其方法更改，因此从多个 goroutines 中使用它可能会正确地省略某些同步。

所以我确实认为，将带有指针接收器的新方法添加到以前只有带有值接收器的方法的类型不应该是“不透明的”，添加此新方法的人有责任修改此类型的使用“切换”到指针并确保代码保持安全和正确，或者处理非指针值将没有这种新方法的事实。

提示:

如果将来某个类型有可能具有增变器方法，您应该开始使用带有指针接收器的方法来创建它。这样做可以避免以后必须经历上述过程。

另一个技巧可能是完全隐藏类型，只发布接口(interface)。这样做，这种类型的用户不必知道接口(interface)是否包装了指针，这无关紧要。他们接收一个接口(interface)值，然后调用接口(interface)的方法。包作者有责任处理适当的方法接收器，并返回实现接口(interface)的适当类型。客户看不到这一点，他们不依赖于此。他们所看到和使用的只是界面。