XORM框架自定义类型怎么存?Scanner与Valuer实现

雨强小哥_3643

雨强小哥_3643

2026-11-04

747人浏览

原创

XORM中存储JSON等非原生类型必须同时实现sql.Scanner和driver.Valuer接口,Scanner负责反序列化读取,Valuer负责序列化写入,缺一不可;未实现二者时字段被跳过。

xorm框架自定义类型怎么存?scanner与valuer实现 - php中文网

在XORM中存储JSON、数组等非原生数据库类型时,必须让Go结构体字段实现sql.Scanner和driver.Valuer接口,否则XORM无法自动完成入库与查出的类型转换,直接报错或存空值。

为什么必须同时实现Scanner和Valuer

Scanner负责从数据库读取原始字节(如[]byte)并反序列化为Go结构体;Valuer负责把Go结构体序列化为数据库可存的格式(通常是[]byte或string)。缺一不可——只实现Scan会导致插入失败,只实现Value会导致查询返回零值。

这一步是硬性前提,【未同时实现两个接口的类型,XORM会跳过该字段,不写入也不读取】。

定义带JSON字段的结构体

先声明一个含JSON数据的结构体,例如用户偏好设置:

type UserPreference struct {
  ID     int64  `xorm:"pk autoincr"`
  UserID int64  `xorm:"index"`
  Data   []byte `xorm:"json"`
}

注意:这里暂用[]byte占位,实际要用自定义类型封装逻辑。XORM的xorm:"json"标签仅对内置json.RawMessage或实现了Scanner/Valuer的类型生效,不能直接套在普通切片上。

方法一:为结构体实现Scanner与Valuer

定义一个新类型包装JSON数据:

type Preference struct {
  Likes  []string `json:"likes"`
  Theme  string   `json:"theme"`
  Notify bool     `json:"notify"`
}

然后为*Preference实现Scan,为Preference实现Value:

func (p *Preference) Scan(value interface{}) error {
  if value == nil { return nil }
  bytes, ok := value.([]byte)
  if !ok { return fmt.Errorf("cannot scan %T into Preference", value) }
  return json.Unmarshal(bytes, p)
}

func (p Preference) Value() (driver.Value, error) {
  return json.Marshal(p)
}

关键点:Scan必须接收指针接收者(*Preference),否则无法修改原值;Value必须是值接收者(Preference),否则XORM调用时可能panic。

方法二:为基础类型实现(如uint8枚举)

适用于状态码、类型标识等小整数映射:

type Status uint8
const (
  StatusActive Status = iota
  StatusInactive
  StatusPending
)

func (s *Status) Scan(value interface{}) error {
  if value == nil { return nil }
  switch v := value.(type) {
  case int64: *s = Status(v)
  case []byte: i, _ := strconv.ParseUint(string(v), 10, 8); *s = Status(i)
  default: return fmt.Errorf("cannot scan %T into Status", value)
  }
  return nil
}

XORM框架 1.3.10
XORM框架 1.3.10

XORM框架 1.3.10版本源码包下载,包含 PostgreSQL 字段同步、GBase8s 与 libSQL 驱动、Oracle 日期和 MSSQL 分页修复。

下载

func (s Status) Value() (driver.Value, error) {
  return int64(s), nil
}

这个实现兼容MySQL中TINYINT字段,避免了字符串存储带来的索引失效问题。

注册自定义类型到XORM引擎

完成接口实现后,必须在初始化XORM Engine后显式注册类型映射,否则XORM仍按默认规则处理:

engine.RegisterDialect(&mymysql.Dialect{}) // 或其他dialect
engine.RegisterModel(new(User))

接着调用:

engine.MapType(reflect.TypeOf(Preference{}), "text")

其中"text"表示该类型在MySQL中对应TEXT字段;若用PostgreSQL,可填"jsonb"。这一步告诉XORM:“遇到Preference类型,就用TEXT列来存”。【不调用MapType,XORM会尝试用VARCHAR(255)存,超长直接截断】。

使用自定义类型建表与写入

第一步:确保结构体字段使用自定义类型而非基础类型

type User struct {
  ID        int64       `xorm:"pk autoincr"`
  Name      string      `xorm:"varchar(50)"`
  Pref      Preference  `xorm:"json"`
}

第二步:执行Sync2自动建表

err := engine.Sync2(new(User))

第三步:插入数据

u := &User{
  Name: "Alice",
  Pref: Preference{
    Likes:  []string{"go", "xorm"},
    Theme:  "dark",
    Notify: true,
  }
}
_, err = engine.Insert(u)

此时XORM会调用Pref.Value()得到JSON字节流,写入TEXT字段;查询时自动触发Pref.Scan()还原结构体。

相关文章

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

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

下载

相关标签:

xorm xorm框架

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

相关专题

更多
Golang 入门学习路线:从零基础到上手开发
Golang 入门学习路线:从零基础到上手开发

Golang 入门路线涵盖从零到上手的核心路径:首先打牢基础语法与切片等底层机制;随后攻克 Go 的灵魂——接口设计与 Goroutine 并发模型;接着通过 Gin 框架与 GORM 深入 Web 开发实战;最后在微服务与云原生工具开发中进阶,旨在培养具备高性能并发处理能力的后端工程师。

2026.02.24

246

7

Golang 疑难杂症解决指南:常见问题排查与优化
Golang 疑难杂症解决指南:常见问题排查与优化

《Golang 疑难杂症解决指南》聚焦开发过程中常见却棘手的问题,从并发模型、内存管理、性能瓶颈到工程化实践逐步拆解。通过真实案例与调试思路,帮助开发者定位问题根因,建立系统化排查方法。不只给出答案,更强调分析路径与工具使用,让你在复杂 Go 项目中具备持续解决问题的能力。

2026.02.24

133

7

Golang 运行与部署实战:从本地到云端
Golang 运行与部署实战:从本地到云端

《Golang 运行与部署实战》围绕 Go 应用从开发完成到稳定上线的完整流程展开,系统讲解编译构建、环境配置、日志与配置管理、容器化部署以及常见运维问题处理。结合真实项目场景,拆解自动化构建与持续部署思路,帮助开发者建立可靠的发布流程,提升服务稳定性与可维护性。

2026.02.24

677

10

Golang 面试题精选:高频问题与解答
Golang 面试题精选:高频问题与解答

Golang 面试题精选》系统整理企业常见 Go 技术面试问题,覆盖语言基础、并发模型、内存与调度机制、网络编程、工程实践与性能优化等核心知识点。每道题不仅给出答案,还拆解背后的设计原理与考察思路,帮助读者建立完整知识结构,在面试与实际开发中都能更从容应对复杂问题。

2026.02.24

238

7

Golang 性能优化专题:提升应用效率
Golang 性能优化专题:提升应用效率

《Golang 性能优化专题》聚焦 Go 应用在高并发与大规模服务中的性能问题,从 profiling、内存分配、Goroutine 调度、GC 机制到 I/O 与锁竞争逐层分析。结合真实案例讲解定位瓶颈的方法与优化策略,帮助开发者建立系统化性能调优思维,在保证代码可维护性的同时显著提升服务吞吐与稳定性。

2026.02.24

497

7

Golang 生态工具与框架:扩展开发能力
Golang 生态工具与框架:扩展开发能力

《Golang 生态工具与框架》系统梳理 Go 语言在实际工程中的主流工具链与框架选型思路,涵盖 Web 框架、RPC 通信、依赖管理、测试工具、代码生成与项目结构设计等内容。通过真实项目场景解析不同工具的适用边界与组合方式,帮助开发者构建高效、可维护的 Go 工程体系,并提升团队协作与交付效率。

2026.02.24

228

7

Golang 并发编程专题:掌握多核时代的核心技能
Golang 并发编程专题:掌握多核时代的核心技能

《Golang 并发编程专题:掌握多核时代的核心技能》系统讲解 Go 在并发领域的设计哲学与实践方法,深入剖析 goroutine、channel、调度模型与并发安全机制,结合真实场景与性能思维,帮助开发者构建高吞吐、低延迟、可扩展的并发程序,全面提升多核时代的工程能力。

2026.02.26

604

7

Golang Web 开发路线:构建高效后端服务
Golang Web 开发路线:构建高效后端服务

《Golang Web 开发路线:构建高效后端服务》围绕 Go 在后端领域的工程实践,系统讲解 Web 框架选型、路由设计、中间件机制、数据库访问与接口规范,结合高并发与可维护性思维,逐步构建稳定、高性能、易扩展的后端服务体系,帮助开发者形成完整的 Go Web 架构能力。

2026.02.26

245

7

Golang 实际项目案例:从需求到上线
Golang 实际项目案例:从需求到上线

《Golang 实际项目案例:从需求到上线》以真实业务场景为主线,完整覆盖需求分析、架构设计、模块拆分、编码实现、性能优化与部署上线全过程,强调工程规范与实践决策,帮助开发者打通从技术实现到系统交付的关键路径,提升独立完成 Go 项目的综合能力。

2026.02.26

62

7

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
XORM框架事务处理手册
XORM框架事务处理手册

共0课时 | 0人学习

XORM框架官方中文文档
XORM框架官方中文文档

共0课时 | 0人学习

Go-zero与XORM网盘项目实战
Go-zero与XORM网盘项目实战

共0课时 | 0人学习