如何通过结构体方法清除Go结构体指定字段外的所有值

问题 #

定义了如下Go结构体：

type Agent struct {
    Name    string
    Gender  string
    Secret1 string
    Secret2 string
}

需要保留Name、Gender等公开字段，清除其余敏感字段的值，且通过结构体方法实现。由于实际结构体字段数量较多，手动逐个重置敏感字段不可行。尝试编写的HideSecret方法未达到预期效果：

func (a *Agent) HideSecret() {
    fmt.Println("Hiding secret...")
    new := &Agent{
        Name:   a.Name,
        Gender: a.Gender,
    }
    a = new
}

测试代码：

func main() {
    James := Agent{
        Name:    "James Bond",
        Gender:  "M",
        Secret1: "1234",
        Secret2: "abcd",
    }

    fmt.Printf("[Before] Secret: %s, %s\n", James.Secret1, James.Secret2)
    James.HideSecret()
    fmt.Printf("[After]  Secret: %s, %s\n", James.Secret1, James.Secret2) // 未生效
}

解决方案 #

问题根源 #

Go中方法的指针接收者是值传递，方法里修改的是接收者变量a的副本，并没有改变原结构体实例的内存地址。a = new只是替换了方法内部的指针副本，对外部的James实例没有任何影响。

正确实现方式 #

方式1：直接重置敏感字段（适合字段少的场景）

如果敏感字段数量不多，可以直接逐个重置为对应类型的零值：

func (a *Agent) HideSecret() {
    fmt.Println("Hiding secret...")
    a.Secret1 = ""
    a.Secret2 = ""
}

方式2：使用反射（适合字段多的场景）

如果结构体字段数量庞大，手动重置效率极低，可以利用Go的reflect包遍历字段，仅保留指定的公开字段，其余字段设为零值：

import "reflect"

func (a *Agent) HideSecret() {
    fmt.Println("Hiding secret...")
    // 定义需要保留的字段名集合
    keepFields := map[string]bool{
        "Name":   true,
        "Gender": true,
    }

    val := reflect.ValueOf(a).Elem()
    for i := 0; i < val.NumField(); i++ {
        fieldType := val.Type().Field(i)
        // 仅处理公开字段（首字母大写，PkgPath为空），且不在保留列表中的字段
        if fieldType.PkgPath == "" && !keepFields[fieldType.Name] {
            val.Field(i).Set(reflect.Zero(fieldType.Type))
        }
    }
}

效果验证 #

修改后运行测试代码，输出结果如下，敏感字段已被成功清除：

[Before] Secret: 1234, abcd
Hiding secret...
[After]  Secret: , 

内容的提问来源于stack exchange，提问作者Boo Yan Jiong