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

如何定义支持软删除的结构体字段
在XORM中,只需在结构体字段上添加`xorm:"soft_delete"`标签即可启用软删除。该字段通常命名为`DeletedAt`或`IsDeleted`,类型建议为`time.Time`(表示删除时间)或`bool`/`int8`(表示状态)。当执行`Update`操作时,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()`显式指定列。

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`代表已删除,查询时应严格比较数值。











