XORM框架如何存JSON?定义字段类型与条件查询

风瑶姑娘_8436

风瑶姑娘_8436

2026-11-04

339人浏览

原创

正确存储查询XORM中JSON数据需区分字段类型、结构体类型与JSON序列化行为;推荐用string+“json”标签并手动序列化,或用json.RawMessage/自定义类型实现自动编解码,查询须用MySQL JSON函数而非点语法。

xorm框架如何存json?定义字段类型与条件查询 - php中文网

要在XORM中正确存储和查询JSON数据,必须明确区分数据库字段类型、Go结构体字段类型、JSON序列化行为三者之间的关系,否则会出现存入乱码、查询为空或类型断言失败等问题。

定义支持JSON的结构体字段

使用 string 类型配合 xorm:"json" 标签是最直接可靠的方式。

第一步:在结构体中声明字段为 string 类型,并添加 xorm:"json" 标签:

ExtraData string `xorm:"json" json:"extra_data"`

第二步:确保数据库对应列类型为 JSON(MySQL 5.7+)或 TEXT(兼容旧版或 SQLite);若用 Sync2 自动建表,XORM 会根据 xorm:"json" 推断为 TEXT,【不会自动创建 MySQL 原生 JSON 类型】。

第三步:插入前将 Go 值序列化为 JSON 字符串再赋值,例如:

user.ExtraData, _ = json.Marshal(map[string]interface{}{"status": "active", "tags": []string{"dev", "test"}})

这一步不可省略——XORM 不会自动调用 json.Marshal,它只负责把字段值原样写入数据库。如果直接赋一个 map,会触发 string(map) 转换,存进去的是类似 map[0xc000123456:0xc000789abc] 的内存地址乱码。

用 struct 字段替代 string 实现自动编解码

方法一:嵌套自定义 struct 并实现 driver.Valuer 和 sql.Scanner

定义一个可 JSON 编解码的类型:

type JSONMap map[string]interface{}

为它实现两个接口:

func (j JSONMap) Value() (driver.Value, error) { return json.Marshal(j) }

func (j *JSONMap) Scan(value interface{}) error { b, ok := value.([]byte); if !ok { return errors.New("type assertion to []byte failed") }; return json.Unmarshal(b, j) }

然后在结构体中使用:

Extra JSONMap `xorm:"json" json:"extra"`

XORM框架 1.3.10
XORM框架 1.3.10

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

下载

这样插入时直接赋值 user.Extra = JSONMap{"role": "admin"} 即可,XORM 会在写入前自动调用 Value(),读取时自动调用 Scan()。

方法二:直接使用 json.RawMessage(推荐用于未知结构 JSON)

Config json.RawMessage `xorm:"json" json:"config"`

它不解析内容,只做透传,避免中间转换开销和 panic 风险。赋值时用 json.RawMessage(data) 包装字节切片,适合配置类字段。

对 JSON 字段执行条件查询

MySQL 原生 JSON 类型支持 JSON_CONTAINS、JSON_EXTRACT 等函数,但 XORM 默认不提供封装,需手写 SQL 片段。

查询 JSON 数组中是否包含某个值(如 tags 包含 "prod"):

engine.Where("JSON_CONTAINS(extra_data, '\"prod\"', '$.tags')").Find(&users)

注意字符串中的双引号必须转义为 \",且路径表达式 '$.tags' 必须用单引号包裹,否则 MySQL 报语法错误。

查询 JSON 对象中某个键的值等于指定内容(如 status = "archived"):

engine.Where("JSON_UNQUOTE(JSON_EXTRACT(extra_data, '$.status')) = ?", "archived").Find(&users)

【不能直接用 engine.Where("extra_data.status = ?", "archived")】 —— 这是无效 SQL,XORM 不会解析 JSON 内部路径。

模糊匹配 JSON 字符串字段(当 JSON 列实际存为 TEXT):

engine.Where("extra_data LIKE ?", `%\"role\":%\"admin\"%`).Find(&users)

该方式依赖字符串匹配,性能差且易误判,仅作兜底,优先升级为原生 JSON 类型并用函数查询。

相关文章

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

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

下载

相关标签:

js json 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

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 21.3万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 4.9万人学习