[golang] 结构体json序列化时，如何自定义时间格式

2024年5月11日 188次阅读 来源: inspii

最近开发一个公司项目，发现Go语言结构体Json转换时，存在时间格式不一样问题。在网上找了很久也没有找到一个很好的方案。即结构体序列化后的格式是｀1993-01-01T20:08:23.000000028+08:00｀。但为了兼容公司以往的项目，希望沿用｀1993-01-01 20:08:23｀这种格式。网上找到了下面的代码，可以解决大部分的问题。

import "time"

const (
    DateFormat = "2006-01-02"
    TimeFormat = "2006-01-02 15:04:05"
)

type Time time.Time

func Now() Time {
    return Time(time.Now())
}

func (t *Time) UnmarshalJSON(data []byte) (err error) {
    now, err := time.ParseInLocation(`"`+TimeFormat+`"`, string(data), time.Local)
    *t = Time(now)
    return
}

func (t Time) MarshalJSON() ([]byte, error) {
    b := make([]byte, 0, len(TimeFormat)+2)
    b = append(b, '"')
    b = time.Time(t).AppendFormat(b, TimeFormat)
    b = append(b, '"')
    return b, nil
}

func (t Time) String() string {
    return time.Time(t).Format(TimeFormat)
}

但是这样写会对原有的struct产生影响，需要将原来的time.Time的变量类型替换成Time。可在使用一些ORM时就不行了，比如Beego的Orm就会报错了。因此，要在不改变结构体时间类型的情况下，替换掉原来的时间格式。就只能和上面的代码一样，给结构体也实现MarshalJson和UnmarshalJson方法。

type User struct {
    Id        int       `json:"id"`
    Name      string    `json:"name"`
    CreatedAt time.Time `json:"created_at"`
}

func (u *User) MarshalJSON() ([]byte, error) {
    type Alias User
    user := &struct {
        CreatedAt Time `json:"created_at"`
        *Alias
    }{Time(u.CreatedAt), (*Alias)(u)}

    return json.Marshal(user)
}

func (u *User) UnmarshalJSON(data []byte) (err error) {
    type Alias User
    user := &struct {
        CreatedAt Time `json:"created_at"`
        *Alias
    }{Time(u.CreatedAt), (*Alias)(u)}
    err = json.Unmarshal(data, user)
    if err != nil {
        return err
    }

    user.Alias.CreatedAt = time.Time(user.CreatedAt)
    *u = User(*user.Alias)
    return nil
}

func main() {
    var user *User

    user = &User{
        Id: 4,
        Name: "Liam",
        CreatedAt: time.Now(),
    }
    bytes, _ := json.Marshal(user)
    fmt.Printf("%v\n", string(bytes))

    data := `{"id":3, "name":"Liam Lian", "created_at":"2017-11-18 19:00:00"}`
    json.Unmarshal([]byte(data), &user)
    fmt.Printf("%v\n", user)
}

虽然这样便实现了时间格式的兼容，而且不影响原来的结构体。但如果这样的结构体比较多的话，就会有很多的这类代码。于是就要用其他json包了。如liamylian/jsontime

package main

import(
    "fmt"
    "time"
    "github.com/liamylian/jsontime"
)

var json = jsontime.ConfigWithCustomTimeFormat

type User struct {
    Id        int       `json:"id"`
    Name      string    `json:"name"`
    CreatedAt time.Time `json:"created_at" time_format:"sql_datetime" time_utc:"false"`
}

func main() {
    user := User {
        Id:         1,
        Name:       "Liam",
        CreatedAt:  time.Now(),
    }
    
    bytes, _ := json.Marshal(user)
    fmt.Printf("%s", bytes)
}
    原文作者：inspii
    原文地址: https://segmentfault.com/a/1190000012066145
    本文转自网络文章，转载此文章仅为分享知识，如有侵权，请联系博主进行删除。
点赞