Go语言处理JSON中的枚举类型（自定义序列化与反序列化实战教程）

为什么默认序列化不适合枚举？

假设我们有一个表示用户状态的枚举：

type UserStatus intconst (    StatusActive UserStatus = iota // 0    StatusInactive                 // 1    StatusSuspended                // 2)

如果我们直接对包含该字段的结构体进行JSON编码：

type User struct {    Name   string     `json:"name"`    Status UserStatus `json:"status"`}user := User{Name: "Alice", Status: StatusActive}data, _ := json.Marshal(user)fmt.Println(string(data))// 输出：{"name":"Alice","status":0}

虽然技术上正确，但客户端看到 "status":0 并不清楚其含义。理想情况应输出 "status":"active" 这样的字符串。

解决方案：实现 MarshalJSON 方法

为了让 Go语言 在序列化时输出字符串，我们需要为 UserStatus 类型实现 MarshalJSON 方法：

func (s UserStatus) MarshalJSON() ([]byte, error) {    var statusStr string    switch s {    case StatusActive:        statusStr = "active"    case StatusInactive:        statusStr = "inactive"    case StatusSuspended:        statusStr = "suspended"    default:        return nil, fmt.Errorf("invalid user status: %d", s)    }    return json.Marshal(statusStr)}

现在再次调用 json.Marshal，输出将是：

// 输出：{"name":"Alice","status":"active"}

反序列化：实现 UnmarshalJSON 方法

为了支持从JSON字符串反向解析回枚举值，我们还需要实现 UnmarshalJSON 方法：

func (s *UserStatus) UnmarshalJSON(data []byte) error {    var statusStr string    if err := json.Unmarshal(data, &statusStr); err != nil {        return err    }    switch statusStr {    case "active":        *s = StatusActive    case "inactive":        *s = StatusInactive    case "suspended":        *s = StatusSuspended    default:        return fmt.Errorf("invalid status string: %s", statusStr)    }    return nil}

这样，当我们接收如下JSON时：

{"name":"Bob", "status":"suspended"}

可以正确解析为 User{Status: StatusSuspended}。

完整示例代码

package mainimport (    "encoding/json"    "fmt")type UserStatus intconst (    StatusActive UserStatus = iota    StatusInactive    StatusSuspended)func (s UserStatus) MarshalJSON() ([]byte, error) {    var statusStr string    switch s {    case StatusActive:        statusStr = "active"    case StatusInactive:        statusStr = "inactive"    case StatusSuspended:        statusStr = "suspended"    default:        return nil, fmt.Errorf("invalid user status: %d", s)    }    return json.Marshal(statusStr)}func (s *UserStatus) UnmarshalJSON(data []byte) error {    var statusStr string    if err := json.Unmarshal(data, &statusStr); err != nil {        return err    }    switch statusStr {    case "active":        *s = StatusActive    case "inactive":        *s = StatusInactive    case "suspended":        *s = StatusSuspended    default:        return fmt.Errorf("invalid status string: %s", statusStr)    }    return nil}type User struct {    Name   string     `json:"name"`    Status UserStatus `json:"status"`}func main() {    // 序列化    user := User{Name: "Alice", Status: StatusActive}    data, _ := json.Marshal(user)    fmt.Println(string(data)) // {"name":"Alice","status":"active"}    // 反序列化    var newUser User    json.Unmarshal([]byte(`{"name":"Bob", "status":"suspended"}`), &newUser)    fmt.Printf("Parsed user: %+v\n", newUser) // Parsed user: {Name:Bob Status:2}}

总结

通过为枚举类型实现 MarshalJSON 和 UnmarshalJSON 方法，我们可以完全控制其在 JSON序列化 过程中的表现形式。这不仅提升了API的可读性，也增强了前后端协作的效率。

记住，自定义MarshalJSON 是处理这类问题的标准做法，也是Go语言灵活性的体现。无论你是初学者还是有经验的开发者，掌握这一技巧都将让你的代码更加专业和健壮。

希望这篇关于 Go语言 JSON序列化 枚举类型 的教程对你有所帮助！