0

0

Golang 中自定义时间戳类型(Timestamp)的正确实现与使用指南

聖光之護

聖光之護

发布时间:2026-03-14 22:23:03

|

897人浏览过

|

来源于php中文网

原创

本文详解如何在 Go 中安全实现支持 JSON 和 BSON 序列化的自定义 Timestamp 类型,解决因方法接收器类型不匹配导致的编译错误,并提供可直接复用的构造方式与最佳实践。

本文详解如何在 go 中安全实现支持 json 和 bson 序列化的自定义 `timestamp` 类型,解决因方法接收器类型不匹配导致的编译错误,并提供可直接复用的构造方式与最佳实践。

在 Go 应用开发中,尤其是对接 MongoDB(通过 mgo 或官方 driver)和 REST API 时,常需对时间字段进行统一格式化处理——例如将 time.Time 序列化为 Unix 时间戳整数(而非 ISO8601 字符串)。为此,许多开发者会封装一个 Timestamp 类型。但若方法接收器声明不当,极易引发类似 invalid indirect of t (type Timestamp) 的编译错误。根本原因在于:值接收器无法对结构体/类型本身取地址,而 GetBSON 和 SetBSON 等方法内部需修改或解引用 t,必须使用指针接收器

以下是修正后的、生产可用的 Timestamp 实现(已适配现代 Go 模块与标准库,移除了过时的 labix.org/v2/mgo/bson 依赖,推荐使用 go.mongodb.org/mongo-driver/bson 或保持兼容性):

package timestamp

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

// Timestamp 是 time.Time 的别名,用于定制序列化行为
type Timestamp time.Time

// MarshalJSON 将时间序列化为 Unix 秒级时间戳(int64 → string)
func (t *Timestamp) MarshalJSON() ([]byte, error) {
    if t == nil {
        return []byte("null"), nil
    }
    ts := time.Time(*t).Unix()
    return []byte(fmt.Sprintf("%d", ts)), nil
}

// UnmarshalJSON 从 Unix 时间戳字符串反序列化为 Timestamp
func (t *Timestamp) UnmarshalJSON(b []byte) error {
    if len(b) == 0 || string(b) == "null" {
        *t = Timestamp{}
        return nil
    }
    s := string(b)
    // 去除引号(JSON 字符串格式如 "1717023456")
    if len(s) >= 2 && s[0] == '"' && s[len(s)-1] == '"' {
        s = s[1 : len(s)-1]
    }
    ts, err := strconv.ParseInt(s, 10, 64)
    if err != nil {
        return fmt.Errorf("failed to parse timestamp: %w", err)
    }
    *t = Timestamp(time.Unix(ts, 0))
    return nil
}

// GetBSON(mgo 兼容):返回 time.Time 供 BSON 编码,需指针接收器
func (t *Timestamp) GetBSON() (interface{}, error) {
    if t == nil || time.Time(*t).IsZero() {
        return nil, nil
    }
    return time.Time(*t), nil
}

// SetBSON(mgo 兼容):从 BSON raw data 解析为 Timestamp
func (t *Timestamp) SetBSON(raw bson.Raw) error {
    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 time.Time(t).IsZero() {
        return "(zero time)"
    }
    return time.Time(t).Format(time.RFC3339)
}

// 辅助构造函数(强烈推荐)
func Now() *Timestamp {
    now := time.Now()
    return (*Timestamp)(&now)
}

func New(t time.Time) *Timestamp {
    return (*Timestamp)(&t)
}

关键修复点

  • GetBSON 和 SetBSON 方法签名必须为 func (t *Timestamp) ...(指针接收器),否则 *t 解引用非法;
  • UnmarshalJSON 中增加 nil 和 "null" 容错,避免 panic;
  • MarshalJSON 增加 nil 检查,确保空指针安全;
  • 补充 Now() 和 New() 构造函数,大幅提升使用便捷性与可读性。

在模型中使用时,应严格匹配指针类型:

MusicAI
MusicAI

AI音乐生成工具

下载

立即学习go语言免费学习笔记(深入)”;

import "your-module/timestamp"

type User struct {
    Name      string             `bson:"name" json:"name"`
    CreatedAt *timestamp.Timestamp `bson:"created_at,omitempty" json:"created_at,omitempty"`
    UpdatedAt *timestamp.Timestamp `bson:"updated_at,omitempty" json:"updated_at,omitempty"`
}

// 创建实例(推荐方式)
u := User{
    Name:      "Alice",
    CreatedAt: timestamp.Now(), // ✅ 清晰、安全、零错误
    UpdatedAt: timestamp.New(time.Date(2024, 1, 1, 0, 0, 0, 0, time.UTC)),
}

// 或显式转换(不推荐,易出错)
// now := time.Now()
// u := User{CreatedAt: (*timestamp.Timestamp)(&now)}

⚠️ 注意事项

  • 若使用官方 MongoDB Go Driver(go.mongodb.org/mongo-driver/bson),请将 GetBSON/SetBSON 替换为 MarshalBSON/UnmarshalBSON 方法,并遵循其接口规范;
  • Timestamp 不应嵌入 time.Time(如 type Timestamp struct { time.Time }),否则失去类型隔离性与序列化控制权;
  • 在 HTTP 响应中返回 Unix 时间戳是常见需求,但需与前端约定好单位(秒 or 毫秒),本例默认秒级,如需毫秒,将 Unix() 改为 UnixMilli() 并同步调整 UnmarshalJSON 解析逻辑。

掌握此模式后,你不仅能彻底规避编译错误,还能构建出类型安全、序列化可控、易于维护的时间字段抽象,为微服务与数据持久层打下坚实基础。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
golang如何定义变量
golang如何定义变量

golang定义变量的方法:1、声明变量并赋予初始值“var age int =值”;2、声明变量但不赋初始值“var age int”;3、使用短变量声明“age :=值”等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

211

2024.02.23

golang有哪些数据转换方法
golang有哪些数据转换方法

golang数据转换方法:1、类型转换操作符;2、类型断言;3、字符串和数字之间的转换;4、JSON序列化和反序列化;5、使用标准库进行数据转换;6、使用第三方库进行数据转换;7、自定义数据转换函数。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

247

2024.02.23

golang常用库有哪些
golang常用库有哪些

golang常用库有:1、标准库;2、字符串处理库;3、网络库;4、加密库;5、压缩库;6、xml和json解析库;7、日期和时间库;8、数据库操作库;9、文件操作库;10、图像处理库。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

356

2024.02.23

golang和python的区别是什么
golang和python的区别是什么

golang和python的区别是:1、golang是一种编译型语言,而python是一种解释型语言;2、golang天生支持并发编程,而python对并发与并行的支持相对较弱等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

214

2024.03.05

golang是免费的吗
golang是免费的吗

golang是免费的。golang是google开发的一种静态强类型、编译型、并发型,并具有垃圾回收功能的开源编程语言,采用bsd开源协议。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

410

2024.05.21

golang结构体相关大全
golang结构体相关大全

本专题整合了golang结构体相关大全,想了解更多内容,请阅读专题下面的文章。

490

2025.06.09

golang相关判断方法
golang相关判断方法

本专题整合了golang相关判断方法,想了解更详细的相关内容,请阅读下面的文章。

201

2025.06.10

golang数组使用方法
golang数组使用方法

本专题整合了golang数组用法,想了解更多的相关内容,请阅读专题下面的文章。

1499

2025.06.17

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

49

2026.03.13

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Go 教程
Go 教程

共32课时 | 6.2万人学习

Go语言实战之 GraphQL
Go语言实战之 GraphQL

共10课时 | 0.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号