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

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

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"` 等标签,它们与 `-` 互斥,一旦使用 `-`,其他属性标签将被忽略。

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 语句中出现,或者数据库有合适的默认机制。











