XORM框架忽略某些字段怎么配置?字段排除规则

胖枫同学_7355

胖枫同学_7355

2026-11-20

764人浏览

原创

xorm 框架通过结构体标签 `xorm:"-"` 来忽略字段,配置方法是在需要排除的字段后添加该标签。这样 xorm 在生成 sql 语句时会自动跳过这些列,不会进行映射、查询或更新操作。

XORM框架忽略某些字段怎么配置?字段排除规则

如何配置单个字段被忽略

在 Go 结构体定义中,直接在目标字段后追加 `xorm:"-"` 即可实现忽略。例如,若有一个名为 `SecretData` 的敏感字段,只需将其定义为 `SecretData string \`xorm:"-"\``。XORM 引擎在初始化模型时会解析这些标签,并将标记为 `-` 的字段从元数据中移除,从而确保后续所有 CRUD 操作都不涉及该字段。

XORM框架忽略某些字段怎么配置?字段排除规则

package main

import (
    "fmt"
    _ "github.com/go-sql-driver/mysql"
    "xorm.io/xorm"
)

type User struct {
    ID       int64  
    Name     string 
    Password string `xorm:"-"`
}

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

    // 创建表
    err = engine.Sync2(new(User))
    if err != nil {
        fmt.Println("Sync error:", err)
        return
    }

    // 插入数据
    user := &User{Name: "test", Password: "secret123"}
    _, err = engine.Insert(user)
    if err != nil {
        fmt.Println("Insert error:", err)
        return
    }

    // 查询数据
    var u User
    has, err := engine.ID(1).Get(&u)
    if err != nil {
        fmt.Println("Get error:", err)
        return
    }
    if has {
        fmt.Printf("ID: %d, Name: %s, Password: %s\n", u.ID, u.Name, u.Password)
    }
}

运行上述代码,数据库表中只会存在 `id` 和 `name` 两列。插入时 `Password` 不会被写入,查询时 `u.Password` 将保持零值(空字符串),因为 XORM 根本不知道这个列的存在。

批量忽略特定类型字段

如果希望忽略所有非数据库字段或特定前缀的字段,可以结合 XORM 的 `IgnoreCols` 方法或在结构体中使用更复杂的标签策略。但最常用且推荐的方式仍是显式标注。对于大量字段,可以使用 `xorm:"not null"` 等正常标签配合业务逻辑过滤,或者在查询时使用 `Cols` 明确指定只查询需要的列,但这不改变结构体映射关系。若要完全忽略某些计算字段,同样使用 `xorm:"-"`。此外,XORM 还支持 `xorm:"unique"`、`xorm:"index"` 等标签,它们与 `-` 互斥,一旦使用 `-`,其他属性标签将被忽略。

XORM框架 1.3.10
XORM框架 1.3.10

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

下载

XORM框架忽略某些字段怎么配置?字段排除规则

package main

import (
    "fmt"
    _ "github.com/go-sql-driver/mysql"
    "xorm.io/xorm"
)

type Product struct {
    ID          int64  
    Title       string 
    Description string `xorm:"text"`
    InternalID  int64  `xorm:"-"`
    TempFlag    bool   `xorm:"-"`
}

func main() {
    engine, _ := xorm.NewEngine("mysql", "user:pass@tcp(127.0.0.1:3306)/db")
    defer engine.Close()

    // 同步结构体到数据库
    engine.Sync2(new(Product))

    // 插入包含忽略字段的数据
    p := &Product{
        Title:       "Laptop",
        Description: "A powerful laptop",
        InternalID:  999,
        TempFlag:    true,
    }
    
    _, err := engine.Insert(p)
    if err != nil {
        fmt.Println("Error:", err)
        return
    }

    // 验证:查询结果中 InternalID 和 TempFlag 应为零值
    var result Product
    engine.Table("product").Where("title = ?", "Laptop").Get(&result)
    fmt.Printf("Result: ID=%d, Title=%s, Desc=%s, IntID=%d, Flag=%v\n",
        result.ID, result.Title, result.Description, result.InternalID, result.TempFlag)
}

此示例展示了多个字段被忽略的情况。`InternalID` 和 `TempFlag` 在结构体中存在,但在数据库操作中完全透明。查询返回的 `result` 对象中,这两个字段的值将是 Go 类型的零值(`0` 和 `false`),即使它们在内存中被赋值过。这确保了敏感或临时数据不会意外持久化或泄露。

忽略字段对更新操作的影响

当使用 `Update` 方法更新记录时,被 `xorm:"-"` 标记的字段同样不会被包含在生成的 UPDATE 语句中。这意味着即使你修改了结构体中这些字段的值并调用 Update,数据库中的对应列也不会发生变化。这对于处理只读字段或外部管理的字段非常有用。例如,一个由数据库触发器自动更新的 `created_at` 字段,如果不想在每次更新应用逻辑时覆盖它,可以将其标记为忽略,或者在 Update 时手动排除。但注意,如果字段在数据库中有默认值或非空约束,忽略它可能导致插入失败,除非提供了默认值或允许 NULL。因此,忽略字段时应确保其不在 INSERT 语句中出现,或者数据库有合适的默认机制。

相关文章

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

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

下载

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

相关专题

更多
Golang Beego框架
Golang Beego框架

本专题聚焦 Golang 全栈式 Web 框架 Beego 的学习与实战,内容涵盖 MVC 模式、路由控制、ORM 数据库操作、模块化开发、日志管理与 RESTful API 构建。通过企业管理系统、电商后端与微服务架构等实战案例,帮助学员掌握使用 Beego 高效开发企业级应用的核心能力。

2025.08.27

4440

8

go语言 beego框架
go语言 beego框架

本专题整合了go语言中beego框架相关内容,阅读专题下的文章了解更多详细内容。

2025.09.10

8481

12

Nginx CVE-2026-123007排查与防护指南
Nginx CVE-2026-123007排查与防护指南

Nginx HTTP/2漏洞该怎么修复?本专题围绕CVE-2026-123007,介绍安全版本升级、模块兼容检查和配置恢复方法,以及日志排查、权限设置等后续加固操作,方便你按实际部署情况查找对应教程。

2026.11.20

0

8

GoFrame框架Web开发与路由中间件
GoFrame框架Web开发与路由中间件

本专题聚焦GoFrame框架的Web开发,拆解路由注册与匹配规则、请求参数获取、参数校验与中间件执行顺序,说明统一响应、JWT鉴权、文件上传与接口文档生成的落地方式,并补充优雅重启与测试实践。

2026.11.17

20

15

GoFrame框架安装与gf命令行工具
GoFrame框架安装与gf命令行工具

本专题围绕GoFrame框架的安装与工具链配置展开,讲清Go版本要求、gf命令行的安装方式、代理镜像与依赖准备,说明项目初始化、热编译、交叉编译打包的做法,并整理安装阶段的常见报错与验证步骤。

2026.11.17

60

15

GoFrame框架零基础入门
GoFrame框架零基础入门

本专题整理GoFrame框架的入门知识,从模块化设计理念、环境准备到跑通第一个Web服务,讲清目录分层、配置加载、日志与中间件的用法,并对比Gin、Go-Zero的差异,帮助Go开发者建立整体认知。

2026.11.17

80

15

SQLAlchemy 一对多关系怎么建立
SQLAlchemy 一对多关系怎么建立

SQLAlchemy 一对多关系怎么建立?本专题整理父子表外键、relationship 双向映射、关联查询、级联删除和加载优化等相关文章,帮助你理解并实现常见的 ORM 关系建模。

2026.11.17

20

10

SQLAlchemy 如何增删改查
SQLAlchemy 如何增删改查

SQLAlchemy 如何增删改查?本专题整理 ORM 新增记录、条件查询、更新和删除、Session 事务提交与批量处理等实用文章,帮助你掌握 Python 数据库操作流程。

2026.11.17

80

11

SQLAlchemy ORM 模型怎么写
SQLAlchemy ORM 模型怎么写

SQLAlchemy ORM 模型怎么写?本专题整理模型类定义、Mapped 字段映射、主键与约束、表结构创建和常见报错的相关文章,帮助你从基础配置到实际建模逐步掌握 SQLAlchemy。

2026.11.17

40

16

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

共0课时 | 0人学习