GO项目实战之Gorm格式化时间字段实现

2023-01-07 15:00

短信预约 -IT技能 免费直播动态提醒

goshop开源项目的更新

备注：前面项目中用到的代码已经分享到GitHub中去了，并且以后所有项目中会出现的代码都会提交上去，欢迎查阅。感兴趣的可以点个star哦~
https://gitee.com/jobhandsome/goshop/

在使用 gorm 查询时，如果未对时间字段进行处理，结构体内的字段类型咱们使用的是 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 进行查询的返回结果，读取到的时间字段往往是这样：“2022-07-03T22:14:02.973528+08:00”，带着时区和毫秒。但其实往往这样的格式，不是咱们想要的。

那么问题就来了：

如果想要 “2022-07-03 22:14:02” 这样的格式，需要怎么处理呢？
当插入一条数据到对应的表中时，UpdateAt 字段是不赋值的，插入到数据库则会 0001-01-01 00:00:00.000000+00:00，系统赋了⼀个默认值，当不想插⼊默认值时如何处理？

通过上面的分析，咱们能确定两个需求：

读取到的时间需要是：“2022-07-03 22:14:02” 这样的格式

当时间字段不赋值时，不插入默认值

解决方法：

定义一个时间类型 struct

type LocalTime time.Time

虽然该数据类型实际类型为 time.Time，但是不具备 time.Time 的内置⽅法，需要重写 MarshalJSON ⽅法来实现数据解析

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的格式化时间的规定时间字符串必须为 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"`
}

到了这一步就解决了第一个需求读取数据时将将时间数据格式化。

下面来实现第二个需求：

func (t LocalTime) Value() (driver.Value, error) {
    var zeroTime time.Time
    tlt := time.Time(t)
    //判断给定时间是否和默认零时间的时间戳相同
    if tlt.UnixNano() == zeroTime.UnixNano() {
        return nil, nil
    }
    return tlt, nil
}

Value⽅法即在存储时调⽤，将该⽅法的返回值进⾏存储，该⽅法可以实现数据存储前对数据进⾏相关操作。

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⽅法可以实现在数据查询出来之前对数据进⾏相关操作。

到了这一步，咱们就实现了上面需求的功能。

补充：gorm时间格式化问题详解

说明

在做项目时发现gorm的时间格式是带有时区输入输出的，对平常使用的2020-01-03 12:22:33格式有一定的出入，不方便前端和后端的对接，所以自己整理一下处理这个问题方法，方便大家参考

代码如下

package models

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

//BaseModel 基础结构体 信息信息
type BaseModel struct {
	CreateTime MyTime `gorm:"comment:'创建时间';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 转换成 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:
		// 字符串转成 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())
}

实现原理

其实现方式其实是通过在时间读取json时对解析格式进行重写，对转换成字符串时进行重写达到效果