Go语言自定义时间戳实现方法

本文深入剖析了Go语言中自定义Timestamp类型的安全实现方案，直击JSON序列化与MongoDB BSON交互中的高频痛点——如方法接收者不匹配导致的“invalid indirect”编译错误、指针解引用panic、零值处理不当及初始化陷阱；通过提供经过生产验证的完整代码（兼容现代mongo-go-driver）、强调接收者一致性、nil安全防护和语义分离设计，帮助开发者一次性构建健壮、可复用的时间戳封装类型，让API时间格式统一、数据库存取可靠、调试日志清晰，真正摆脱“看似简单却处处踩坑”的时间处理困境。

本文详解如何在Go中安全实现支持JSON序列化和MongoDB BSON交互的自定义Timestamp类型，重点解决方法接收者不匹配、指针解引用错误及初始化陷阱等常见问题，并提供可直接复用的工程化代码方案。

在Go应用开发中，尤其是对接MongoDB（通过mgo或mongo-go-driver）和REST API时，常需对time.Time进行封装，以统一控制其JSON序列化格式（如仅输出Unix时间戳整数）、避免零值干扰、并适配数据库驱动的BSON编解码逻辑。但直接复制网络上的Timestamp实现极易因接收者类型不一致导致编译错误——正如问题中出现的：

invalid indirect of t (type Timestamp)

该错误根源在于：GetBSON() 和 SetBSON() 方法被声明为值接收者（func (t Timestamp) GetBSON()），但在方法体内却尝试对t执行解引用操作（如 time.Time(*t)），而值类型无法取地址；同时，UnmarshalJSON 中 *t = ... 也要求t必须是指针接收者。二者必须严格统一为指针接收者。

✅ 正确实现如下（已适配现代Go模块规范，弃用已归档的 labix.org/v2/mgo/bson，改用官方 go.mongodb.org/mongo-driver/bson 或兼容的 gopkg.in/mgo.v2）：

package timestamp

import (
    "encoding/json"
    "strconv"
    "time"

    "go.mongodb.org/mongo-driver/bson" // 或 "gopkg.in/mgo.v2"
)

// Timestamp 是 time.Time 的封装类型，用于定制JSON/BSON行为
type Timestamp time.Time

// New 创建一个Timestamp实例
func New(t time.Time) *Timestamp {
    return &Timestamp(t)
}

// Now 返回当前时间的Timestamp指针
func Now() *Timestamp {
    return New(time.Now())
}

// MarshalJSON 将时间序列化为Unix秒级时间戳（整数字符串，如 "1717023456"）
func (t *Timestamp) MarshalJSON() ([]byte, error) {
    if t == nil {
        return []byte("null"), nil
    }
    ts := time.Time(*t).Unix()
    return []byte(strconv.FormatInt(ts, 10)), nil
}

// UnmarshalJSON 从Unix时间戳整数字符串反序列化（支持 "1717023456" 或 1717023456）
func (t *Timestamp) UnmarshalJSON(data []byte) error {
    if t == nil {
        return json.InvalidUnmarshalError{Type: typeOfTimestamp}
    }

    // 先尝试解析为字符串（带引号）
    var s string
    if err := json.Unmarshal(data, &s); err == nil {
        ts, err := strconv.ParseInt(s, 10, 64)
        if err != nil {
            return err
        }
        *t = Timestamp(time.Unix(ts, 0))
        return nil
    }

    // 再尝试解析为数字（无引号）
    var i int64
    if err := json.Unmarshal(data, &i); err != nil {
        return err
    }
    *t = Timestamp(time.Unix(i, 0))
    return nil
}

// GetBSON 实现 bson.Marshaler 接口：转为标准 time.Time 供MongoDB写入
func (t *Timestamp) GetBSON() (interface{}, error) {
    if t == nil || time.Time(*t).IsZero() {
        return nil, nil
    }
    return time.Time(*t), nil
}

// SetBSON 实现 bson.Unmarshaler 接口：从BSON time.Time还原
func (t *Timestamp) SetBSON(raw bson.Raw) error {
    if t == nil {
        return bson.ErrNilPointer
    }
    var tm time.Time
    if err := raw.Unmarshal(&tm); err != nil {
        return err
    }
    *t = Timestamp(tm)
    return nil
}

// String 实现 fmt.Stringer，便于日志和调试
func (t *Timestamp) String() string {
    if t == nil {
        return "<nil>"
    }
    return time.Time(*t).String()
}

var typeOfTimestamp = (*Timestamp)(nil)

? 关键注意事项：

• 接收者一致性：所有修改字段值的方法（UnmarshalJSON, SetBSON）及依赖解引用的方法（GetBSON, String）*必须使用指针接收者 `Timestamp**。值接收者无法修改原值，且禁止*t` 操作。
• nil 安全性：在 MarshalJSON/UnmarshalJSON/GetBSON 中显式检查 t == nil，避免 panic；UnmarshalJSON 还应校验传入数据是否为合法时间戳。
• 结构体字段声明：若字段为指针（如 Created_at *timestamp.Timestamp），初始化时需显式取地址：

  now := time.Now()
  user := User{
      Name:       "Alice",
      Created_at: (*timestamp.Timestamp)(&now), // ✅ 正确：将 *time.Time 转为 *Timestamp
      // 或更推荐：
      // Created_at: timestamp.Now(),
  }

• 替代方案提醒：对于新项目，建议优先考虑使用 json.Marshaler/json.Unmarshaler 配合标准 time.Time 字段 + 自定义JSON标签（如 json:"created_at,string"），或使用 https://github.com/mohae/deepcopy 等成熟库。自定义类型适用于有强一致性约束的场景。

✅ 总结：一个健壮的 Timestamp 类型，核心在于接收者类型统一为指针、全程防御性空值检查、明确区分序列化语义（JSON vs BSON）。按本教程实现后，即可无缝集成于API响应、MongoDB文档及单元测试中，杜绝“invalid indirect”类低级错误。

文中关于的知识介绍，希望对你的学习有所帮助！若是受益匪浅，那就动动鼠标收藏这篇《Go语言自定义时间戳实现方法》文章吧，也可关注golang学习网公众号了解相关技术文章。