Golang怎么实现json.Marshaler_Golang如何自定义类型的JSON序列化行为【进阶】

Golang怎么实现json.Marshaler_Golang如何自定义类型的JSON序列化行为【进阶】

在Go语言里，想让json.Marshal乖乖输出你想要的JSON格式，其实有一条黄金法则：唯一可靠的方式是实现json.Marshaler接口。别指望光靠结构体标签就能搞定一切，也别迷信反射库的魔法。老老实实写一个MarshalJSON()方法，才是解决问题的根本。

为什么 struct 字段加 json:"xxx" 不够用

结构体标签确实方便，能改字段名、控制忽略或省略空值。但它的能力边界也很明显，有几个常见场景它就束手无策了：

• 你想把某个方法调用的结果（比如d.Value()）塞进JSON里。
• 需要把一个error字段序列化成结构化的错误信息，比如{"message": "...", "code": 500}。
• 希望把整个结构体输出成JSON数组（例如["id", "name", 123]），而不是默认的对象形式。
• 对time.Time这类标准库类型，想自定义输出格式，比如只要秒级精度、去掉时区信息。

在这些情况下，json.Marshal看到的只是字段的原始值或类型本身的限制，它可不会“猜”你的心思。

实现 MarshalJSON() 必须绕开递归陷阱

这里有个新手常踩的坑：在MarshalJSON()方法内部，如果直接调用json.Marshal(s)（其中s就是当前类型实例），会触发无限递归，最终导致栈溢出和panic。

正确的做法，是利用类型别名来巧妙地切断方法调用链：

func (d Deck) MarshalJSON() ([]byte, error) {
    type Alias Deck // ← 关键一步：创建新类型，它没有 MarshalJSON 方法
    return json.Marshal(struct {
        Cards []int `json:"cards"`
        Value int   `json:"value"`
    }{
        Cards: d.Cards,
        Value: d.Value(), // ✅ 现在可以安全地调用方法了
    })
}
有几点需要注意：

类型别名最好定义在函数内部，避免在包级别引起命名冲突。
这种方式只跳过了当前类型的MarshalJSON方法。如果原结构体里嵌套了其他也实现了该接口的字段，它们的行为不受影响。
如果确实需要保留嵌套字段的自定义序列化逻辑，可以在使用别名后，手动将这些字段展开再重新组合。


error 字段怎么不出 null 而是真实内容
Go语言内置的error接口并没有实现json.Marshaler。所以，json.Marshal默认会把它当作nil接口值处理，输出一个孤零零的null。
有两种比较实用的解决方案：

最直接的办法，是在结构体里不用err error，改用err string。在赋值前，手动调用err.Error()。这么做简单，但会丢失错误堆栈和链式原因（cause）信息。
更通用的做法，是为整个结构体实现MarshalJSON()，结合别名和匿名结构体来“注入”处理后的错误字段：

func (r Result) MarshalJSON() ([]byte, error) {
    type Alias Result
    aux := struct {
        Err string `json:"err,omitempty"`
        Alias
    }{
        Alias: (Alias)(r),
    }
    if r.Err != nil {
        aux.Err = r.Err.Error() // 或者用 fmt.Sprintf("%+v", r.Err) 来保留堆栈信息
    }
    return json.Marshal(&aux)
}
⚠️ 这里有个关键细节：千万别漏掉r.Err != nil这个判空操作，否则遇到nil错误时会直接引发空指针panic。

容易被忽略的细节：nil 指针字段与性能代价
一旦你为类型实现了MarshalJSON()，每次调用json.Marshal都会执行你的自定义逻辑。这意味着：

所有在方法内部创建的中间结构（比如匿名struct、type Alias）都会产生内存分配，带来GC压力。对于高频调用的API，务必进行压力测试。
如果结构体里包含*T这样的指针字段，并且它可能为nil，一定要在MarshalJSON()里做好判空处理。否则，json.Marshal(nil)虽然会返回null，但你的业务逻辑可能会因此panic。
对于像time.Time这样需要定制格式的类型，建议将其封装为一个新的自定义类型，并单独实现MarshalJSON()。这比在每个用到它的结构体里重复写序列化逻辑要优雅得多。

还有一个非常隐蔽的坑：假设你的结构体里某个嵌套字段自己也实现了MarshalJSON，而它的实现内部panic了。这时错误堆栈看起来像是在你的方法里出的错，但实际上问题根源在那个嵌套字段类型的实现里，排查时需要多留个心眼。