Go 结构体 Setter 方法使用技巧

本文旨在解释 Go 语言中结构体方法（特别是 setter 方法）中使用值接收者和指针接收者的区别。通过示例代码和地址分析，帮助开发者理解为什么值接收者无法修改原始结构体，而指针接收者可以。掌握这一关键概念，可以避免在编写 Go 代码时遇到意外的修改问题。

在 Go 语言中，方法可以与类型关联。当方法与结构体类型关联时，我们可以将其用作结构体的 "setter" 来修改结构体的字段。然而，在实现 setter 方法时，选择使用值接收者还是指针接收者至关重要，因为它直接影响到方法是否能够修改原始结构体。

值接收者 vs. 指针接收者

Go 语言中，方法可以定义为值接收者或指针接收者。这两者的区别在于：

• 值接收者： 方法接收的是结构体的值的副本。这意味着在方法内部对结构体字段的任何修改都不会影响原始结构体。
• 指针接收者： 方法接收的是结构体的指针。这意味着方法可以直接访问和修改原始结构体的字段。

示例代码

下面的代码演示了值接收者和指针接收者在 setter 方法中的不同行为：

package main

import "fmt"

type T struct {
    Val string
}

// 值接收者：无法修改原始结构体
func (t T) SetVal(s string) {
    t.Val = s
}

// 指针接收者：可以修改原始结构体
func (t *T) SetVal2(s string) {
    t.Val = s
}

func main() {
    v := T{"abc"}
    fmt.Println(v) // 输出：{abc}

    v.SetVal("pdq")
    fmt.Println(v) // 输出：{abc}，期望的是 {pdq}，但原始结构体未被修改

    v.SetVal2("xyz")
    fmt.Println(v) // 输出：{xyz}，原始结构体被成功修改
}

原因分析

SetVal 方法使用值接收者 (t T)。当调用 v.SetVal("pdq") 时，Go 会创建 v 的一个副本，并将该副本传递给 SetVal 方法。在 SetVal 方法内部，t.Val = s 修改的是副本的 Val 字段，而不是原始结构体 v 的 Val 字段。因此，调用 SetVal 后，v 的值保持不变。

SetVal2 方法使用指针接收者 (t *T)。当调用 v.SetVal2("xyz") 时，Go 会将 v 的指针传递给 SetVal2 方法。在 SetVal2 方法内部，t.Val = s 通过指针直接修改原始结构体 v 的 Val 字段。因此，调用 SetVal2 后，v 的值被更新为 {xyz}。

验证地址

为了更清楚地理解值接收者和指针接收者的区别，我们可以打印出结构体的地址：

package main

import "fmt"

type T struct {
    Val string
}

func (t T) SetVal(s string) {
    fmt.Printf("SetVal: Address of copy is %p\n", &t)
}

func (t *T) SetVal2(s string) {
    fmt.Printf("SetVal2: Pointer argument is %p\n", t)
}

func main() {
    v := T{"abc"}
    fmt.Printf("Main: Address of v is %p\n", &v)
    v.SetVal("pdq")
    v.SetVal2("xyz")
}

输出结果（地址可能因运行环境而异）：

Main: Address of v is 0x地址1
SetVal: Address of copy is 0x地址2
SetVal2: Pointer argument is 0x地址1

可以看到，SetVal 方法中的结构体地址与 main 函数中的结构体地址不同，说明 SetVal 操作的是结构体的副本。而 SetVal2 方法中的结构体地址与 main 函数中的结构体地址相同，说明 SetVal2 操作的是原始结构体。

总结与建议

• 如果需要在方法内部修改结构体的字段，则必须使用指针接收者。
• 如果方法只需要读取结构体的字段，而不需要修改，则可以使用值接收者。使用值接收者可以避免不必要的内存分配和拷贝，提高性能。
• 在不确定使用哪种接收者时，建议优先使用指针接收者，因为它更通用，可以避免潜在的修改问题。
• 理解值接收者和指针接收者的区别是编写正确且高效的 Go 代码的关键。

注意事项

• 即使结构体本身包含指针类型的字段，值接收者仍然无法修改这些指针指向的数据。要修改指针指向的数据，仍然需要使用指针接收者。
• 如果结构体很大，使用值接收者可能会导致性能问题，因为每次调用方法都会创建一个新的结构体副本。在这种情况下，建议使用指针接收者。