快捷導(dǎo)航

GO項目實戰(zhàn)之Gorm格式化時間字段實現(xiàn)

更新時間：2023年01月07日 12:03:10 作者：GoLang成長之路

GORM自帶的time.Time類型JSON默認(rèn)輸出RFC3339Nano格式的,下面這篇文章主要給大家介紹了關(guān)于GO項目實戰(zhàn)之Gorm格式化時間字段實現(xiàn)的相關(guān)資料,文中通過實例代碼介紹的非常詳細(xì),需要的朋友可以參考下

goshop開源項目的更新

備注：前面項目中用到的代碼已經(jīng)分享到GitHub中去了，并且以后所有項目中會出現(xiàn)的代碼都會提交上去，歡迎查閱。感興趣的可以點個star哦~
https://gitee.com/jobhandsome/goshop/

在使用 gorm 查詢時，如果未對時間字段進(jìn)行處理，結(jié)構(gòu)體內(nèi)的字段類型咱們使用的是 time.Time ：

type Model struct {
    ID        int64      `json:"id" gorm:"primary_key"`
    CreatedAt *time.Time `json:"created_at"`
    UpdatedAt *time.Time `json:"updated_at"`
    DeletedAt *time.Time `json:"deleted_at" sql:"index"`
}

這里咱們使用 time.Time 類型在 gorm 進(jìn)行查詢的返回結(jié)果，讀取到的時間字段往往是這樣：“2022-07-03T22:14:02.973528+08:00”，帶著時區(qū)和毫秒。但其實往往這樣的格式，不是咱們想要的。

那么問題就來了：

如果想要 “2022-07-03 22:14:02” 這樣的格式，需要怎么處理呢？
當(dāng)插入一條數(shù)據(jù)到對應(yīng)的表中時，UpdateAt 字段是不賦值的，插入到數(shù)據(jù)庫則會 0001-01-01 00:00:00.000000+00:00，系統(tǒng)賦了?個默認(rèn)值，當(dāng)不想插?默認(rèn)值時如何處理？

通過上面的分析，咱們能確定兩個需求：

讀取到的時間需要是：“2022-07-03 22:14:02” 這樣的格式

當(dāng)時間字段不賦值時，不插入默認(rèn)值

解決方法：

定義一個時間類型 struct

type LocalTime time.Time

雖然該數(shù)據(jù)類型實際類型為 time.Time，但是不具備 time.Time 的內(nèi)置?法，需要重寫 MarshalJSON ?法來實現(xiàn)數(shù)據(jù)解析

func (t *LocalTime) MarshalJSON() ([]byte, error) {
    tTime := time.Time(*t)
    return []byte(fmt.Sprintf("\"%v\"", tTime.Format("2006-01-02 15:04:05"))), nil
}

注意：GO的格式化時間的規(guī)定時間字符串必須為 2006-01-02 15:04:05
這是GO的誕?時間，不能更改為其他時間(這個時間字符串與java的"yyyy-MM-dd HH:mm:ss")同作?

將 time.Time 替換成 LocalTime

type Model struct {
    ID        int64      `json:"id" gorm:"primary_key"`
    CreatedAt *LocalTime `json:"created_at"`
    UpdatedAt *localTime `json:"updated_at"`
    DeletedAt *localTime `json:"deleted_at" sql:"index"`
}

到了這一步就解決了第一個需求讀取數(shù)據(jù)時將將時間數(shù)據(jù)格式化。

下面來實現(xiàn)第二個需求：

func (t LocalTime) Value() (driver.Value, error) {
    var zeroTime time.Time
    tlt := time.Time(t)
    //判斷給定時間是否和默認(rèn)零時間的時間戳相同
    if tlt.UnixNano() == zeroTime.UnixNano() {
        return nil, nil
    }
    return tlt, nil
}

Value?法即在存儲時調(diào)?，將該?法的返回值進(jìn)?存儲，該?法可以實現(xiàn)數(shù)據(jù)存儲前對數(shù)據(jù)進(jìn)?相關(guān)操作。

func (t *LocalTime) Scan(v interface{}) error {
    if value, ok := v.(time.Time); ok {
        *t = LocalTime(value)
        return nil
    }
    return fmt.Errorf("can not convert %v to timestamp", v)
}

Scan?法可以實現(xiàn)在數(shù)據(jù)查詢出來之前對數(shù)據(jù)進(jìn)?相關(guān)操作。

到了這一步，咱們就實現(xiàn)了上面需求的功能。

補充：gorm時間格式化問題詳解

說明

在做項目時發(fā)現(xiàn)gorm的時間格式是帶有時區(qū)輸入輸出的，對平常使用的2020-01-03 12:22:33格式有一定的出入，不方便前端和后端的對接，所以自己整理一下處理這個問題方法，方便大家參考

代碼如下

package models

import (
	"database/sql/driver"
	"errors"
	"fmt"
	"strings"
	"time"
)

//BaseModel 基礎(chǔ)結(jié)構(gòu)體 信息信息
type BaseModel struct {
	CreateTime MyTime `gorm:"comment:'創(chuàng)建時間';type:timestamp;";json:"createTime"`
	UpdateTime MyTime `gorm:"comment:'修改時間';type:timestamp;";json:"updateTime"`
	Remark     string `gorm:"comment:'備注'";json:"remark"`
}
//MyTime 自定義時間
type MyTime time.Time

func (t *MyTime) UnmarshalJSON(data []byte) error {
	if string(data) == "null" {
		return nil
	}
	var err error
	//前端接收的時間字符串
	str := string(data)
	//去除接收的str收尾多余的"
	timeStr := strings.Trim(str, "\"")
	t1, err := time.Parse("2006-01-02 15:04:05", timeStr)
	*t = MyTime(t1)
	return err
}

func (t MyTime) MarshalJSON() ([]byte, error) {
	formatted := fmt.Sprintf("\"%v\"", time.Time(t).Format("2006-01-02 15:04:05"))
	return []byte(formatted), nil
}

func (t MyTime) Value() (driver.Value, error) {
	// MyTime 轉(zhuǎn)換成 time.Time 類型
	tTime := time.Time(t)
	return tTime.Format("2006-01-02 15:04:05"), nil
}

func (t *MyTime) Scan(v interface{}) error {
	switch vt := v.(type) {
	case time.Time:
		// 字符串轉(zhuǎn)成 time.Time 類型
		*t = MyTime(vt)
	default:
		return errors.New("類型處理錯誤")
	}
	return nil
}

func (t *MyTime) String() string {
	return fmt.Sprintf("hhh:%s", time.Time(*t).String())
}

實現(xiàn)原理

其實現(xiàn)方式其實是通過在時間讀取json時對解析格式進(jìn)行重寫，對轉(zhuǎn)換成字符串時進(jìn)行重寫達(dá)到效果