Golang中自定义json序列化时间格式的示例代码

更新时间：2024年08月16日 09:22:06 作者：hbqst

Go语言作为一个由Google开发,号称互联网的C语言的语言,自然也对JSON格式支持很好,下面这篇文章主要介绍了关于Golang中自定义json序列化时间格式的相关内容,下面话不多说了,来一起看看详细的介绍吧

自定义序列化时间格式

问题场景

有一个User结构体，其中有一个time.Time类型的字段

type User struct {
	Name     string    `json:"name"`
	Age      int       `json:"age"`
	Birthday time.Time `json:"birthday"`
}

定义一个jsonutil

func ToStr(v any) string {
	b, err := json.Marshal(v)
	if err != nil {
		return ""
	}
	return string(b)
}

func ToObj[T any](s string, v *T) *T {
	err := json.Unmarshal([]byte(s), v)
	if err != nil {
		return nil
	}
	return v
}

如果直接使用默认的json序列化，如下

func Test1(t *testing.T) {
	var user = User{
		Name:     "yimin",
		Age:      18,
		Birthday: time.Now(),
	}
	str := ToStr(user)
	fmt.Println(str)
}

得到的结果是这样的，时间格式不是很友好

{"name":"yimin","age":18,"birthday":"2024-08-15T15:50:51.3876651+08:00"}

实现接口

让User实现Marshaler接口，自定义序列化逻辑

func (u *User) MarshalJSON() ([]byte, error) {
	type UserTemp User // 避免循环引用
	type ToMarshal struct {
		*UserTemp        // 这里必须使用匿名嵌套，序列化才会展开平铺，从而使用string类型Birthday
		Birthday  string `json:"birthday"`
	}
	return json.Marshal(ToMarshal{
		UserTemp: (*UserTemp)(u),
		Birthday: u.Birthday.Format(time.DateTime),
	})
}

思路：

不要序列化原结构体，而是序列化一个新的结构体
新结构体中将原来time.Time类型的字段重新定义为string类型，这样就可以自定义时间格式了
同时新结构体还需要保留原结构体所有其他字段

实现：

利用json序列化嵌套匿名结构体的特性（展开平铺）
这里匿名结构体需要重新定义类型，避免循环引用
这样一来，序列化User转化为序列化ToMarshal，且将Birthday改为了string类型（可以自定义格式）

测试

注意此时需要传递user的指针类型

func Test1(t *testing.T) {
	var user = User{
		Name:     "yimin",
		Age:      18,
		Birthday: time.Now(),
	}
	str := ToStr(&user)
	fmt.Println(str)
}

{"name":"yimin","age":18,"birthday":"2024-08-15 15:59:26"}

那反序列化呢？

func Test2(t *testing.T) {
	var str = `{"name":"yimin","age":18,"birthday":"2024-08-15 15:59:26"}`
	var user = ToObj[*User](str, &User{})
	fmt.Println(user)
}

直接失败了，因为默认不支持这个时间格式

<nil>

解决方法也是一样的，自己实现反序列化逻辑

处理反序列化时间格式

实现接口

func (u *User) UnmarshalJSON(b []byte) error {
	type UserTemp User
	type ToUnMarshal struct {
		*UserTemp
		Birthday string `json:"birthday"`
	}
	var t = ToUnMarshal{
		UserTemp: (*UserTemp)(u), // 确保数据反序列化到u，但不会处理Birthday
	}
	if err := json.Unmarshal(b, &t); err != nil {
		return err
	}
	var err error
	// 单独处理birthday
	u.Birthday, err = time.Parse(time.DateTime, t.Birthday)
	return err
}

思路：

大体思路和序列化是一样的，换个Birthday类型是string的结构体反序列化
反序列化前需要手动初始化UserTemp为this对象，确保该有的数据都能对应上（除了Birthday）
单独处理this对象的Birthday，手动指定格式Parse

测试

func Test2(t *testing.T) {
	var str = `{"name":"yimin","age":18,"birthday":"2024-08-15 15:59:26"}`
	var user = ToObj[User](str, &User{})
	fmt.Printf("%+v\n", user)
}

&{Name:yimin Age:18 Birthday:2024-08-15 15:59:26 +0000 UTC}

进一步简化

上面的方法虽然解决了问题，但是对于每一个结构体都要实现方法，比较繁琐
我们关注的只是time.Time类型的序列化和反序列化，于是可以自定义时间类型，单独对这个类型实现方法
后面需要使用time.Time类型的地方，替换为我们自定义的时间类型

自定义类型

type Time time.Time

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

// 固定写法，前后加"
func (t Time) MarshalJSON() ([]byte, error) {
	b := make([]byte, 0, len(format)+2)
	b = append(b, '"')
	b = time.Time(t).AppendFormat(b, format)
	b = append(b, '"')
	return b, nil
}

// 固定写法，格式化字符串前后加上"
// 因为需要修改t，使用指针类型
func (t *Time) UnmarshalJSON(data []byte) error {
	formatTime, err := time.ParseInLocation(`"`+format+`"`, string(data), time.Local)
	if err != nil {
		return err
	}
	*t = Time(formatTime)
	return nil
}

// 格式化输出
func (t Time) String() string {
	return time.Time(t).Format(format)
}

time.Time替换为自定义类型

type User struct {
	Name     string `json:"name"`
	Age      int    `json:"age"`
	Birthday Time   `json:"birthday"`
}

测试

func Test1(t *testing.T) {
	var user = User{
		Name:     "yimin",
		Age:      18,
		Birthday: Time(time.Now()),
	}
	str := ToStr(&user)
	fmt.Println(str)
}

func Test2(t *testing.T) {
	var str = `{"name":"yimin","age":18,"birthday":"2024-08-15 15:59:26"}`
	var user = ToObj[User](str, &User{})
	fmt.Printf("%+v\n", user)
}

{"name":"yimin","age":18,"birthday":"2024-08-15 17:23:37"}
&{Name:yimin Age:18 Birthday:2024-08-15 15:59:26}

以上就是Golang中自定义json序列化时间格式的示例代码的详细内容，更多关于Golang自定义json时间格式的资料请关注脚本之家其它相关文章！

您可能感兴趣的文章:

Go语言转换所有字符串为大写或者小写的方法
这篇文章主要介绍了Go语言转换所有字符串为大写或者小写的方法,实例分析了ToLower和ToUpper函数的使用技巧,具有一定参考借鉴价值,需要的朋友可以参考下
2015-02-02
Go pprof内存指标含义备忘录及案例分析
这篇文章主要介绍了Go pprof内存指标含义备忘录问题，小编特此把问题及案例分享到脚本之家平台供大家学习,需要的朋友可以参考下
2020-03-03
源码分析Go语言使用cgo导致线程增长的原因
这篇文章主要从一个cgo调用开始解析Go语言源码，从而分析一下造成线程增长的原因，文中的示例代码讲解详细，感兴趣的小伙伴可以跟随小编一学习一下
2023-06-06
Go压缩位图库roaring安装使用详解
这篇文章主要为大家介绍了Go压缩位图库roaring安装使用详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2022-07-07
Go语言中实现enum枚举的方法详解
枚举,即 enum,可用于表示一组范围固定的值,它能助我们写出清晰、安全的代码,那么你是否了解过 Go 中的枚举呢？下面就跟随小编一起来学习一下Go语言中实现enum枚举的常用方法吧
2024-02-02
详解Golang时间处理的踩坑及解决
在各个语言之中都有时间类型的处理，这篇文章主要和大家分享一下Golang进行时间处理时哪里最容易踩坑以及解决方法，需要的可以参考一下
2023-01-01
浅谈GO中的Channel以及死锁的造成
本文主要介绍了浅谈GO中的Channel以及死锁的造成，文中根据实例编码详细介绍的十分详尽，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2022-03-03
提升Go语言开发效率的小技巧实例(GO语言语法糖)汇总
这篇文章主要介绍了提升Go语言开发效率的小技巧汇总,也就是Go语言的语法糖，掌握好这些可以提高我们的开发效率，需要的朋友可以参考下
2022-11-11
Go语言如何实现Benchmark函数
go想要在main函数中测试benchmark会麻烦一些,所以这篇文章主要为大家介绍了如何实现了一个简单的且没有开销的benchmark函数,希望对大家有所帮助
2024-12-12
Go语言中转换JSON数据简单例子
这篇文章主要介绍了Go语言中转换JSON数据简单例子,本文先定义了一个结构体,然后把JSON绑定到结构体上实现读取,需要的朋友可以参考下
2014-10-10