Go语言GORM如何自定义数据类型_Golang Scanner与Valuer接口

夜婷姑娘_3876

夜婷姑娘_3876

2026-05-27

923人浏览

原创

必须同时实现sql.scanner和driver.valuer接口,缺一则gorm读写任一环节panic;因database/sql仅支持基础类型,自定义类型需自行定义序列化(value)和反序列化(scan)逻辑。

go语言gorm如何自定义数据类型_golang scanner与valuer接口

必须同时实现 sql.Scanner 和 driver.Valuer,缺一不可;否则 GORM 在读或写任意一端都会 panic。

为什么 Scan 和 Value 必须成对出现

database/sql 不认识你的自定义类型,它只接受基础类型(string、[]byte、int64 等)。当你把一个结构体或切片直接塞进 db.QueryRow().Scan() 或传给 db.Exec(),就会报错:sql: converting driver.Value type XXX to a <nil> is not supported</nil>。

解决路径只有一条:让类型自己说清「我怎么存」「我怎么读」。

  • Value() 负责写入前把自定义值转成数据库能收的格式(通常是 string 或 []byte)
  • Scan() 负责读取后把数据库返回的原始值(比如 []byte)还原成你的类型
  • GORM(v2+)在迁移时默认跳过未显式声明 type: 的字段,即使你实现了两个接口,没写 tag 也会建出 bytea 或 blob,跟你的序列化逻辑不匹配

如何正确实现 AvatarListJSON 这类切片类型

以存储用户已解锁头像 ID 列表([]int)为例,常见错误是只实现 Value()、漏掉 Scan(),或者在 Scan() 里没处理 nil 或空字节流。

正确写法要覆盖边界情况:

Golang Uber Dig
Golang Uber Dig

使用 uber-go/dig 在 Golang 中实现依赖注入——基于反射容器,提供 Provide/Invoke、dig.In/dig.Out 参数与结果对象,支持命名依赖等

下载
  • Scan() 入参 value 可能是 nil、[]byte、string,必须做类型断言和长度判断
  • Value() 返回前建议检查零值,避免传 nil 给 json.Marshal 导致 panic
  • 字段 tag 中必须显式写 gorm:"type:text"(MySQL)或 gorm:"type:jsonb"(PostgreSQL),不能依赖 serializer:json —— 后者会绕过你的 Scan/Value 逻辑

示例片段:

type AvatarListJSON []int

func (al *AvatarListJSON) Scan(value interface{}) error {
    if value == nil {
        *al = []int{}
        return nil
    }
    bytes, ok := value.([]byte)
    if !ok {
        return fmt.Errorf("cannot scan %T into AvatarListJSON", value)
    }
    if len(bytes) == 0 {
        *al = []int{}
        return nil
    }
    var temp []int
    if err := json.Unmarshal(bytes, &temp); err != nil {
        return err
    }
    *al = AvatarListJSON(temp)
    return nil
}

func (al AvatarListJSON) Value() (driver.Value, error) {
    if len(al) == 0 {
        return []byte("[]"), nil
    }
    return json.Marshal(al)
}

GORM v2+ 中 serializer:json 和自定义 Scan/Value 的冲突点

很多人图省事,在字段上加 gorm:"serializer:json",以为就能自动处理结构体或切片。但这个机制和手写的 Scan/Value 是互斥的:

  • 一旦用了 serializer:json,GORM 就不再调用你实现的 Scan/Value 方法
  • 它会用自己的 JSON 编解码器,且不支持自定义行为(比如加密、字段过滤、兼容旧数据格式)
  • 如果你的类型需要特殊反序列化逻辑(例如兼容字符串型数字 ID),serializer:json 会直接失败

所以真实项目中,只要逻辑稍复杂(如字段名映射不一致、需 fallback 处理、含 time.Time 子字段),就该关掉 serializer,老老实实写 Scan/Value,并在 tag 中明确指定 type: 和是否 not null。

容易被忽略的底层细节

最常踩的坑不在逻辑,而在内存和类型安全:

  • Scan() 接收的 []byte 是数据库驱动临时分配的,不能直接保存指针,必须拷贝或反序列化到新变量
  • Value() 返回 string 没问题,但返回 []byte 时要注意:某些驱动(如 pq)要求不可变,改了可能引发并发读写冲突
  • 如果类型嵌套了 time.Time 或指针字段,json.Unmarshal 默认不会初始化 nil 指针,得靠 json.RawMessage 或自定义 UnmarshalJSON 配合处理

这些不是“写了就能跑”,而是“写了之后某天线上突然 panic”的那种点。

golang免费学习笔记(深入):立即使用
在学习笔记中,你将探索golang的核心概念和高级技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

golang go语言 go语言gorm

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

3389

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2368

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1320

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1258

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1396

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

2258

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3680

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

17055

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

549

3

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程