一、gorm介绍:
1. 什么是orm?
Object-Relationl Mapping,即对象关系映射,这里的Relationl指的是关系型数据库
它的作用是在关系型数据库和对象之间作一个映射,这样,我们在具体的操作数据库的时候,就不需要再去和复杂的SQL语句打交道,只要像平时操作对象一样操作它就可以了 。
2. gorm
1.Golang写的,GitHub上活跃度很高的orm库
2.特点:
- 全功能ORM;
- 关联(包含一个,包含多个,属于,多对多,多种包含);
- Callbacks(创建/保存/更新/删除/查找之前/之后);
- 预加载;
- 事务
- 复合主键
- SQL Builder
- 自动迁移
- 日志
- 可扩展,编写基于GORM回调的插件
- 每个功能都有测试
- 开发人员友好
3.安装
go get github.com/jinzhu/gorm
4.官方文档:
http://gorm.book.jasperxu.com/
二、连接数据库:
GORM 官方支持的数据库类型有: MySQL, PostgreSQL, SQlite, SQL Server
gorm连接数据库
1. mysql:
package mainimport ("gorm.io/driver/mysql""gorm.io/gorm"
)func main() {// 用户名:密码@tcp(ip:port)/数据库?charset=utf8mb4&parseTime=True&loc=Localdsn := "root:root123@tcp(127.0.0.1:3306)/test_gorm?charset=utf8mb4&parseTime=True&loc=Local"db, err := gorm.Open(mysql.Open(dsn), &gorm.Config{})if err != nil {panic(err)}// 释放连接// db.Close() // 没有这个方法了???
}
2.表操作:
ps: 新的gorm貌似不支持了
package mainimport ("gorm.io/driver/mysql""gorm.io/gorm"
)type User struct {Id intName stringAge intAddr stringPic string
}func main() {// 用户名:密码@tcp(ip:port)/数据库?charset=utf8mb4&parseTime=True&loc=Localdsn := "root:root123@tcp(127.0.0.1:3306)/test_gorm?charset=utf8mb4&parseTime=True&loc=Local"db, err := gorm.Open(mysql.Open(dsn), &gorm.Config{})if err != nil {panic(err)}// 释放连接// db.Close() // PS: 没有这个方法了???// 创建表// db.Table("user").CreateTable(&User{}) // 指定表名 PS: 方法不可用了 // db.CreateTable(&User{}) // 不指定表名,模型后面会加个s PS: 方法不可用了 // 判断表是否存在// b := db.HasTable(&User{}) // PS: 方法不存在了// fmt.Println(b)// // 删除表// db.DropTable(&User{}) // PS: 方法不存在了
}
3.自动迁移:
自动迁移仅仅会创建表,添加缺少列和索引,并且不会改变现有列的类型或删除未使用的列以保护数据
db.AutoMigrate(&User{}, &Product{}, &Order{})// 创建表时添加表后缀
db.Set("gorm:table_options", "ENGINE=InnoDB").AutoMigrate(&User{})
三、数据操作:
1. 简单的添加数据 & 查询数据 & 更新数据 & 删除数据:
package mainimport ("fmt""gorm.io/driver/mysql""gorm.io/gorm"
)type User struct {Id intName stringAge intAddr stringPic string
}func main() {dsn := "root:root123@tcp(127.0.0.1:3306)/test_gorm?charset=utf8mb4&parseTime=True&loc=Local"db, err := gorm.Open(mysql.Open(dsn), &gorm.Config{})if err != nil {panic(err)}// 自动迁移db.Set("gorm:table_options", "ENGINE=InnoDB").AutoMigrate(&User{})// 增db.Create(&User{Name: "张三",Age: 18,Addr: "北京市",Pic: "/static/img.png",})// 查var user Userdb.First(&user)fmt.Println(user) // {1 张三 18 北京市 /static/img.png}// 改user.Name = "lisi"db.Save(&user)fmt.Println(user) // {1 lisi 18 北京市 /static/img.png}// 删db.Delete(&user)
}
2. 模型定义:
2.1 模型名和表名的映射关系
- 规则
- 第一个大写字母变为小写;
- 遇到其他大写字母变为小写并且在前面加下划线;
- 连着的几个大写字母,只有第一个遵循上面的两条规则,其他的大写字母转为小写,不加下划线,遇到小写,前面的第一个大写字母变小写并加下划线;
- 复数形式;
- 举例
- User => users 首字母小写,复数
- UserInfo => user_infos
- DBUserInfo => db_user_infos
- DBXXXXUserInfo => dbxxxx_user_infos
2.2 在默认表名上加其他规则
// 在默认表名前加sys_前缀
gorm.DefaultTableNameHandler = func (db *gorm.DB, defaultTableName string) string {return "sys_" + defaultTableName;
}
自定义表名:
func (模型) TableName() string{return "新的表名"
}
2.3 结构体字段名和列名的对应规则
规则 * 列名是字段名的蛇形小写
举例
gorm:"column:beast_id"
2.4 gorm.Model
基本模型定义gorm.Model,包括字段ID,CreatedAt,UpdatedAt,DeletedAt
只需要在自己的模型中指定gorm.Model匿名字段,即可使用上面的四个字段
gorm.Model.go
package gormimport "time"// Model a basic GoLang struct which includes the following fields: ID, CreatedAt, UpdatedAt, DeletedAt
// It may be embedded into your model or you may build your own model without it
// type User struct {
// gorm.Model
// }
type Model struct {ID uint `gorm:"primarykey"`CreatedAt time.TimeUpdatedAt time.TimeDeletedAt DeletedAt `gorm:"index"`
}
// 添加字段 `ID`, `CreatedAt`, `UpdatedAt`, `DeletedAt`
type User struct {gorm.ModelName string
}
- ID:主键自增长;
- CreatedAt:用于存储记录的创建时间;
- UpdatedAt:用于存储记录的修改时间;
- DeletedAt:用于存储记录的删除时间;
3. 高级选项:
3.1 结构体标签gorm的使用:
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:"-"` // 读写操作均会忽略该字段
}
3.2 创建/更新时间追踪(纳秒、毫秒、秒、Time)
GORM 约定使用 CreatedAt、UpdatedAt 追踪创建/更新时间。如果您定义了这种字段,GORM 在创建、更新时会自动填充 当前时间
要使用不同名称的字段,您可以配置 autoCreateTim、autoUpdateTim 标签
如果您想要保存 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"` // 使用时间戳秒数填充创建时间
}
3.3 字段标签
声明 model 时,tag 是可选的,GORM 支持以下 tag: tag 名大小写不敏感,但建议使用 camelCase 风格
| 标签名 | 说明 |
|---|---|
| column | 指定 db 列名 |
| type | 列数据类型,推荐使用兼容性好的通用类型,例如:所有数据库都支持 bool、int、uint、float、string、time、bytes 并且可以和其他标签一起使用,例如:not null、size, autoIncrement… 像 varbinary(8) 这样指定数据库数据类型也是支持的。在使用指定数据库数据类型时,它需要是完整的数据库数据类型,如:MEDIUMINT UNSIGNED not NULL AUTO_INSTREMENT |
| size | 指定列大小,例如:size:256 |
| primaryKey | 指定列为主键 |
| unique | 指定列为唯一 |
| default | 指定列的默认值 |
| precision | 指定列的精度 |
| scale | 指定列大小 |
| not null | 指定列为 NOT NULL |
| autoIncrement | 指定列为自动增长 |
| embedded | 嵌套字段 |
| embeddedPrefix | 嵌入字段的列名前缀 |
| autoCreateTime | 创建时追踪当前时间,对于 int 字段,它会追踪时间戳秒数,您可以使用 nano/milli 来追踪纳秒、毫秒时间戳,例如:autoCreateTime:nano |
| autoUpdateTime | 创建/更新时追踪当前时间,对于 int 字段,它会追踪时间戳秒数,您可以使用 nano/milli 来追踪纳秒、毫秒时间戳,例如:autoUpdateTime:milli |
| index | 根据参数创建索引,多个字段使用相同的名称则创建复合索引,查看 索引 获取详情 |
| uniqueIndex | 与 index 相同,但创建的是唯一索引 |
| check | 创建检查约束,例如 check:age > 13,查看 约束 获取详情 |
| <- | 设置字段写入的权限, <-:create 只创建、<-:update 只更新、<-:false 无写入权限、<- 创建和更新权限 |
| -> | 设置字段读的权限,->:false 无读权限 |
| - | 忽略该字段,- 无读写权限 |
gorm:"size:64;not null"