Golang GORM 中自定义 TIME 类型的正确实现与使用-Golang-PHP中文网

Golang GORM 中自定义 TIME 类型的正确实现与使用

本文详解如何在 GORM（v2）中正确映射 PostgreSQL 的 TIME 字段，通过实现 sql.Scanner 和 driver.Valuer 接口，避免默认 time.Time 因缺失日期部分导致的解析错误。

本文详解如何在 gorm（v2）中正确映射 postgresql 的 `time` 字段，通过实现 `sql.scanner` 和 `driver.valuer` 接口，避免默认 `time.time` 因缺失日期部分导致的解析错误。

在使用 GORM 操作 PostgreSQL 时，若数据库字段为 TIME（如 start_time TIME NOT NULL），直接使用标准 time.Time 类型会导致插入或查询失败——典型错误为：
parsing time "10:00:00" as "2006-01-02T15:04:05Z07:00": cannot parse "0:00" as "2006"。
这是因为 GORM 默认将 time.Time 映射为带日期的 TIMESTAMP，而 PostgreSQL 的 TIME 类型仅包含时分秒，不含年月日信息，二者语义不匹配。

解决方案是定义一个轻量级自定义类型，复用 time.Time 底层能力，但专用于 TIME 场景。该类型需实现两个核心接口：

driver.Valuer：控制写入数据库时的值转换（只保留 HH:MM:SS 格式）；
sql.Scanner：控制从数据库读取时的反序列化（按时间格式解析字符串或字节）；
（可选）gorm.GormDataType()：显式声明 GORM 字段类型为 "TIME"，增强可读性与迁移兼容性。

以下是完整、生产可用的实现：

package model

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

const MyTimeFormat = "15:04:05"

// MyTime 专用于 PostgreSQL TIME 字段，忽略日期部分
type MyTime time.Time

// NewMyTime 快捷构造器：传入时、分、秒创建 MyTime 实例
func NewMyTime(hour, min, sec int) MyTime {
    t := time.Date(0, 1, 1, hour, min, sec, 0, time.UTC)
    return MyTime(t)
}

// Scan 实现 sql.Scanner 接口：支持从 []byte、string、time.Time 或 nil 解析
func (t *MyTime) Scan(value interface{}) error {
    if value == nil {
        *t = MyTime{}
        return nil
    }
    switch v := value.(type) {
    case []byte:
        return t.UnmarshalText(string(v))
    case string:
        return t.UnmarshalText(v)
    case time.Time:
        *t = MyTime(v)
        return nil
    default:
        return fmt.Errorf("cannot scan %T into MyTime", value)
    }
}

// Value 实现 driver.Valuer 接口：输出为标准 HH:MM:SS 字符串
func (t MyTime) Value() (driver.Value, error) {
    if time.Time(t).IsZero() {
        return nil, nil // 可选：空值转为 SQL NULL
    }
    return time.Time(t).Format(MyTimeFormat), nil
}

// UnmarshalText 支持 JSON/CSV 等文本反序列化
func (t *MyTime) UnmarshalText(text string) error {
    parsed, err := time.Parse(MyTimeFormat, text)
    if err != nil {
        return fmt.Errorf("failed to parse MyTime '%s': %w", text, err)
    }
    *t = MyTime(parsed)
    return nil
}

// MarshalText 支持 JSON 序列化（补全 JSON 兼容性）
func (t MyTime) MarshalText() ([]byte, error) {
    if time.Time(t).IsZero() {
        return []byte("null"), nil
    }
    return []byte(fmt.Sprintf(`"%s"`, time.Time(t).Format(MyTimeFormat))), nil
}

// GormDataType 告知 GORM 此字段对应数据库类型为 TIME（影响 AutoMigrate）
func (MyTime) GormDataType() string {
    return "TIME"
}

接着，在模型中使用该类型：

type Building struct {
    ID        int    `json:"id,omitempty" gorm:"primaryKey"`
    Name      string `gorm:"size:255" json:"name,omitempty"`
    Lon       string `gorm:"size:64" json:"lon,omitempty"`
    Lat       string `gorm:"size:64" json:"lat,omitempty"`
    StartTime MyTime `json:"start_time,omitempty"`
    EndTime   MyTime `json:"end_time,omitempty"`
}

插入示例：

Golang Spf13 Viper

Go 配置库，使用 spf13/viper — 分层优先级（flag > env >file > KV > default），提供 BindPFlag/BindPFlags、SetEnvPrefix + SetEnvKeyReplace 等功能。

下载

building := Building{
    Name:      "Main Tower",
    StartTime: NewMyTime(9, 0, 0),   // 09:00:00
    EndTime:   NewMyTime(17, 30, 0),  // 17:30:00
}
if err := db.Create(&building).Error; err != nil {
    log.Fatal(err)
}

✅ 关键注意事项：

不要为 MyTime 添加 gorm:"type:time" 标签——它会干扰自定义 GormDataType() 的行为；
若需支持零值（如 00:00:00）作为有效时间，请在 Value() 中移除 IsZero() 判断，或改用 time.Time 的 Hour()/Minute()/Second() 显式校验；
GORM v2 已原生支持 time.Duration 和部分时区类型，但 TIME 仍需手动适配；
如需时区感知（如 TIME WITH TIME ZONE），应扩展 MyTime 并使用 time.ParseInLocation，同时注意 PostgreSQL 服务端时区配置。