xorm 框架通过结构体标签 `xorm` 实现 go 结构体字段与数据库表字段的映射,核心做法是在结构体字段后添加 `xorm:"column_name"` 标签指定列名,使用 `xorm:"autoincr"` 处理自增主键,利用 `xorm:"created"`、`xorm:"updated"` 等时间戳标签自动填充创建和更新时间。若省略列名标签,xorm 默认将结构体字段名转为蛇形命名(snake_case)作为列名;若结构体包含名为 `id` 或 `id` 的字段且无其他主键标签,它会被自动识别为主键。

如何定义带自增主键和时间戳的结构体
在 XORM 中,定义包含自增主键和自动时间戳的结构体,只需在对应字段上添加特定的 `xorm` 标签即可。主键字段通常命名为 `Id` 并标记为 `autoincr`,创建时间字段标记为 `created`,更新时间字段标记为 `updated`。这样在插入数据时,无需手动设置这些字段,XORM 会自动处理。

package main
import (
"fmt"
"time"
"xorm.io/xorm"
_ "github.com/go-sql-driver/mysql"
)
type User struct {
Id int64 `xorm:"autoincr"`
Name string `xorm:"varchar(100) not null"`
Email string `xorm:"varchar(255) unique"`
CreatedAt time.Time `xorm:"created"`
UpdatedAt time.Time `xorm:"updated"`
}
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 {
panic(err)
}
// 插入数据示例
user := &User{
Name: "John Doe",
Email: "john@example.com",
}
_, err = engine.Insert(user)
if err != nil {
panic(err)
}
fmt.Printf("Inserted User: %+v\n", user)
}
如何处理非标准命名或特殊类型的字段映射
对于不符合蛇形命名规则的字段,或者需要自定义列类型、长度、索引的字段,必须在 `xorm` 标签中显式指定列名和属性。例如,使用 `xorm:"column_name type(length) index"` 格式来精确控制数据库列的定义。此外,对于布尔值、JSON 文本等特殊类型,可以通过标签或引擎配置来处理映射。

package main
import (
"encoding/json"
"fmt"
"xorm.io/xorm"
_ "github.com/go-sql-driver/mysql"
)
type Product struct {
ID int64 `xorm:"pk autoincr"`
SKU string `xorm:"varchar(50) unique index"`
Description string `xorm:"text"`
IsAvailable bool `xorm:"tinyint(1) default 1"`
Metadata map[string]string `xorm:"json"`
}
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(Product))
if err != nil {
panic(err)
}
product := &Product{
SKU: "PROD-001",
Description: "A sample product",
IsAvailable: true,
Metadata: map[string]string{"color": "red", "size": "L"},
}
_, err = engine.Insert(product)
if err != nil {
panic(err)
}
fmt.Printf("Inserted Product: %+v\n", product)
}
当结构体字段名与数据库列名不一致时如何映射
当结构体字段名与数据库列名不一致时,必须使用 `xorm:"actual_column_name"` 标签进行显式映射。如果不加标签,XORM 会尝试将结构体字段名转换为蛇形命名作为列名,这可能导致映射错误。显式指定列名可以确保结构体字段与数据库列的正确对应,无论命名风格如何差异。


















