Go语言Gin框架自定义JSON编码器定制日期格式

阿杰吖_4573

阿杰吖_4573

2026-08-29

293人浏览

原创

go标准库encoding/json完全忽略time_format等自定义struct tag,因其未实现该解析逻辑;gin的c.json()直接调用该库,故无法通过tag控制时间格式,必须自定义类型并实现json.marshaler/unmarshaler接口。

go语言gin框架自定义json编码器定制日期格式

Go 的 encoding/json 包不支持通过 struct tag(如 json:"created_at,time_format:\"2006-01-02\"")控制时间格式,Gin 默认也沿用它;想让 API 响应里的 time.Time 字段输出 "2024-05-20 14:23:15" 这类格式,必须自定义类型并实现 json.Marshaler 和 json.Unmarshaler 接口。

为什么 Gin 无法直接用 time_format tag 控制格式

Gin 的 c.JSON() 底层调用的是标准库 encoding/json,而该包**完全忽略**任何形如 time_format 的 struct tag。写 json:"updated_at,time_format:\"2006-01-02 15:04:05\"" 不会产生任何效果,字段仍按 RFC 3339 输出(带纳秒、时区偏移、冒号),前端解析可能失败或入库报错。

  • 这不是 Gin 的限制,是 Go 标准库的设计决定
  • 第三方 JSON 库(如 github.com/goccy/go-json)才支持扩展 tag,但 Gin 默认不集成
  • 试图在 controller 里手动 .Format() 再塞进 map,会丢失类型安全,且反序列化失效

正确做法:定义 LocalTime 类型并实现 MarshalJSON/UnmarshalJSON

推荐使用嵌入 time.Time 的别名类型(如 type LocalTime time.Time),而非结构体封装——更轻量、零额外内存开销、方法继承清晰。

  • MarshalJSON 必须返回带双引号的 JSON 字符串字节切片,不能只返回裸字符串
  • UnmarshalJSON 接收者必须是指针(*LocalTime),否则无法修改原值
  • 解析时要处理 "null" 字符串,否则遇到 null 会 panic
  • 布局字符串必须严格用 Go 的基准时间 "2006-01-02 15:04:05",写成 "yyyy-MM-dd" 会直接崩溃

示例关键代码:

Aria2 Json Rpc
Aria2 Json Rpc

通过 JSON‑RPC 2.0 与 aria2 下载管理器交互,使用自然语言命令管理下载、查询状态并控制任务。适用于 aria2、下载管理或种子操作。

下载
type LocalTime time.Time

const timeFormat = "2006-01-02 15:04:05"

func (t LocalTime) MarshalJSON() ([]byte, error) {
    if time.Time(t).IsZero() {
        return []byte("null"), nil
    }
    return json.Marshal(time.Time(t).Format(timeFormat))
}

func (t *LocalTime) UnmarshalJSON(data []byte) error {
    if string(data) == "null" {
        *t = LocalTime(time.Time{})
        return nil
    }
    s := strings.Trim(string(data), `"`)
    tt, err := time.Parse(timeFormat, s)
    if err != nil {
        return err
    }
    *t = LocalTime(tt)
    return nil
}

嵌入结构体时注意字段声明和时区一致性

在 Gin handler 返回的结构体中,字段需声明为 LocalTime 类型,并保持 JSON tag 小写+下划线风格(与多数 REST API 约定一致):

  • 字段名必须导出(首字母大写),否则 json 包无法访问
  • 建议统一用 time.Local 或 time.UTC 解析,避免本地时区导致跨服务器时间偏移(例如部署在 UTC+8 和 UTC+0 的机器上结果不同)
  • 若业务允许空日期,改用 *LocalTime 指针类型,null 对应 nil,比零值更语义明确
  • 数据库交互场景下,还需额外实现 driver.Valuer 和 sql.Scanner 接口(如 MySQL DATETIME 字段)

结构体示例:

type UserResponse struct {
    ID        uint       `json:"id"`
    Name      string     `json:"name"`
    CreatedAt LocalTime  `json:"created_at"` // 自动触发 LocalTime.MarshalJSON
    UpdatedAt *LocalTime `json:"updated_at"` // 支持 null
}

容易被忽略的细节:UnmarshalJSON 中的引号处理和零值语义

JSON 字符串在 data []byte 中自带双引号(如 []byte(`"2024-05-20 14:23:15"`)),所以 time.Parse 时不能直接传 string(data),否则会因开头结尾的引号匹配失败而报错 parsing time ""2024-05-20 14:23:15"" as "2006-01-02 15:04:05": cannot parse """ as "2006"。

  • 必须先 strings.Trim(string(data), `"`) 去掉外层引号
  • 零值(time.Time{})默认是 0001-01-01 00:00:00 +0000 UTC,业务上往往代表“无效时间”,应显式返回错误或转为 null,而不是静默接受
  • 如果 API 要求所有时间字段必填,UnmarshalJSON 遇到空字符串或非法格式应返回具体错误,方便前端定位问题,而不是吞掉

golang免费学习笔记(深入):立即使用
在学习笔记中,你将探索golang的核心概念和高级技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
Golang 入门学习路线:从零基础到上手开发
Golang 入门学习路线:从零基础到上手开发

Golang 入门路线涵盖从零到上手的核心路径:首先打牢基础语法与切片等底层机制;随后攻克 Go 的灵魂——接口设计与 Goroutine 并发模型;接着通过 Gin 框架与 GORM 深入 Web 开发实战;最后在微服务与云原生工具开发中进阶,旨在培养具备高性能并发处理能力的后端工程师。

2026.02.24

206

7

Golang 疑难杂症解决指南:常见问题排查与优化
Golang 疑难杂症解决指南:常见问题排查与优化

《Golang 疑难杂症解决指南》聚焦开发过程中常见却棘手的问题,从并发模型、内存管理、性能瓶颈到工程化实践逐步拆解。通过真实案例与调试思路,帮助开发者定位问题根因,建立系统化排查方法。不只给出答案,更强调分析路径与工具使用,让你在复杂 Go 项目中具备持续解决问题的能力。

2026.02.24

113

7

Golang 运行与部署实战:从本地到云端
Golang 运行与部署实战:从本地到云端

《Golang 运行与部署实战》围绕 Go 应用从开发完成到稳定上线的完整流程展开,系统讲解编译构建、环境配置、日志与配置管理、容器化部署以及常见运维问题处理。结合真实项目场景,拆解自动化构建与持续部署思路,帮助开发者建立可靠的发布流程,提升服务稳定性与可维护性。

2026.02.24

617

10

Golang 面试题精选:高频问题与解答
Golang 面试题精选:高频问题与解答

Golang 面试题精选》系统整理企业常见 Go 技术面试问题,覆盖语言基础、并发模型、内存与调度机制、网络编程、工程实践与性能优化等核心知识点。每道题不仅给出答案,还拆解背后的设计原理与考察思路,帮助读者建立完整知识结构,在面试与实际开发中都能更从容应对复杂问题。

2026.02.24

198

7

Golang 性能优化专题:提升应用效率
Golang 性能优化专题:提升应用效率

《Golang 性能优化专题》聚焦 Go 应用在高并发与大规模服务中的性能问题,从 profiling、内存分配、Goroutine 调度、GC 机制到 I/O 与锁竞争逐层分析。结合真实案例讲解定位瓶颈的方法与优化策略,帮助开发者建立系统化性能调优思维,在保证代码可维护性的同时显著提升服务吞吐与稳定性。

2026.02.24

437

7

Golang 生态工具与框架:扩展开发能力
Golang 生态工具与框架:扩展开发能力

《Golang 生态工具与框架》系统梳理 Go 语言在实际工程中的主流工具链与框架选型思路,涵盖 Web 框架、RPC 通信、依赖管理、测试工具、代码生成与项目结构设计等内容。通过真实项目场景解析不同工具的适用边界与组合方式,帮助开发者构建高效、可维护的 Go 工程体系,并提升团队协作与交付效率。

2026.02.24

188

7

Golang 并发编程专题:掌握多核时代的核心技能
Golang 并发编程专题:掌握多核时代的核心技能

《Golang 并发编程专题:掌握多核时代的核心技能》系统讲解 Go 在并发领域的设计哲学与实践方法,深入剖析 goroutine、channel、调度模型与并发安全机制,结合真实场景与性能思维,帮助开发者构建高吞吐、低延迟、可扩展的并发程序,全面提升多核时代的工程能力。

2026.02.26

544

7

Golang Web 开发路线:构建高效后端服务
Golang Web 开发路线:构建高效后端服务

《Golang Web 开发路线:构建高效后端服务》围绕 Go 在后端领域的工程实践,系统讲解 Web 框架选型、路由设计、中间件机制、数据库访问与接口规范,结合高并发与可维护性思维,逐步构建稳定、高性能、易扩展的后端服务体系,帮助开发者形成完整的 Go Web 架构能力。

2026.02.26

205

7

Golang 实际项目案例:从需求到上线
Golang 实际项目案例:从需求到上线

《Golang 实际项目案例:从需求到上线》以真实业务场景为主线,完整覆盖需求分析、架构设计、模块拆分、编码实现、性能优化与部署上线全过程,强调工程规范与实践决策,帮助开发者打通从技术实现到系统交付的关键路径,提升独立完成 Go 项目的综合能力。

2026.02.26

62

7

热门下载

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

精品课程

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