TableName() 方法如何自定义表名
在 xorm 中,可以通过实现 tablename() string 接口来为模型指定具体的数据库表名。当结构体实现了该方法时,xorm 将不再使用默认的复数化规则(如 user 变为 users),而是直接返回该方法指定的字符串作为表名。这允许开发者完全控制 sql 语句中的表名映射,适用于需要特定命名规范或兼容旧库名的场景。

package main
import (
"fmt"
"log"
"os"
"xorm.io/xorm"
)
type User struct {
ID int64
Name string
}
// TableName 自定义表名
func (u *User) TableName() string {
return "t_user_info"
}
func main() {
syncErr := xorm.NewSync()
syncErr.SetEngine(xorm.NewEngine("mysql", "root:root@/test?charset=utf8mb4"))
syncErr.Sync(&User{})
// 获取底层引擎并打印最后一条 SQL
e := syncErr.Engine()
lastSQL, _, _ := e.LastSQL()
fmt.Println(lastSQL)
}
运行上述代码,控制台输出的 SQL 语句中将包含 CREATE TABLE t_user_info,验证了 TableName 方法的优先级高于默认规则。
未实现 TableName 时的默认映射规则是什么
如果结构体没有实现 TableName 方法,XORM 会启用默认的表名生成策略。该策略首先将结构体名称转换为蛇形命名法(snake_case),然后自动添加前缀(默认为空)。例如,结构体 UserInfo 会被映射为 user_info。这一过程由 TableMapper 配置项控制,默认使用的是 tables.SnakeStr 函数,它负责处理大小写转换和下划线插入。

package main
import (
"fmt"
"strings"
"xorm.io/xorm"
"xorm.io/xorm/core"
)
type UserInfo struct {
ID int64
Name string
}
func main() {
engine, err := xorm.NewEngine("mysql", "root:root@/test?charset=utf8mb4")
if err != nil {
log.Fatal(err)
}
// 设置自定义的 TableMapper
engine.SetTableMapper(core.NewPrefixMapper(core.SnakeStr(), "prefix_"))
// 获取映射后的表名
tableName := engine.TableName(&UserInfo{})
fmt.Println(tableName)
}
执行该程序,输出结果为 prefix_user_info。这表明在默认蛇形转换的基础上,通过 SetTableMapper 可以全局注入前缀,而无需修改每个结构体的代码。
如何通过 TableMapper 统一添加表名前缀
除了针对单个结构体实现 TableName 外,更常见的做法是通过 engine.SetTableMapper 设置全局的表名映射器。XORM 提供了 core.NewPrefixMapper 工具函数,它可以包装一个基础的映射函数(如 SnakeStr)并自动在结果前添加指定前缀。这种方式适合在多租户系统或需要批量管理表名的项目中统一规范表名格式。

package main
import (
"fmt"
"xorm.io/xorm"
"xorm.io/xorm/core"
)
type Order struct {
ID int64
Code string
}
func main() {
engine, err := xorm.NewEngine("mysql", "root:root@/test?charset=utf8mb4")
if err != nil {
log.Fatal(err)
}
// 使用 NewPrefixMapper 添加前缀 "db_"
mapper := core.NewPrefixMapper(core.SnakeStr(), "db_")
engine.SetTableMapper(mapper)
// 测试不同结构体的映射结果
fmt.Println(engine.TableName(&Order{}))
fmt.Println(engine.TableName(&UserInfo{}))
}
假设 UserInfo 已定义,运行此代码将分别输出 db_order 和 db_user_info。这种机制确保了所有未显式指定表名的结构体都能遵循统一的命名约定,简化了数据库初始化和迁移的管理工作。











