讲师中心 微信公众号

工具推荐

视频效率加速
剧云
剧云

中文短剧剧本制作平台

updream

一键生成高质量推广成片

立刻MV
立刻MV

低成本歌曲 MV、视频生成

AniShort
AniShort

AI短剧协同制作平台

XORM框架JSON字段怎么映射?结构体处理方法

雨墨小哥_7435

雨墨小哥_7435

发布时间:2026-11-22 12:14:32

|

179人浏览过

|

来源于php中文网

原创

XORM框架JSON字段怎么映射?结构体处理方法

在xorm中,处理json字段最直接的方法是使用`sql.nullstring`或自定义类型实现`driver.valuer`和`sql.scanner`接口。对于go 1.13+版本,推荐使用`json.rawmessage`配合自定义类型,或者直接使用支持json序列化的第三方库如`github.com/guregu/null`。核心思路是将json字符串的存储与解析逻辑封装在结构体字段的类型定义中,确保xorm在读写数据库时自动调用序列化/反序列化方法。

XORM框架JSON字段怎么映射?结构体处理方法

使用NullString处理可空JSON字段

当JSON字段允许为NULL时,应使用`sql.NullString`作为基础类型,并扩展其方法以支持JSON解析。这种方法简单可靠,适用于大多数场景。通过实现`Value()`和`Scan()`接口,可以在数据库交互时自动处理JSON编码和解码。

XORM框架JSON字段怎么映射?结构体处理方法

Exa JS Web Search SDK 用于 AI 应用程序
Exa JS Web Search SDK 用于 AI 应用程序

exa-js 是 Exa 官方 JavaScript 软件开发工具包,Exa 是一个为 AI 工作流构建的网络搜索 API。它为代理提供了一种具体的方式来搜索网络、检索页面内容,并从代码中生成有来源的答案,而不是手动拼接原始 HTTP 调用。

下载
package main

import (
	"database/sql"
	"encoding/json"
	"fmt"
	"log"

	"xorm.io/xorm"
)

// NullJSON 扩展 sql.NullString 以支持 JSON 解析
type NullJSON struct {
	sql.NullString
}

// Scan 实现 sql.Scanner 接口
func (n *NullJSON) Scan(value interface{}) error {
	if value == nil {
		n.NullString.Valid = false
		return nil
	}
	n.NullString.String = string(value.([]byte))
	n.NullString.Valid = true
	return nil
}

// Value 实现 driver.Valuer 接口
func (n NullJSON) Value() (interface{}, error) {
	if !n.NullString.Valid {
		return nil, nil
	}
	return n.NullString.String, nil
}

// Unmarshal 将 JSON 字符串解析为目标结构体
func (n NullJSON) Unmarshal(v interface{}) error {
	if !n.NullString.Valid {
		return fmt.Errorf("null json")
	}
	return json.Unmarshal([]byte(n.NullString.String), v)
}

// Marshal 将结构体序列化为 JSON 字符串
func (n *NullJSON) Marshal(v interface{}) error {
	data, err := json.Marshal(v)
	if err != nil {
		return err
	}
	n.NullString.String = string(data)
	n.NullString.Valid = true
	return nil
}

// User 示例结构体
type User struct {
	ID   int64  `xorm:"id autoincr"`
	Name string `xorm:"name"`
	Data NullJSON `xorm:"data json"`
}

func main() {
	engine, err := xorm.NewEngine("mysql", "user:password@tcp(127.0.0.1:3306)/dbname")
	if err != nil {
		log.Fatal(err)
	}
	defer engine.Close()

	// 创建表
	err = engine.Sync2(new(User))
	if err != nil {
		log.Fatal(err)
	}

	// 插入数据
	user := &User{
		Name: "test",
	}
	jsonData := map[string]string{"key": "value"}
	err = user.Data.Marshal(jsonData)
	if err != nil {
		log.Fatal(err)
	}

	_, err = engine.Insert(user)
	if err != nil {
		log.Fatal(err)
	}

	// 查询数据
	var u User
	has, err := engine.ID(1).Get(&u)
	if err != nil {
		log.Fatal(err)
	}
	if has {
		var parsedData map[string]string
		err = u.Data.Unmarshal(&parsedData)
		if err != nil {
			log.Fatal(err)
		}
		fmt.Printf("Parsed Data: %v\n", parsedData)
	}
}

使用RawMessage处理非空JSON字段

对于不允许为NULL的JSON字段,可以使用`json.RawMessage`作为基础类型。这种方式更简洁,因为`json.RawMessage`本身已经实现了`driver.Valuer`和`sql.Scanner`接口,只需额外提供解析和序列化方法即可。

XORM框架JSON字段怎么映射?结构体处理方法

package main

import (
	"encoding/json"
	"fmt"
	"log"

	"xorm.io/xorm"
)

// RawJSON 基于 json.RawMessage 扩展
type RawJSON json.RawMessage

// Scan 实现 sql.Scanner 接口
func (r *RawJSON) Scan(value interface{}) error {
	if value == nil {
		*r = nil
		return nil
	}
	bytes, ok := value.([]byte)
	if !ok {
		return fmt.Errorf("expected []byte, got %T", value)
	}
	*r = append((*r)[0:0], bytes...)
	return nil
}

// Value 实现 driver.Valuer 接口
func (r RawJSON) Value() (interface{}, error) {
	if len(r) == 0 {
		return "{}", nil // 默认返回空对象
	}
	return string(r), nil
}

// Unmarshal 将 JSON 解析为目标结构体
func (r RawJSON) Unmarshal(v interface{}) error {
	return json.Unmarshal([]byte(r), v)
}

// Marshal 将结构体序列化为 JSON
func (r *RawJSON) Marshal(v interface{}) error {
	data, err := json.Marshal(v)
	if err != nil {
		return err
	}
	*r = append((*r)[0:0], data...)
	return nil
}

// Product 示例结构体
type Product struct {
	ID       int64  `xorm:"id autoincr"`
	Name     string `xorm:"name"`
	Metadata RawJSON `xorm:"metadata json"`
}

func main() {
	engine, err := xorm.NewEngine("mysql", "user:password@tcp(127.0.0.1:3306)/dbname")
	if err != nil {
		log.Fatal(err)
	}
	defer engine.Close()

	// 创建表
	err = engine.Sync2(new(Product))
	if err != nil {
		log.Fatal(err)
	}

	// 插入数据
	product := &Product{
		Name: "example",
	}
	metaData := map[string]interface{}{"price": 100, "currency": "USD"}
	err = product.Metadata.Marshal(metaData)
	if err != nil {
		log.Fatal(err)
	}

	_, err = engine.Insert(product)
	if err != nil {
		log.Fatal(err)
	}

	// 查询数据
	var p Product
	has, err := engine.ID(1).Get(&p)
	if err != nil {
		log.Fatal(err)
	}
	if has {
		var parsedMeta map[string]interface{}
		err = p.Metadata.Unmarshal(&parsedMeta)
		if err != nil {
			log.Fatal(err)
		}
		fmt.Printf("Parsed Metadata: %v\n", parsedMeta)
	}
}

如何处理JSON字段中的嵌套结构体

当JSON字段包含嵌套结构体时,需要确保自定义类型的`Unmarshal`和`Marshal`方法能够正确处理嵌套关系。例如,如果JSON字段是一个包含多个子对象的复杂结构,可以在`Unmarshal`方法中使用递归或嵌套的结构体指针来解析数据。

package main

import (
	"encoding/json"
	"fmt"
	"log"

	"xorm.io/xorm"
)

// NestedData 嵌套结构体
type NestedData struct {
	Level1 string      `json:"level1"`
	Level2 interface{} `json:"level2"`
}

// ComplexJSON 用于处理复杂JSON
type ComplexJSON struct {
	Data NestedData
}

// Scan 实现 sql.Scanner 接口
func (c *ComplexJSON) Scan(value interface{}) error {
	if value == nil {
		return nil
	}
	bytes, ok := value.([]byte)
	if !ok {
		return fmt.Errorf("expected []byte, got %T", value)
	}
	return json.Unmarshal(bytes, &c.Data)
}

// Value 实现 driver.Valuer 接口
func (c ComplexJSON) Value() (interface{}, error) {
	return json.Marshal(c.Data)
}

// Item 示例结构体
type Item struct {
	ID     int64        `xorm:"id autoincr"`
	Name   string       `xorm:"name"`
	Config ComplexJSON  `xorm:"config json"`
}

func main() {
	engine, err := xorm.NewEngine("mysql", "user:password@tcp(127.0.0.1:3306)/dbname")
	if err != nil {
		log.Fatal(err)
	}
	defer engine.Close()

	// 创建表
	err = engine.Sync2(new(Item))
	if err != nil {
		log.Fatal(err)
	}

	// 插入数据
	item := &Item{
		Name: "complex_item",
	}
	item.Config.Data.Level1 = "level1_value"
	item.Config.Data.Level2 = map[string]string{"key": "value"}

	_, err = engine.Insert(item)
	if err != nil {
		log.Fatal(err)
	}

	// 查询数据
	var i Item
	has, err := engine.ID(1).Get(&i)
	if err != nil {
		log.Fatal(err)
	}
	if has {
		fmt.Printf("Level1: %s\n", i.Config.Data.Level1)
		fmt.Printf("Level2: %v\n", i.Config.Data.Level2)
	}
}

热门AI工具

更多
DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

创客贴AI

创客贴AI是一款AI图像与设计工具,AI辅助的智能在线设计工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

讯飞智文

一款面向学习和办公场景的AI文档创作工具,可辅助生成PPT与Word文档,提高资料整理和内容制作效率。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

超级麦吉

一款通过数字员工协作完成调研、数据分析与文档制作的AI办公平台。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

相关专题

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

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

246

2026.02.24

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

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

153

2026.02.24

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

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

697

2026.02.24

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

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

258

2026.02.24

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

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

537

2026.02.24

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

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

248

2026.02.24

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

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

624

2026.02.26

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

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

265

2026.02.26

Navicat创建数据库教程
Navicat创建数据库教程

本专题整理Navicat创建数据库相关教程,介绍新建前的准备、基础设置和创建后的检查方法。内容兼顾入门学习及实际使用需求,帮助用户了解不同数据库类型下的操作差异,为后续建表、保存数据和日常管理提供参考。

20

2026.11.20

热门下载

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

精品课程

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

共101课时 | 21.5万人学习

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

共39课时 | 5万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn