模型(Models)通常只是正常的 golang structs、基本的 go 类型或它们的指针。 同时也支持
[sql.Scanner](https://golang.org/pkg/database/sql/#Scanner)及[driver.Valuer](https://golang.org/pkg/database/sql/driver/#Valuer) 接口(interfaces)。
简单地说,模型可以理解为表格,1个模型就是1个表格
模型定义
模型(Model)示例:
type User struct {gorm.ModelName stringAge sql.NullInt64Birthday *time.TimeEmail string `gorm:"type:varchar(100);unique_index"`Role string `gorm:"size:255"` // 设置字段大小为255MemberNumber *string `gorm:"unique;not null"` // 设置会员号(member number)唯一并且不为空Num int `gorm:"AUTO_INCREMENT"` // 设置 num 为自增类型Address string `gorm:"index:addr"` // 给address字段创建名为addr的索引IgnoreMe int `gorm:"-"` // 忽略本字段}
结构体标记(tags)
标记(tags)在声明模型时是可选项。gorm 支持以下标记:| 结构体标记(Tag) | 描述 |
|---|---|
| Column | 指定列名 |
| Type | 指定列数据类型 |
| Size | 指定列大小, 默认值255 |
| PRIMARY_KEY | 将列指定为主键 |
| UNIQUE | 将列指定为唯一 |
| DEFAULT | 指定列默认值 |
| PRECISION | 指定列精度 |
| NOT NULL | 将列指定为非 NULL |
| AUTO_INCREMENT | 指定列是否为自增类型 |
| INDEX | 创建具有或不带名称的索引, 如果多个索引同名则创建复合索引 |
| UNIQUE_INDEX | 和 INDEX类似,只不过创建的是唯一索引 |
| EMBEDDED | 将结构设置为嵌入 |
| EMBEDDED_PREFIX | 设置嵌入结构的前缀 |
| - | 忽略此字段 |
| 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 | 是否自动完成预加载的相关操作 |
基础模型
<font style="background-color:#F9F9FA;">gorm.Model</font> 是一个包含了<font style="background-color:#F9F9FA;">ID</font>, <font style="background-color:#F9F9FA;">CreatedAt</font>, <font style="background-color:#F9F9FA;">UpdatedAt</font>, <font style="background-color:#F9F9FA;">DeletedAt</font>四个字段的GoLang结构体。
// gorm.Model 定义type Model struct {ID uint `gorm:"primary_key"`CreatedAt time.TimeUpdatedAt time.TimeDeletedAt *time.Time}// Inject fields `ID`, `CreatedAt`, `UpdatedAt`, `DeletedAt` into model `User`// 将 `ID`, `CreatedAt`, `UpdatedAt`, `DeletedAt`字段注入到`User`模型中type User struct {gorm.ModelName string}// 不使用gorm.Model定义模型type User struct {ID intName string}
ID 作为主键
GORM 默认会使用名为ID的字段作为表的主键。
type User struct {ID string // 名为`ID`的字段会默认作为表的主键Name string}// 使用`AnimalID`作为主键type Animal struct {AnimalID int64 `gorm:"primary_key"`Name stringAge int64}
表名(Table Name)
表名默认就是结构体名称的复数,例如:
type User struct {} // 默认表名是 `users`// 将 User 的表名设置为 `profiles`func (User) TableName() string {return "profiles"}func (u User) TableName() string {if u.Role == "admin" {return "admin_users"} else {return "users"}}// 禁用默认表名的复数形式,如果置为 true,则 `User` 的默认表名是 `user`db.SingularTable(true)
指定表名称
// 使用User结构体创建名为`deleted_users`的表db.Table("deleted_users").CreateTable(&User{})var deleted_users []Userdb.Table("deleted_users").Find(&deleted_users)//// SELECT * FROM deleted_users;db.Table("deleted_users").Where("name = ?", "jinzhu").Delete()//// DELETE FROM deleted_users WHERE name = 'jinzhu';
更改默认表名称(table name)
你可以通过定义DefaultTableNameHandler来设置默认表名的命名规则
gorm.DefaultTableNameHandler = func (db *gorm.DB, defaultTableName string) string {return "prefix_" + defaultTableName;}
下划线分割命名(Snake Case)的列名
type User struct {ID uint // column name is `id`Name string // column name is `name`Birthday time.Time // column name is `birthday`CreatedAt time.Time // column name is `created_at`}// Overriding Column Nametype 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`}
时间点(Timestamp)跟踪
CreatedAt
如果模型有 CreatedAt字段,该字段的值将会是初次创建记录的时间。
db.Create(&user) // `CreatedAt`将会是当前时间// 可以使用`Update`方法来改变`CreateAt`的值db.Model(&user).Update("CreatedAt", time.Now())
UpdatedAt
如果模型有UpdatedAt字段,该字段的值将会是每次更新记录的时间。
db.Save(&user) // `UpdatedAt`将会是当前时间db.Model(&user).Update("name", "jinzhu") // `UpdatedAt`将会是当前时间
DeletedAt
如果模型有DeletedAt字段,调用Delete删除该记录时,将会设置DeletedAt字段为当前时间,而不是直接将记录从数据库中删除。 了解什么是 软删除
