1. 定义
1. 1.1. 类型与约束
2. 一些约定

定义

GORM内置了一个gorm.Model结构体，包含以下四个字段

// gorm.Model 定义
type Model struct {
  ID        uint `gorm:"primary_key"`
  CreatedAt time.Time
  UpdatedAt time.Time
  DeletedAt *time.Time
}

我们使用的时候可以放入默认结构体，或者只使用自己的

类型与约束

GORM中可以使用结构体标签来指定字段的类型和约束，支持的类型如下：

结构体标记（Tag）	描述
Column	指定列名
Type	指定列数据类型
Size	指定列大小, 默认值255
PRIMARY_KEY	将列指定为主键
UNIQUE	将列指定为唯一
DEFAULT	指定列默认值
PRECISION	指定列精度
NOT NULL	将列指定为非 NULL
AUTO_INCREMENT	指定列是否为自增类型
INDEX	创建具有或不带名称的索引, 如果多个索引同名则创建复合索引
UNIQUE_INDEX	和 `INDEX` 类似，只不过创建的是唯一索引
EMBEDDED	将结构设置为嵌入
EMBEDDED_PREFIX	设置嵌入结构的前缀
-	忽略此字段

关联相关tag：

结构体标记（Tag）	描述
MANY2MANY	指定连接表
FOREIGNKEY	设置外键
ASSOCIATION_FOREIGNKEY	设置关联外键
POLYMORPHIC	指定多态类型
POLYMORPHIC_VALUE	指定多态值
JOINTABLE_FOREIGNKEY	指定连接表的外键
ASSOCIATION_JOINTABLE_FOREIGNKEY	指定连接表的关联外键
SAVE_ASSOCIATIONS	是否自动完成 save 的相关操作
ASSOCIATION_AUTOUPDATE	是否自动完成 update 的相关操作
ASSOCIATION_AUTOCREATE	是否自动完成 create 的相关操作
ASSOCIATION_SAVE_REFERENCE	是否自动完成引用的 save 的相关操作
PRELOAD	是否自动完成预加载的相关操作

一些约定

主键

GORM默认使用名为ID的字段作为表主键

type User struct {
    ID string
    name string
}

表名

表名默认是结构体名称的复数，且驼峰写法改为蛇形写法

重写对应表的方法TableName()

1
2
3

func (User) TableName(){
    return "profiles"
}

可以使用Table()指定表名

1	db.Table("your name").CreateTable(&User{})

使用db.SingularTable(True)禁用复数

还可以更改默认表名称规则：

1
2
3

gorm.DefaultTableNameHandler = func (db *gorm.DB, defaultTableName string) string  {
  return "prefix_" + defaultTableName;
}

列名

列名通过struct定义的字段名，将驼峰改为蛇形来生成

可以使用结构体标签指定别名gorm"column:name"

type Animal struct {
  AnimalId    int64     `gorm:"column:beast_id"`         // set column name to `beast_id`
  Birthday    time.Time `gorm:"column:day_of_the_beast"` // set column name to `day_of_the_beast`
  Age         int64     `gorm:"column:age_of_the_beast"` // set column name to `age_of_the_beast`
}

时间戳

CreatedAt：若有CreatedAt字段，该字段的值会是初次创建记录的时间

UpdateAt：若有UpdateAt字段，该字段的值会是最近一次更新的时间

DeletedAt：若有DeletedAt字段，调用Delete方法时，将会设置DeletedAt字段为当前时间，而不是直接删除数据

本作品采用知识共享署名-相同方式共享 4.0 国际许可协议进行许可

红魔咖啡馆

【GORM】模型定义

定义

类型与约束

一些约定

主键

表名

列名

时间戳