Golang中自定義json序列化時間格式的示例代碼
更新時間:2024年08月16日 09:22:06 作者:hbqst
Go語言作為一個由Google開發(fā),號稱互聯網的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 // 避免循環(huán)引用 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序列化嵌套匿名結構體的特性(展開平鋪)
- 這里匿名結構體需要重新定義類型,避免循環(huán)引用
- 這樣一來,序列化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語言開發(fā)效率的小技巧實例(GO語言語法糖)匯總
這篇文章主要介紹了提升Go語言開發(fā)效率的小技巧匯總,也就是Go語言的語法糖,掌握好這些可以提高我們的開發(fā)效率,需要的朋友可以參考下2022-11-11