使用mgo操作MongoDB时，如何将枚举类型别名通过BSON编解码转存为字符串

嗨，我来帮你搞定这个问题！在mgo里自定义BSON序列化规则，和JSON的MarshalJSON/UnmarshalJSON思路类似，但要实现mgo专属的接口——bson.Getter和bson.Setter，或者直接实现MarshalBSON/UnmarshalBSON方法。下面是完整的实现方案：

第一步：补全枚举定义与映射关系 #

首先我们需要把枚举的数字值和对应的字符串做双向映射，这样才能在序列化和反序列化时互相转换：

package main

import (
    "fmt"
    mgo "gopkg.in/mgo.v2"
    "gopkg.in/mgo.v2/bson"
)

type trxStatus int

// 定义枚举值
const (
    TrxStatusBuySubmitted trxStatus = iota // 对应字符串"buy_submitted"
    TrxStatusPaid                          // 对应字符串"paid"
    TrxStatusCompleted                     // 对应字符串"completed"
)

// 正向映射：状态值 → 字符串
var trxStatusToString = map[trxStatus]string{
    TrxStatusBuySubmitted: "buy_submitted",
    TrxStatusPaid:         "paid",
    TrxStatusCompleted:    "completed",
}

// 反向映射：字符串 → 状态值
var stringToTrxStatus = map[string]trxStatus{
    "buy_submitted": TrxStatusBuySubmitted,
    "paid":          TrxStatusPaid,
    "completed":     TrxStatusCompleted,
}

第二步：实现mgo的序列化/反序列化接口 #

这里有两种常用方式，选一种就行：

方式一：使用bson.Getter和bson.Setter接口（推荐，更简洁）

这两个接口是mgo提供的简化版自定义序列化接口，不需要自己处理BSON的字节编解码：

// GetBSON 实现bson.Getter接口，将trxStatus转成字符串存入MongoDB
func (s trxStatus) GetBSON() (interface{}, error) {
    str, exists := trxStatusToString[s]
    if !exists {
        return nil, fmt.Errorf("invalid trxStatus value: %d", s)
    }
    return str, nil
}

// SetBSON 实现bson.Setter接口，将MongoDB中的字符串转成trxStatus
func (s *trxStatus) SetBSON(raw bson.Raw) error {
    var statusStr string
    // 先把原始BSON数据解析成字符串
    if err := raw.Unmarshal(&statusStr); err != nil {
        return err
    }
    // 通过反向映射找到对应的枚举值
    status, exists := stringToTrxStatus[statusStr]
    if !exists {
        return fmt.Errorf("unknown trxStatus string: %s", statusStr)
    }
    *s = status
    return nil
}

方式二：直接实现MarshalBSON和UnmarshalBSON方法（更灵活）

如果需要更精细地控制BSON的编解码过程，可以直接实现这两个方法：

// MarshalBSON 自定义BSON序列化逻辑
func (s trxStatus) MarshalBSON() ([]byte, error) {
    str, exists := trxStatusToString[s]
    if !exists {
        return nil, fmt.Errorf("invalid trxStatus: %d", s)
    }
    // 让mgo帮我们把字符串转成BSON字节
    return bson.Marshal(str)
}

// UnmarshalBSON 自定义BSON反序列化逻辑
func (s *trxStatus) UnmarshalBSON(data []byte) error {
    var statusStr string
    if err := bson.Unmarshal(data, &statusStr); err != nil {
        return err
    }
    status, exists := stringToTrxStatus[statusStr]
    if !exists {
        return fmt.Errorf("unknown trxStatus string: %s", statusStr)
    }
    *s = status
    return nil
}

第三步：测试使用 #

现在你的test结构体就能正常把S字段存成字符串了，测试代码示例：

type test struct {
    S trxStatus
    A string
}

func main() {
    // 连接MongoDB（这里假设本地有MongoDB服务）
    session, err := mgo.Dial("mongodb://localhost:27017")
    if err != nil {
        panic(err)
    }
    defer session.Close()

    coll := session.DB("test_db").C("test_coll")

    // 插入测试数据
    testData := test{
        S: TrxStatusBuySubmitted,
        A: "test_order_001",
    }
    if err := coll.Insert(&testData); err != nil {
        panic(err)
    }

    // 查询验证
    var result test
    if err := coll.Find(bson.M{"a": "test_order_001"}).One(&result); err != nil {
        panic(err)
    }
    fmt.Printf("查询到的状态：数字值=%d，字符串=%s\n", result.S, trxStatusToString[result.S])
}

注意事项 #

• 一定要保证所有枚举值都在双向映射表里，否则序列化/反序列化会抛出错误，避免脏数据存入数据库。
• 如果后续新增枚举值，记得同步更新两个映射表。
• 错误处理可以根据你的业务需求调整，比如返回自定义错误类型，或者默认值（但不推荐，会隐藏数据问题）。

内容的提问来源于stack exchange，提问作者jfly