在使用ORM工具时，通常我们需要在代码中定义模型（Models）与数据库中的数据表进行映射，在GORM中模型（Models）通常是正常定义的结构体、基本的go类型或它们的指针。 同时也支持sql.Scanner及driver.Valuer接口（interfaces）。

(1) gorm.Model

为了方便模型定义，GORM内置了一个gorm.Model结构体。gorm.Model是一个包含了ID, CreatedAt, UpdatedAt, DeletedAt四个字段的Golang结构体。

  1. // gorm.Model 定义
  2. type Model struct {
  3.     ID        uint `gorm:"primary_key"`
  4.     CreatedAt time.Time
  5.     UpdatedAt time.Time
  6.     DeletedAt *time.Time
  7. }

你可以将它嵌入到你自己的模型中：

  1. // 将 `ID`, `CreatedAt`, `UpdatedAt`, `DeletedAt`字段注入到`User`模型中
  2. type User struct {
  3.     gorm.Model
  4.     Name string
  5. }

当然你也可以完全自己定义模型：

  1. // 不使用gorm.Model，自行定义模型
  2. type User struct {
  3.     ID   int
  4.     Name string
  5. }

(2) 示例

  1. type User struct {
  2.   gorm.Model
  3.   Name         string
  4.   Age          sql.NullInt64
  5.   Birthday     *time.Time
  6.   Email        string  `gorm:"type:varchar(100);unique_index"`
  7.   Role         string  `gorm:"size:255"` // 设置字段大小为255
  8.   MemberNumber *string `gorm:"unique;not null"` // 设置会员号（member number）唯一并且不为空
  9.   Num          int     `gorm:"AUTO_INCREMENT"` // 设置 num 为自增类型
  10.   Address      string  `gorm:"index:addr"` // 给address字段创建名为addr的索引
  11.   IgnoreMe     int     `gorm:"-"` // 忽略本字段
  12. }

1) 支持的结构体标记（Struct tags）

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

2) 关联相关标记（tags）

结构体标记（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 是否自动完成预加载的相关操作

(3) 主键

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

  1. type User struct {
  2.   ID   string // 名为`ID`的字段会默认作为表的主键
  3.   Name string
  4. }
  6. // 使用`AnimalID`作为主键
  7. type Animal struct {
  8.   AnimalID int64 `gorm:"primary_key"`
  9.   Name     string
  10.   Age      int64
  11. }

(4) 表名

表名默认就是结构体名称的复数，例如：

  1. type User struct {} // 默认表名是 `users`
  3. func (User) TableName() string {
  4.     return "user"
  5. }

也可以通过Table()指定表名：

  1. // 使用User结构体创建名为`deleted_users`的表
  2. db.Table("deleted_users").CreateTable(&User{})
  4. var deleted_users []User
  5. db.Table("deleted_users").Find(&deleted_users)
  6. //// SELECT * FROM deleted_users;
  8. db.Table("deleted_users").Where("name = ?", "jinzhu").Delete()
  9. //// DELETE FROM deleted_users WHERE name = 'jinzhu';

GORM还支持更改默认表名称规则：

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

(5) 列名

列名由字段名称进行下划线分割来生成

  1. type User struct {
  2.     ID        uint      // column name is `id`
  3.     Name      string    // column name is `name`
  4.     Birthday  time.Time // column name is `birthday`
  5.     CreatedAt time.Time // column name is `created_at`
  6. }

可以使用结构体tag指定列名：

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

(6) 时间戳跟踪

1) CreatedAt

如果模型有 CreatedAt字段，该字段的值将会是初次创建记录的时间。

2) UpdatedAt

如果模型有UpdatedAt字段，该字段的值将会是每次更新记录的时间。

3) DeletedAt

如果模型有DeletedAt字段，调用Delete删除该记录时，将会设置DeletedAt字段为当前时间，
而不是直接将记录从数据库中删除。