Gorm介绍、数据库连接与模型定义
1.gorm介绍
GORM是使用Go语言开发的友好的ORM库。
Github GORM
中文官方网站
- 全功能 ORM
- 关联 (拥有一个，拥有多个，属于，多对多，多态，单表继承)
- Create，Save，Update，Delete，Find 中钩子方法
- 支持 Preload、Joins 的预加载
- 事务，嵌套事务，Save Point，Rollback To to Saved Point
- Context、预编译模式、DryRun 模式
- 批量插入，FindInBatches，Find/Create with Map，使用 SQL 表达式、Context Valuer 进行 CRUD
- SQL 构建器，Upsert，锁，Optimizer/Index/Comment Hint，命名参数，子查询
- 复合主键，索引，约束
- 自动迁移
- 自定义 Logger
- 灵活的可扩展插件 API：Database Resolver（多数据库，读写分离）、Prometheus…
- 每个特性都经过了测试的重重考验
- 开发者友好
2.安装
go get -u gorm.io/gorm通用数据库接口sql.DB
从*gorm.DB连接获取通用数据库接口*sql.DB
// 获取通用数据库对象`*sql.DB`以使用其函数
db.DB()
// Ping
db.DB().Ping()3.连接数据库
连接不同的数据库都需要导入对应数据的驱动程序，GORM已经贴心的为我们包装了一些驱动程序，只需要按如下方式导入需要的数据库驱动即可。连接数据库参考文章：连接到数据库 | GORM - The fantastic ORM library for Golang, aims to be developer friendly.
3.1连接MySQL
import (
"gorm.io/driver/mysql"
"gorm.io/gorm"
)
func main() {
// 参考 https://github.com/go-sql-driver/mysql#dsn-data-source-name 获取详情
dsn := "user:pass@tcp(127.0.0.1:3306)/dbname?charset=utf8mb4&parseTime=True&loc=Local"
db, err := gorm.Open(mysql.Open(dsn), &gorm.Config{})
}3.2连接PostgreSQL
基本代码同上，注意引入对应postgres驱动并正确指定gorm.Open()参数。
import (
"gorm.io/driver/postgres"
"gorm.io/gorm"
)
dsn := "host=localhost user=gorm password=gorm dbname=gorm port=9920 sslmode=disable TimeZone=Asia/Shanghai"
db, err := gorm.Open(postgres.Open(dsn), &gorm.Config{})3.3连接Sqlite3
基本代码同上，注意引入对应sqlite驱动并正确指定gorm.Open()参数。
import (
"gorm.io/driver/sqlite" // Sqlite driver based on CGO
// "github.com/glebarez/sqlite" // Pure go SQLite driver, checkout https://github.com/glebarez/sqlite for details
"gorm.io/gorm"
)
// github.com/mattn/go-sqlite3
db, err := gorm.Open(sqlite.Open("gorm.db"), &gorm.Config{})3.4连接SQL Server
基本代码同上，注意引入对应sqlserver驱动并正确指定gorm.Open()参数。
import (
"gorm.io/driver/sqlserver"
"gorm.io/gorm"
)
// github.com/denisenkom/go-mssqldb
dsn := "sqlserver://gorm:LoremIpsum86@localhost:9930?database=gorm"
db, err := gorm.Open(sqlserver.Open(dsn), &gorm.Config{})3.5连接TiDB
TiDB 兼容 MySQL 协议。 因此你可以按照 MySQL 一节来创建与 TiDB 的连接。
在使用 TiDB 时有一些值得注意的内容：
- 您可以在结构体中使用
gorm:"primaryKey;default:auto_random()"标签从而调用 TiDB 的 AUTO_RANDOM 功能。 - TiDB 从
v6.2.0起支持SAVEPOINT ,使用此功能时，请注意TiDB的版本。 - TiDB 从
v6.6.0起支持FOREIGN KEY , 使用此功能时，请注意TiDB的版本。
import (
"fmt"
"gorm.io/driver/mysql"
"gorm.io/gorm"
)
type Product struct {
ID uint `gorm:"primaryKey;default:auto_random()"`
Code string
Price uint
}
func main() {
db, err := gorm.Open(mysql.Open("root:@tcp(127.0.0.1:4000)/test"), &gorm.Config{})
if err != nil {
panic("failed to connect database")
}
db.AutoMigrate(&Product{})
insertProduct := &Product{Code: "D42", Price: 100}
db.Create(insertProduct)
fmt.Printf("insert ID: %d, Code: %s, Price: %d\n",
insertProduct.ID, insertProduct.Code, insertProduct.Price)
readProduct := &Product{}
db.First(&readProduct, "code = ?", "D42") // find product with code D42
fmt.Printf("read ID: %d, Code: %s, Price: %d\n",
readProduct.ID, readProduct.Code, readProduct.Price)
}3.6连接Clickhouse
参考文章：GitHub - go-gorm/clickhouse: GORM clickhouse driver
import (
"gorm.io/driver/clickhouse"
"gorm.io/gorm"
)
func main() {
dsn := "clickhouse://gorm:gorm@localhost:9942/gorm?dial_timeout=10s&read_timeout=20s"
db, err := gorm.Open(clickhouse.Open(dsn), &gorm.Config{})
// 自动迁移 (这是GORM自动创建表的一种方式--译者注)
db.AutoMigrate(&User{})
// 设置表选项
db.Set("gorm:table_options", "ENGINE=Distributed(cluster, default, hits)").AutoMigrate(&User{})
// 插入
db.Create(&user)
// 查询
db.Find(&user, "id = ?", 10)
// 批量插入
var users = []User{user1, user2, user3}
db.Create(&users)
// ...
}3.7连接池
GORM 使用 database/sql 来维护连接池
sqlDB, err := db.DB()
// SetMaxIdleConns 设置空闲连接池中的最大连接数。
sqlDB.SetMaxIdleConns(10)
// SetMaxOpenConns 设置数据库的最大打开连接数。
sqlDB.SetMaxOpenConns(100)
// SetConnMaxLifetime 设置连接可重用的最大时间。
sqlDB.SetConnMaxLifetime(time.Hour)查看 通用接口 获取详情。
4.模型定义
GORM通过将Go结构映射到数据库表来简化数据库交互。
模型是用普通结构体定义的。这些结构体可以包含具有基本Go类型的字段、指针或这些类型的别名，甚至是自定义类型，只要它们实现了来自database/sql包的Scanner和Valuer接口
type User struct {
ID uint // 主键基础字段
Name string // 字符串字段
Email *string // 一个指向字符串的指针，允许空值
Age uint8 // 无符号8位整数
Birthday *time.Time // 时间指针。时间，可以为空
MemberNumber sql.NullString // 使用sql.NullString处理可空字符串
ActivatedAt sql.NullTime // 使用sql.NullTime处理可空时间字段
CreatedAt time.Time // 由GORM自动管理创建时间
UpdatedAt time.Time // 由GORM自动管理更新时间
}在这个模型中:
- 基本数据类型，如uint, string和uint8直接使用。
- 指向*string和*time等类型的指针。时间表示可空字段。
- sql.NullString和sql.NullTime来自database/sql包用于具有更多控制的可空字段。
- CreatedAt和UpdatedAt是GORM在创建或更新记录时自动填充的特殊字段。
除了GORM中模型声明的基本特性之外，重要的是要强调通过序列化器标记对序列化的支持。此特性增强了数据存储和从数据库检索的灵活性，特别是对于需要自定义序列化逻辑的字段
5.约定
使用 ID 作为主键
默认情况下，GORM 会使用 ID 作为表的主键。
type User struct {
ID string // 默认情况下，名为 `ID` 的字段会作为表的主键
Name string
}你可以通过标签 primaryKey 将其它字段设为主键
// 将 `UUID` 设为主键
type Animal struct {
ID int64
UUID string `gorm:"primaryKey"`
Name string
Age int64
}此外，您还可以看看 复合主键
复数表名
GORM 使用结构体名的 蛇形命名 作为表名。对于结构体 User，根据约定，其表名为 users
TableName
您可以实现 Tabler 接口来更改默认表名，例如：
type Tabler interface {
TableName() string
}
// TableName 会将 User 的表名重写为 `profiles`
func (User) TableName() string {
return "profiles"
} 注意： TableName 不支持动态变化，它会被缓存下来以便后续使用。想要使用动态表名，你可以使用 Scopes，例如：
func UserTable(user User) func (tx *gorm.DB) *gorm.DB {
return func (tx *gorm.DB) *gorm.DB {
if user.Admin {
return tx.Table("admin_users")
}
return tx.Table("users")
}
}
db.Scopes(UserTable(user)).Create(&user)临时指定表名
您可以使用 Table 方法临时指定表名，例如：
// 根据 User 的字段创建 `deleted_users` 表
db.Table("deleted_users").AutoMigrate(&User{})
// 从另一张表查询数据
var deletedUsers []User
db.Table("deleted_users").Find(&deletedUsers)
// SELECT * FROM deleted_users;
db.Table("deleted_users").Where("name = ?", "jinzhu").Delete(&User{})
// DELETE FROM deleted_users WHERE name = 'jinzhu';查看 from 子查询 了解如何在 FROM 子句中使用子查询
命名策略
GORM允许用户通过覆盖默认的NamingStrategy来更改默认的命名约定，该策略用于构建TableName, ColumnName, JoinTableName, RelationshipFKName, CheckerName, IndexName
列名
根据约定，数据表的列名使用的是 struct 字段名的 蛇形命名
type User struct {
ID uint // 列名是 `id`
Name string // 列名是 `name`
Birthday time.Time // 列名是 `birthday`
CreatedAt time.Time // 列名是 `created_at`
}您可以使用 column 标签或 命名策略 来覆盖列名
type Animal struct {
AnimalID int64 `gorm:"column:beast_id"` // 将列名设为 `beast_id`
Birthday time.Time `gorm:"column:day_of_the_beast"` // 将列名设为 `day_of_the_beast`
Age int64 `gorm:"column:age_of_the_beast"` // 将列名设为 `age_of_the_beast`
}时间戳追踪
CreatedAt
对于有 CreatedAt 字段的模型，创建记录时，如果该字段值为零值，则将该字段的值设为当前时间
db.Create(&user) // 将 `CreatedAt` 设为当前时间
user2 := User{Name: "jinzhu", CreatedAt: time.Now()}
db.Create(&user2) // user2 的 `CreatedAt` 不会被修改
// 想要修改该值，您可以使用 `Update`
db.Model(&user).Update("CreatedAt", time.Now())你可以通过将 autoCreateTime 标签置为 false 来禁用时间戳追踪，例如：
type User struct {
CreatedAt time.Time `gorm:"autoCreateTime:false"`
}UpdatedAt
对于有 UpdatedAt 字段的模型，更新记录时，将该字段的值设为当前时间。创建记录时，如果该字段值为零值，则将该字段的值设为当前时间
db.Save(&user) // 将 `UpdatedAt` 设为当前时间
db.Model(&user).Update("name", "jinzhu") // 会将 `UpdatedAt` 设为当前时间
db.Model(&user).UpdateColumn("name", "jinzhu") // `UpdatedAt` 不会被修改
user2 := User{Name: "jinzhu", UpdatedAt: time.Now()}
db.Create(&user2) // 创建记录时，user2 的 `UpdatedAt` 不会被修改
user3 := User{Name: "jinzhu", UpdatedAt: time.Now()}
db.Save(&user3) // 更新时，user3 的 `UpdatedAt` 会修改为当前时间可以通过将 autoUpdateTime 标签置为 false 来禁用时间戳追踪，例如：
type User struct {
UpdatedAt time.Time `gorm:"autoUpdateTime:false"`
}6.高级选项
字段级权限控制
可导出的字段在使用 GORM 进行 CRUD 时拥有全部的权限，此外，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:"-"` // 通过 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 风格
| 标签名 | 说明 |
|---|---|
| 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 | 迁移时为字段添加注释 |
7.关联标签（Association Tags）
GORM中的关联标记用于指定如何处理模型之间的关联，比如外键、引用和约束。
| 标签 | 描述 |
|---|---|
foreignKey |
指定连接表中用作外键的当前模型的列名。 |
references |
指示连接表的外键映射到的引用表中的列名。 |
polymorphic |
定义多态类型，通常是模型名称。 |
polymorphicValue |
如果没有另行指定，则设置多态值，通常为表名。 |
many2many |
命名多对多关系中使用的连接表。 |
joinForeignKey |
标识连接表中映射回当前模型表的外键列。 |
joinReferences |
指向链接到参考模型表的连接表中的外键列。 |
constraint |
为关联指定关系约束，如OnUpdate, OnDelete。 |