XORM框架软删除字段的配置方式

梦杰君_5954

梦杰君_5954

2026-11-22

635人浏览

原创

xorm框架中配置软删除字段的核心做法是:在结构体标签中使用`xorm:"soft_delete"`标记字段,并配合`settablemapper`或全局配置启用软删除功能。具体实现时,需确保该字段类型为`time.time`或`int64`,并在查询时通过`where("deleted_at is null")`或调用`find`/`get`等默认行为自动过滤已删除记录。若使用`softdeletetag`自定义标签名,需在初始化引擎后设置`engine.setsoftdeletetag("custom_tag")`。

XORM框架软删除字段的配置方式

如何定义支持软删除的结构体字段

在XORM中,只需在结构体字段上添加`xorm:"soft_delete"`标签即可启用软删除。该字段通常命名为`DeletedAt`或`IsDeleted`,类型建议为`time.Time`(表示删除时间)或`bool`/`int8`(表示状态)。当执行`Update`操作时,XORM会自动将该字段设置为当前时间或特定值,而非物理删除数据。

XORM框架软删除字段的配置方式

package main

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

type User struct {
    ID        int64     `xorm:"pk autoincr"`
    Name      string    `xorm:"varchar(50) notnull"`
    DeletedAt *time.Time `xorm:"soft_delete"`
}

func main() {
    engine, err := xorm.NewEngine("mysql", "user:password@tcp(127.0.0.1:3306)/dbname")
    if err != nil {
        panic(err)
    }
    // 启用软删除功能
    engine.SetTableMapper(xorm.SnakeMapper{})
    
    // 创建表
    engine.Sync2(&User{})
    
    // 插入测试数据
    user := &User{Name: "Alice"}
    engine.Insert(user)
    fmt.Printf("Inserted ID: %d\n", user.ID)
    
    // 软删除
    _, err = engine.Id(user.ID).Cols("deleted_at").Update(&User{DeletedAt: time.Now()})
    if err != nil {
        panic(err)
    }
    
    // 验证:正常查询应返回空
    var users []User
    err = engine.Find(&users)
    if err != nil {
        panic(err)
    }
    fmt.Printf("Found users after soft delete: %d\n", len(users))
}

上述代码演示了基本流程:定义结构体、初始化引擎、同步表结构、插入数据、执行软删除更新,最后验证查询结果。注意`DeletedAt`指针类型允许区分“未删除”和“已删除”状态。

如何自定义软删除标签与查询行为

若希望使用非默认的标签名(如`is_deleted`),可通过`engine.SetSoftDeleteTag("is_deleted")`进行配置。此外,可结合`Where`条件手动控制是否包含已删除记录。例如,使用`engine.Where("is_deleted = 0").Find()`仅获取未删除数据,或使用`engine.Cols("id", "name", "is_deleted").Find()`显式指定列。

XORM框架 1.3.10
XORM框架 1.3.10

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

下载

XORM框架软删除字段的配置方式

package main

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

type Product struct {
    ID          int64  `xorm:"pk autoincr"`
    Title       string `xorm:"varchar(100) notnull"`
    IsDeleted   int8   `xorm:"is_deleted"`
}

func main() {
    engine, _ := xorm.NewEngine("mysql", "user:pass@tcp(127.0.0.1:3306/test")
    engine.SetSoftDeleteTag("is_deleted")
    engine.Sync2(&Product{})
    
    prod := &Product{Title: "Laptop"}
    engine.Insert(prod)
    
    // 软删除:将 is_deleted 设为 1
    engine.Id(prod.ID).Cols("is_deleted").Update(&Product{IsDeleted: 1})
    
    // 查询所有产品(包括已删除)
    var allProducts []Product
    engine.Find(&allProducts)
    fmt.Printf("All products: %d\n", len(allProducts))
    
    // 仅查询未删除产品
    var activeProducts []Product
    engine.Where("is_deleted = 0").Find(&activeProducts)
    fmt.Printf("Active products: %d\n", len(activeProducts))
}

此示例展示了自定义标签`is_deleted`的使用方式。通过`SetSoftDeleteTag`注册标签后,XORM在内部处理软删除逻辑时会识别该字段。查询时若不加`Where`条件,默认会排除`is_deleted != 0`的记录;若需查看历史数据,则需显式查询。

软删除字段为nil时如何处理查询冲突

当软删除字段为`*time.Time`且值为`nil`时,XORM默认将其视为“未删除”。但在某些场景下,若数据库中存在`NULL`值,而应用层期望其等同于“未删除”,需确保查询条件正确匹配。例如,使用`Where("deleted_at IS NULL OR deleted_at > ?", time.Now())`可避免误删未来时间的记录。此外,若使用`int8`类型,`0`代表未删除,`1`代表已删除,查询时应严格比较数值。

相关文章

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

4500

8

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

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

2025.09.10

8561

12

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环境请

2026.11.22

0

11

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

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

2026.11.20

20

7

Navicat入门教程大全
Navicat入门教程大全

本专题整理Navicat入门教程,从认识软件界面到开展数据库操作,介绍初次使用需要了解的知识和方法。内容兼顾连接配置、数据管理及日常使用中的疑问,方便用户按学习进度查阅,为后续实践和独立操作打好基础。

2026.11.20

20

17

Navicat数据库连接配置指南
Navicat数据库连接配置指南

从确认数据库信息到建立可用连接,本专题串联Navicat连接数据库的相关知识和操作方法。既有初次配置时需要了解的基础内容,也有连接后的检查思路,方便用户按实际需求查阅教程,逐步熟悉数据库连接的设置流程。

2026.11.20

0

10

PHP8.6数组与数据处理教程
PHP8.6数组与数据处理教程

本专题汇总PHP8.6数组与数据处理教程,涵盖CSV读取和导出、引用遍历删除、array_filter回调模式、配置键名冲突、pathinfo文件名校验、GMP大整数进制转换及UTF-8正则筛选,说明升级兼容变化、输入范围和失败处理方法。

2026.11.20

60

8

PHP8.6升级迁移教程
PHP8.6升级迁移教程

本专题汇总PHP8.6升级迁移与弃用接口改造教程,涵盖反射调用、对象属性赋值、标识符更名、构造函数与__debugInfo调整,以及插件类名检查、常量导出、ArrayIterator排序、SPL和DTO查询参数转换,帮助梳理弃用提示并完成代码兼容改造。

2026.11.20

0

10

PHP8.6安装配置与FPM运维教程
PHP8.6安装配置与FPM运维教程

本专题汇总PHP8.6正式版安装部署与FPM运维教程,涵盖Linux并存安装、独立ini配置、扩展重新编译、Nginx切换与回滚、FPM状态监控和慢日志排查,以及环境变量、请求超时、OPcache刷新和预加载配置。

2026.11.20

40

10

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

共0课时 | 0人学习