gorm连接mysql和模型定义那些事
1. gorm操作mysql:
1.1 安装gorm
gorm官网: https://gorm.io/zh_CN/docs/connecting_to_the_database.html
gorm的github地址:https://github.com/go-gorm/gorm
go get -u gorm.io/gorm
1.2 安装mysql驱动
go get -u gorm.io/driver/mysql
2. 连接Mysql、自动迁移生成数据表、基本的增删改查
package main import ( "fmt" "gorm.io/driver/mysql" "gorm.io/gorm" ) type UserInfo struct { ID uint Name string Gender string Hobby string } func main() { // 连接mysql数据库 dsn := "name:password@tcp(host:port)/dbname?charset=utf8mb4&parseTime=True&loc=Local" db, err := gorm.Open(mysql.Open(dsn), &gorm.Config{}) if err != nil { panic(err) } // 创建表 自动迁移 (把结构体和数据表进行对应) db.AutoMigrate(&UserInfo{}) // 创建数据行 //u1 := UserInfo{1, "七米", "男", "篮球"} //db.Create(&u1) // 查询表中第一条数据保存到u中 var u UserInfo db.First(&u) fmt.Println(u) // 更新 db.Model(&u).Update("Hobby", "双色球") fmt.Println(u) // 删除 db.Delete(&u) }
3. 结构体定义模型的常用标签选项
// 定义模型 type User struct { gorm.Model // 嵌入四个字段:ID、CreatedAt、UpdatedAt、DeletedAt Name string Age sql.NullInt64 // 零值类型 Birthday *time.Time Email string `gorm:"type:varchar(100);unique_index"` // unique_index:唯一索引 Role string `gorm:"size:255"` // 设置字段大小为255 MemberNumber *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支持以下标记:
支持的结构体标记(Struct tags)
结构体标记(Tag) | 描述 |
---|---|
Column | 指定列名 |
Type | 指定列数据类型 |
Size | 指定列大小, 默认值255 |
PRIMARY_KEY | 将列指定为主键 |
UNIQUE | 将列指定为唯一 |
DEFAULT | 指定列默认值 |
PRECISION | 指定列精度 |
NOT NULL | 将列指定为非 NULL |
AUTO_INCREMENT | 指定列是否为自增类型 |
INDEX | 创建具有或不带名称的索引, 如果多个索引同名则创建复合索引 |
UNIQUE_INDEX | 和 INDEX 类似,只不过创建的是唯一索引 |
EMBEDDED | 将结构设置为嵌入 |
EMBEDDED_PREFIX | 设置嵌入结构的前缀 |
- | 忽略此字段 |
关联相关标记(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 | 是否自动完成预加载的相关操作 |
4. 主键、表名、列名的约定
主键(Primary Key)
GORM 默认会使用名为ID的字段作为表的主键。
type User struct { ID string // 名为`ID`的字段会默认作为表的主键 Name string } // 使用`AnimalID`作为主键 type Animal struct { AnimalID int64 `gorm:"primary_key"` Name string Age int64 }
表名(Table Name)
表名默认就是结构体名称的复数,例如:
type User struct {} // 默认表名是 `users` // 将 User 的表名设置为 `profiles` func (User) TableName() string { return "profiles" }
根据表名的一些操作
// 查找一个 var u1 User db.Table("user").First(&u1) fmt.Println(u1) // 查找多个 var u []User db.Table("user").Find(&u) fmt.Println(u) // 按条件查找 var u2 []User db.Table("user").Where("name = ?", "张三").Find(&u2) fmt.Println(u2) // 按条件查找然后删除 db.Table("user").Where("role = ?", "front02").Delete(1)
列名(Column Name)
列名由字段名称进行下划线分割来生成
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` }
可以使用结构体tag指定列名:
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` }
5. 时间戳跟踪
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
字段为当前时间,而不是直接将记录从数据库中删除。
参考链接: https://liwenzhou.com/posts/Go/gorm/