gorm 声明模型——迹忆客-ag捕鱼王app官网

模型定义

模型是标准的 struct，由 go 的基本数据类型、实现了 scanner 和 valuer 接口的自定义类型及其指针或别名组成

例如：

type user struct {
  id           uint
  name         string
  email        *string
  age          uint8
  birthday     *time.time
  membernumber sql.nullstring
  activatedat  sql.nulltime
  createdat    time.time
  updatedat    time.time
}

约定

gorm 倾向于约定优于配置 默认情况下，gorm 使用 id 作为主键，使用结构体名的 蛇形复数 作为表名，字段名的 snake_cases 作为列名，并使用 createdat、updatedat 字段追踪创建、更新时间

如果我们遵循 gorm 的约定，就可以少写的配置、代码。 如果约定不符合我们的实际要求，gorm 允许你配置它们

gorm.model

gorm 定义一个 gorm.model 结构体，其包括字段 id、createdat、updatedat、deletedat

// gorm.model 的定义
type model struct {
  id        uint           `gorm:"primarykey"`
  createdat time.time
  updatedat time.time
  deletedat gorm.deletedat `gorm:"index"`
}

我们可以将它嵌入到结构体中，以包含这几个字段，详情请参考

高级选项

字段级权限控制

可导出的字段在使用 gorm 进行 crud 时拥有全部的权限，此外，gorm 允许您用标签控制字段级别的权限。这样您就可以让一个字段的权限是只读、只写、只创建、只更新或者被忽略

注意 ： 使用 gorm migrator 创建表时，不会创建被忽略的字段

type user struct {
  name string `gorm:"<-:create"` // 允许读和创建
  name string `gorm:"<-:update"` // 允许读和更新
  name string `gorm:"<-"`        // 允许读和写（创建和更新）
  name string `gorm:"<-:false"`  // 允许读，禁止写
  name string `gorm:"->"`        // 只读（除非有自定义配置，否则禁止写）
  name string `gorm:"->;<-:create"` // 允许读和写
  name string `gorm:"->:false;<-:create"` // 仅创建（禁止从 db 读）
  name string `gorm:"-"`  // 通过 struct 读写会忽略该字段
  name string `gorm:"-:all"`        // 通过 struct 读写、迁移会忽略该字段
  name string `gorm:"-:migration"`  // 通过 struct 迁移会忽略该字段
}

创建/更新时间追踪（纳秒、毫秒、秒、time）

gorm 约定使用 createdat、updatedat 追踪创建/更新时间。如果我们定义了这种字段，gorm 在创建、更新时会自动填充 当前时间

要使用不同名称的字段，可以配置 autocreatetime、autoupdatetime 标签

如果我们想要保存 unix（毫/纳）秒时间戳，而不是 time，我们只需简单地将 time.time 修改为 int 即可

type user struct {
  createdat time.time // 在创建时，如果该字段值为零值，则使用当前时间填充
  updatedat int       // 在创建时该字段值为零值或者在更新时，使用当前时间戳秒数填充
  updated   int64 `gorm:"autoupdatetime:nano"` // 使用时间戳纳秒数填充更新时间
  updated   int64 `gorm:"autoupdatetime:milli"` // 使用时间戳毫秒数填充更新时间
  created   int64 `gorm:"autocreatetime"`      // 使用时间戳秒数填充创建时间
}

嵌入结构体

对于匿名字段，gorm 会将其字段包含在父结构体中，例如：

type user struct {
  gorm.model
  name string
}
// 等效于
type user struct {
  id        uint           `gorm:"primarykey"`
  createdat time.time
  updatedat time.time
  deletedat gorm.deletedat `gorm:"index"`
  name string
}

对于正常的结构体字段，你也可以通过标签 embedded 将其嵌入，例如：

type author struct {
    name  string
    email string
}
type blog struct {
  id      int
  author  author `gorm:"embedded"`
  upvotes int32
}
// 等效于
type blog struct {
  id    int64
  name  string
  email string
  upvotes  int32
}

并且，我们可以使用标签 embeddedprefix 来为 db 中的字段名添加前缀，例如：

type blog struct {
  id      int
  author  author `gorm:"embedded;embeddedprefix:author_"`
  upvotes int32
}
// 等效于
type blog struct {
  id          int64
    authorname  string
    authoremail string
  upvotes     int32
}

字段标签

声明 model 时，tag 是可选的，gorm 支持以下 tag： tag 名大小写不敏感，但建议使用 camelcase 风格

关联标签

gorm 允许通过标签为关联配置外键、约束、many2many 表，详情请参考 。