GORM(Go ORM,即对象关系映射)是Go语言中非常流行且功能强大的数据库交互库。它简化了与关系型数据库的交互过程,提供了丰富的API来处理各种数据库操作。下面将详细介绍GORM的功能、使用方法和一些高级特性。
1. 安装
首先,确保安装了GORM以及相应的数据库驱动:
go get -u gorm.io/gorm
go get -u gorm.io/driver/mysql # MySQL驱动示例
2. 连接数据库
连接到数据库时,您需要提供数据源名称(DSN),这通常包括用户名、密码、主机地址、端口和数据库名等信息。对于MySQL,可以这样做:
import (
"gorm.io/driver/mysql"
"gorm.io/gorm"
)
func main() {
dsn := "user:password@tcp(127.0.0.1:3306)/dbname?charset=utf8mb4&parseTime=True&loc=Local"
db, err := gorm.Open(mysql.Open(dsn), &gorm.Config{})
if err != nil {
panic("failed to connect database")
}
}
3. 定义模型
GORM使用结构体表示数据库表中的记录。定义一个User
模型如下:
type User struct {
ID uint `gorm:"primaryKey"`
Name string
Email string `gorm:"unique"` // 添加唯一性约束
Age int
Birthday time.Time
RoleID uint
Role Role `gorm:"foreignKey:RoleID"` // 关联字段
}
type Role struct {
ID uint
Name string
}
4. CRUD 操作
创建:插入新记录
user := User{Name: "Alice", Email: "alice@example.com", Age: 25}
db.Create(&user)
读取:获取记录
var user User
db.First(&user, 1) // 根据主键查找第一条记录
db.Where("name = ?", "Alice").First(&user) // 查找名字为"Alice"的用户
更新:修改记录
db.Model(&user).Update("Age", 26)
删除:移除记录
db.Delete(&user, 1) // 删除ID为1的用户
5. 关联
GORM支持多种类型的关联,如Has One
、Belongs To
、Has Many
、Many To Many
等。例如:
// Has One 关联
type CreditCard struct {
ID uint
Number string
UserID uint
User User `gorm:"foreignKey:UserID"` // 外键
}
// Belongs To 关联
type Pet struct {
ID uint
Name string
UserID uint
User User `gorm:"foreignKey:UserID"` // 外键
}
// Has Many 关联
type User struct {
ID uint
Pets []Pet `gorm:"foreignKey:UserID"` // 用户拥有多只宠物
}
// Many To Many 关联
type Language struct {
ID uint
Name string
Users []User `gorm:"many2many:user_languages;"` // 用户和语言之间的多对多关联
}
6. 自动迁移
GORM提供了一个自动迁移的功能,可以根据您的模型结构自动创建或更新表结构。
db.AutoMigrate(&User{}, &CreditCard{}, &Pet{}, &Language{})
7. 高级特性
回调函数
GORM允许自定义回调函数,在特定事件发生时执行,比如在创建、更新、删除之前或之后。
db.Callback().Create().Before("gorm:create").Register("log_before_create", func(db *gorm.DB) {
fmt.Println("before create...")
})
插件
GORM可以通过插件扩展其功能。例如,添加软删除插件:
db, _ = gorm.Open(mysql.Open(dsn), &gorm.Config{
Plugins: []plugin.Plugin{
&plugins.SoftDelete{},
},
})
原生SQL查询
GORM也支持原生SQL查询,当ORM不足以表达复杂的查询时,可以使用原始SQL。
var result []User
db.Raw("SELECT * FROM users WHERE name = ?", "Alice").Scan(&result)
事务
GORM提供了简单易用的事务管理接口。
db.Transaction(func(tx *gorm.DB) error {
if err := tx.Create(&User{Name: "Bob"}).Error; err != nil {
return err
}
if err := tx.Create(&CreditCard{Number: "1234567890123456", UserID: 1}).Error; err != nil {
return err
}
// 返回nil代表提交事务,其他任何值都会回滚事务。
return nil
})
以上是对GORM的较为全面的介绍。当然,这只是冰山一角,GORM还有更多功能和特性等待探索。官方文档是一个非常好的资源,建议深入阅读以充分利用这个工具。