讲师中心 微信公众号

工具推荐

视频效率加速
updream

一键生成高质量推广成片

AniShort
AniShort

AI短剧协同制作平台

Laper
Laper

剧本策划到成片协作

立刻MV
立刻MV

低成本歌曲 MV、视频生成

XORM框架自定义数据类型的注册流程

大静大大_1010

大静大大_1010

发布时间:2026-11-22 16:23:06

|

100人浏览过

|

来源于php中文网

原创

xorm框架通过`engine.registertype()`方法注册自定义数据类型,调用时需传入自定义类型的实例和对应的sql驱动类型名称。执行该方法后,xorm在映射结构体字段时会自动识别该类型并应用指定的转换逻辑,从而支持如json、uuid等非标准数据库类型的持久化操作。

XORM框架自定义数据类型的注册流程

如何注册一个支持JSON序列化的自定义类型

注册JSON类型需要定义一个实现`sql.Scanner`和`driver.Valuer`接口的结构体,并通过`RegisterType`将其绑定到`database/sql`的`json.RawMessage`或类似类型上。这样在查询和插入时,XORM会委托给这些接口方法进行数据转换。

XORM框架自定义数据类型的注册流程

package main

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

    "github.com/xormplus/xorm"
    _ "github.com/go-sql-driver/mysql"
)

type JSONMap map[string]interface{}

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

func (j *JSONMap) Scan(value interface{}) error {
    bytes, ok := value.([]byte)
    if !ok {
        return fmt.Errorf("type assertion failed")
    }
    return json.Unmarshal(bytes, j)
}

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

    // 注册自定义类型:将 JSONMap 映射为 MySQL 的 TEXT 类型
    engine.RegisterType(JSONMap{}, "text")

    type User struct {
        ID   int64
        Data JSONMap `xorm:"varchar(500)"`
    }

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

    user := User{
        Data: JSONMap{"name": "Alice", "age": 30},
    }
    _, err = engine.Insert(&user)
    if err != nil {
        log.Fatal(err)
    }

    var result User
    has, err := engine.ID(1).Get(&result)
    if err != nil || !has {
        log.Fatal(err)
    }
    fmt.Printf("Retrieved Data: %v\n", result.Data)
}

上述代码定义了`JSONMap`结构体,实现了必要的接口,并在主程序中完成注册。运行后,`Data`字段会被正确序列化为JSON字符串存入数据库,读取时自动反序列化回`JSONMap`对象。

XORM框架 1.3.10
XORM框架 1.3.10

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

下载

如何处理UUID类型的存储与解析

处理UUID类型通常涉及将其转换为字符串格式进行存储。需要定义一个包含UUID值的结构体,实现`Value`方法返回字符串形式的UUID,以及`Scan`方法从数据库读取字符串并解析为UUID。注册时指定目标列类型为`char`或`varchar`。

XORM框架自定义数据类型的注册流程

package main

import (
    "database/sql/driver"
    "database/sql"
    "fmt"
    "log"
    "strings"

    "github.com/xormplus/xorm"
    _ "github.com/go-sql-driver/mysql"
)

type UUID string

func (u UUID) Value() (driver.Value, error) {
    return string(u), nil
}

func (u *UUID) Scan(value interface{}) error {
    if value == nil {
        *u = ""
        return nil
    }
    s, ok := value.([]byte)
    if !ok {
        return fmt.Errorf("type assertion failed")
    }
    *u = UUID(strings.TrimSpace(string(s)))
    return nil
}

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

    // 注册 UUID 类型为 char(36)
    engine.RegisterType(UUID{}, "char(36)")

    type Product struct {
        ID    int64
        Code  UUID `xorm:"unique"`
        Name  string
    }

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

    product := Product{
        Code: UUID("550e8400-e29b-41d4-a716-446655440000"),
        Name: "Widget",
    }
    _, err = engine.Insert(&product)
    if err != nil {
        log.Fatal(err)
    }

    var result Product
    has, err := engine.Where("code = ?", "550e8400-e29b-41d4-a716-446655440000").Get(&result)
    if err != nil || !has {
        log.Fatal(err)
    }
    fmt.Printf("Retrieved Product Code: %s\n", result.Code)
}

此示例展示了UUID类型的完整注册流程。通过`RegisterType`将`UUID`绑定到`char(36)`,确保数据库能正确处理其长度和唯一性约束。插入和查询操作均能透明地处理字符串与UUID之间的转换。

注册类型后引擎内部是如何匹配结构体字段的

当XORM执行`Sync2`或`Insert/Get`等操作时,它会遍历结构体的字段。对于每个字段,如果其类型是之前通过`RegisterType`注册过的自定义类型,XORM会优先使用注册的映射关系,而不是默认的反射推断。具体而言,引擎会检查字段类型是否与已注册的类型实例相等,若匹配则应用对应的SQL类型和转换逻辑。

热门AI工具

更多
VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

Flowith
Flowith Hot

Flowith是一款基于画布和智能体工作流的 AI 协作工作空间。

豆包大模型

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

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

DeepSeek

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

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

Loomy
Loomy Hot

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

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

WorkBuddy

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

相关专题

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

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

266

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

CVE-2026-114938高危漏洞修复
CVE-2026-114938高危漏洞修复

Java4Shell是OpenJDK Base64解码路径中的远程代码执行漏洞,编号CVE-2026-114938,2026年11月17日披露,官方已发布17.0.21.1、21.0.13.1等修复版本,建议优先升级 。本专题围绕Java4Shell(CVE-2026-114938)持续更新,从漏洞原理、受影响版本、受影响产品到修复与自查一站式汇总,适合Java开发、运维与安全人员快速定位风险。ARM64环境不受影响,x86-64环境请

0

2026.11.22

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

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