导读
本套笔记是学习完Gin框架之后的下一个阶段,通过Gin框架我们可以很方便的和前端进行交互,下一步就是和数据库进行交互,这就需要使用GORM。本套笔记就是带你快速上手GORM,学习完这个之后就可以完成大项目的开发了,后续还会进行大项目的讲解开发,制作不易,喜欢的就点个关注吧。
本套课程基于GORM 指南 | GORM - The fantastic ORM library for Golang, aims to be developer friendly.进行讲解,是对这个的补充解释说明。
注意
代码详解大部分是注释的形式给出,请留意代码注释。
GORM介绍
GORM(Go Object Relational Mapping)是一个在 Go 语言中使用的优秀的 ORM(对象关系映射)库。它提供了简单且强大的 API,使开发人员能够轻松地与数据库进行交互
安装
我们只需要打开goland的控制台,输入
go get -u gorm.io/gorm go get -u gorm.io/driver/sqlite
就可以完成安装
在这里输入上方的代码运行
模型
官方定义:模型是标准的 struct,由 Go 的基本数据类型、实现了 Scanner 和 Valuer 接口的自定义类型及其指针或别名组成
其实就是数据库表的结构体对象
例如如果一个数据库包含Id,Name,Age,Gender,Email,那么他的模型就是
type User struct { ID uint Name string Email *string Age uint8 Gender string CreatedAt time.Time//创建时间 UpdatedAt time.Time//更新时间 }
约定
GORM 使用 ID
作为主键,使用结构体名的 蛇形复数
作为表名,并使用 CreatedAt
、UpdatedAt
字段追踪创建、更新时间。
主键
主键(Primary Key)是数据库表中用于唯一标识每个记录的字段或一组字段。
- 唯一性:主键的值在整个表中必须是唯一的,不允许重复出现。这样可以确保每条记录在表中有唯一的标识。
- 非空性:主键字段的值不能为空,每条记录都必须有一个有效的主键。这样可以避免将空值作为标识符。
- 稳定性:主键的值在记录创建后一般不会发生变化,或者在发生变化时能够得到适当的处理。这样可以保持主键的稳定性,确保它作为记录的标识符的一致性。
你可以通过标签 primaryKey
将其它字段设为主键
type Animal struct { ID int64 UUID string `gorm:"primaryKey"` Name string Age int64 }
蛇形复数
蛇形复数(Snake Case)指的是一种命名约定,用于将多个单词连接在一起,通过在单词之间使用下划线(_)作为分隔符。
以下是一些使用蛇形复数的示例:
- 变量名:first_name、last_name、phone_number
- 函数名:calculate_average、get_user_list、validate_input
- 文件名:user_model.go、database_utility.py、config_properties.ini
gorm.Model
GORM 定义一个 gorm.Model
结构体,其包括字段 ID
、CreatedAt
、UpdatedAt
、DeletedAt
type Model struct { ID uint `gorm:"primaryKey"` CreatedAt time.Time UpdatedAt time.Time DeletedAt gorm.DeletedAt `gorm:"index"` }
嵌入结构体
对于匿名字段,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 }
字段标签
一个神奇的玩意。GORM提供了许多有用的标签
column | 指定 db 列名 |
type | 列数据类型,推荐使用兼容性好的通用类型,例如:所有数据库都支持 bool、int、uint、float、string、time、bytes 并且可以和其他标签一起使用,例如:not null 、size , autoIncrement … 像 varbinary(8) 这样指定数据库数据类型也是支持的。在使用指定数据库数据类型时,它需要是完整的数据库数据类型,如:MEDIUMINT UNSIGNED not NULL AUTO_INCREMENT |
serializer | 指定将数据序列化或反序列化到数据库中的序列化器, 例如: serializer:json/gob/unixtime |
size | 定义列数据类型的大小或长度,例如 size: 256 |
primaryKey | 将列定义为主键 |
unique | 将列定义为唯一键 |
default | 定义列的默认值 |
precision | 指定列的精度 |
scale | 指定列大小 |
not null | 指定列为 NOT NULL |
autoIncrement | 指定列为自动增长 |
autoIncrementIncrement | 自动步长,控制连续记录之间的间隔 |
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 无读权限 |
- | 忽略该字段,- 表示无读写,-:migration 表示无迁移权限,-:all 表示无读写迁移权限 |
comment | 迁移时为字段添加注释 |
连接到数据库
GORM 官方支持的数据库类型有:MySQL, PostgreSQL, SQLite, SQL Server 和 TiDB。
我们使用MySQL来进行讲解。
连接MySQL
import ( "gorm.io/driver/mysql" "gorm.io/gorm" ) func main() { dsn := "user:pass@tcp(127.0.0.1:3306)/dbnamecharset=utf8mb4&parseTime=True&loc=Local" db, err := gorm.Open(mysql.Open(dsn), &gorm.Config{}) }
user:pass@tcp(127.0.0.1:3306)/dbname?charset=utf8mb4&parseTime=True&loc=Local
是一个完整的数据库连接字符串示例,包含了用户名、密码、数据库地址、数据库名称以及其他参数。
具体解释如下:
user:pass
:表示数据库连接所使用的用户名和密码。你需要将其替换为实际的用户名和密码,用于连接到数据库服务器。tcp(127.0.0.1:3306)
:指定数据库服务器的地址和端口号。这里的示例是连接到本地主机上运行的 MySQL 数据库服务器,默认端口号是 3306。/dbname
:指定要连接的数据库名称。你需要将其替换为你要连接的实际数据库的名称。?charset=utf8mb4&parseTime=True&loc=Local
:表示连接的其他参数,包括字符集、时间解析以及时区设置
user:pass
和dbname是需要更改成你自己的
高级连接
需要的时候复制粘贴即可
db, err := gorm.Open(mysql.New(mysql.Config{ DSN: "gorm:gorm@tcp(127.0.0.1:3306)/gorm? charset=utf8&parseTime=True&loc=Local", // DSN data source name DefaultStringSize: 256, // string 类型字段的默认长度 DisableDatetimePrecision: true, // 禁用 datetime 精度,MySQL 5.6 之前的数据库不支持 DontSupportRenameIndex: true, // 重命名索引时采用删除并新建的方式,MySQL 5.7 之前的数据库和 MariaDB 不支持重命名索引 DontSupportRenameColumn: true, // 用 `change` 重命名列,MySQL 8 之前的数据库和 MariaDB 不 支持重命名列 SkipInitializeWithVersion: false, // 根据当前 MySQL 版本自动配置 }), &gorm.Config{})
DSN
字段指定数据库连接字符串,包含用户名、密码、数据库地址、数据库名称以及其他参数。DefaultStringSize
字段指定 string 类型字段的默认长度为 256。DisableDatetimePrecision
字段禁用 datetime 精度,因为 MySQL 5.6 之前的数据库不支持此特性。DontSupportRenameIndex
字段禁止重命名索引时采用删除并新建的方式,因为 MySQL 5.7 之前的数据库和 MariaDB 不支持重命名索引。DontSupportRenameColumn
字段禁止使用change
来重命名列,因为 MySQL 8 之前的数据库和 MariaDB 不支持重命名列。SkipInitializeWithVersion
字段根据当前 MySQL 版本自动配置。