https://blog.911015.com/gorm-study/ Recent content in GORM 学习教程 on Go Home Hugo -- gohugo.io en-us https://blog.911015.com/gorm-study/01.html Mon, 01 Jan 0001 00:00:00 +0000 https://blog.911015.com/gorm-study/01.html 第一章：GORM 入门指南 1.1 GORM 简介 GORM 是 Go 语言中最流行的 ORM 库之一，全称为 Go Object Relational Mapping。它由 Jinzhu 开发并维护，提供了简洁优雅的 API 来操作数据库。 GORM 的核心特性 特性 说明 全功能 ORM 支持关联（一对一、一对多、多对多）、钩子、预加载、连接池等 链式操作 流畅的查询构建器 API 自动迁移 根据模型自动创建/更新数据库表结构 通用数据库支持 MySQL、PostgreSQL、SQLite、SQL Server、ClickHouse 等 可扩展性 基于 GORM 编写插件，如 Prometheus 监控、锁机制等 上下文支持 完整支持 context.Context GORM 版本 GORM v1: 第一个稳定版本，已停止维护 GORM v2: 当前主流版本，完全重写，性能更好（推荐） 1.2 环境准备 安装 Go 确保 Go 版本 >= 1.16： go version 安装 GORM go get -u gorm.io/gorm 安装数据库驱动 根据你使用的数据库选择对应的驱动： https://blog.911015.com/gorm-study/02.html Mon, 01 Jan 0001 00:00:00 +0000 https://blog.911015.com/gorm-study/02.html 第二章：模型定义详解 2.1 基础模型结构 内置 gorm.Model type Model struct { ID uint `gorm:"primaryKey"` // 自增主键 CreatedAt time.Time // 创建时间 UpdatedAt time.Time // 更新时间 DeletedAt gorm.DeletedAt `gorm:"index"` // 软删除时间戳 } 使用方式： type User struct { gorm.Model Name string } 自定义基础模型 type BaseModel struct { ID uint64 `gorm:"primaryKey;autoIncrement;comment:主键ID"` CreatedAt time.Time `gorm:"index;comment:创建时间"` UpdatedAt time.Time `gorm:"comment:更新时间"` DeletedAt gorm.DeletedAt `gorm:"index;comment:删除时间"` } type User struct { BaseModel Name string `gorm:"comment:用户名"` } 2.2 字段标签（Tags） GORM 通过结构体标签配置字段属性： 常用标签 标签 说明 示例 column 指定列名 gorm:"column:user_name" type 指定数据类型 gorm:"type:varchar(100)" size 字段大小 gorm:"size:255" primaryKey 设为主键 gorm:"primaryKey" unique 唯一约束 gorm:"unique" uniqueIndex 唯一索引 gorm:"uniqueIndex:idx_email" index 普通索引 gorm:"index:idx_name" default 默认值 gorm:"default:'unknown'" not null 非空约束 gorm:"not null" autoIncrement 自增 gorm:"autoIncrement" comment 字段注释 gorm:"comment:用户姓名" embedded 嵌入字段 gorm:"embedded" embeddedPrefix 嵌入前缀 gorm:"embeddedPrefix:info_" - 忽略字段 gorm:"-" 完整示例 type Product struct { ID uint `gorm:"primaryKey;autoIncrement;column:product_id"` Code string `gorm:"uniqueIndex;size:100;not null;comment:产品编码"` Name string `gorm:"type:varchar(200);index:idx_name;comment:产品名称"` Price float64 `gorm:"type:decimal(10,2);default:0;comment:价格"` Description string `gorm:"type:text;comment:产品描述"` Status int `gorm:"default:1;comment:状态：1-上架 2-下架"` IsDeleted bool `gorm:"default:false;-"` // 忽略该字段 CreatedAt time. https://blog.911015.com/gorm-study/03.html Mon, 01 Jan 0001 00:00:00 +0000 https://blog.911015.com/gorm-study/03.html 第三章：数据库连接与配置 3.1 支持的数据库 GORM 官方支持以下数据库： 数据库 驱动包 DSN 示例 MySQL gorm.io/driver/mysql user:pass@tcp(127.0.0.1:3306)/dbname?charset=utf8mb4&parseTime=True&loc=Local PostgreSQL gorm.io/driver/postgres host=localhost user=gorm password=gorm dbname=gorm port=9920 sslmode=disable TimeZone=Asia/Shanghai SQLite gorm.io/driver/sqlite test.db 或 :memory: SQL Server gorm.io/driver/sqlserver sqlserver://gorm:LoremIpsum86@localhost:9930?database=gorm ClickHouse gorm.io/driver/clickhouse tcp://localhost:9000?database=gorm&username=gorm&password=gorm&read_timeout=10&write_timeout=20 3.2 MySQL 连接详解 基础连接 package main 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("数据库连接失败: " + err.Error()) } } DSN 参数说明 参数 说明 建议值 charset 字符集 utf8mb4（支持 emoji） parseTime 解析时间类型 True loc 时区 Local 或 Asia/Shanghai timeout 连接超时 10s readTimeout 读取超时 30s writeTimeout 写入超时 30s interpolateParams 参数插值 true（减少预处理） multiStatements 多语句执行 按需开启 高级 DSN 配置 dsn := "user:password@tcp(127. https://blog.911015.com/gorm-study/04.html Mon, 01 Jan 0001 00:00:00 +0000 https://blog.911015.com/gorm-study/04.html 第四章：CRUD 基础操作 4.1 创建（Create） 单条记录创建 user := User{Name: "张三", Email: "zhangsan@example.com", Age: 25} result := db.Create(&user) // 获取结果 fmt.Println(user.ID) // 返回主键 fmt.Println(result.Error) // 返回错误 fmt.Println(result.RowsAffected) // 返回影响的记录数 指定字段创建 // 只创建 Name 字段 db.Select("Name").Create(&user) // INSERT INTO `users` (`name`) VALUES ("张三") // 忽略 Email 字段 db.Omit("Email").Create(&user) // INSERT INTO `users` (`name`,`age`) VALUES ("张三", 25) 批量创建 users := []User{ {Name: "张三", Email: "zhangsan@example.com"}, {Name: "李四", Email: "lisi@example.com"}, {Name: "王五", Email: "wangwu@example.com"}, } // 方式1：传递切片 db. https://blog.911015.com/gorm-study/05.html Mon, 01 Jan 0001 00:00:00 +0000 https://blog.911015.com/gorm-study/05.html 第五章：查询进阶 5.1 高级 Where 条件 字符串条件 // 基本等于 db.Where("name = ?", "张三").Find(&users) // 多条件 db.Where("name = ? AND age >= ?", "张三", 18).Find(&users) // IN 查询 db.Where("name IN ?", []string{"张三", "李四", "王五"}).Find(&users) // LIKE 模糊查询 db.Where("name LIKE ?", "%张%").Find(&users) // BETWEEN db.Where("age BETWEEN ? AND ?", 18, 30).Find(&users) // 时间范围 db.Where("created_at > ?", time.Now().Add(-24*time.Hour)).Find(&users) // IS NULL / IS NOT NULL db.Where("email IS NOT NULL").Find(&users) 结构体条件 // 非零值字段参与查询 db.Where(&User{Name: "张三", Age: 0}). https://blog.911015.com/gorm-study/06.html Mon, 01 Jan 0001 00:00:00 +0000 https://blog.911015.com/gorm-study/06.html 第六章：关联关系 6.1 关联类型概览 GORM 支持四种主要关联关系： 关系 说明 数据库实现 Belongs To 属于（多对一） 外键在子表 Has One 拥有（一对一） 外键在关联表 Has Many 拥有多个（一对多） 外键在关联表 Many To Many 多对多 中间表 6.2 Belongs To（属于） 场景：用户属于一个公司，多对一关系 type Company struct { ID int Name string } type User struct { ID int Name string CompanyID int // 外键 Company Company // 关联 Company } 重写外键 type User struct { ID int Name string CorpID int // 外键字段 Corp Company `gorm:"foreignKey:CorpID"` // 指定外键 } 重写引用 type Company struct { Code string `gorm:"primaryKey"` // 非 ID 主键 Name string } type User struct { ID int Name string CompanyCode string // 外键对应 Code Company Company `gorm:"references:Code"` // 指定引用字段 } 6. https://blog.911015.com/gorm-study/07.html Mon, 01 Jan 0001 00:00:00 +0000 https://blog.911015.com/gorm-study/07.html 第七章：事务处理 7.1 事务基础 事务是数据库操作的基本单元，具有 ACID 特性： 特性 说明 Atomicity（原子性） 事务中的所有操作要么全部成功，要么全部失败 Consistency（一致性） 事务执行前后数据库处于一致状态 Isolation（隔离性） 并发事务相互隔离 Durability（持久性） 事务提交后数据永久保存 7.2 自动事务（Transaction 方法） GORM 的 Transaction 方法会自动处理提交和回滚： err := db.Transaction(func(tx *gorm.DB) error { // 在事务中执行操作，使用 tx 而非 db if err := tx.Create(&user).Error; err != nil { return err // 返回错误自动回滚 } if err := tx.Create(&order).Error; err != nil { return err } return nil // 返回 nil 自动提交 }) if err != nil { fmt. https://blog.911015.com/gorm-study/08.html Mon, 01 Jan 0001 00:00:00 +0000 https://blog.911015.com/gorm-study/08.html 第八章：钩子与回调 8.1 钩子概述 GORM 钩子是在数据库操作生命周期中自动执行的回调函数，可以在创建、查询、更新、删除操作前后插入自定义逻辑。 8.2 支持的钩子 创建相关钩子 钩子 触发时机 BeforeSave 保存（创建/更新）前 BeforeCreate 创建前 AfterSave 保存后 AfterCreate 创建后 查询相关钩子 钩子 触发时机 AfterFind 查询后 更新相关钩子 钩子 触发时机 BeforeSave 保存前 BeforeUpdate 更新前 AfterSave 保存后 AfterUpdate 更新后 删除相关钩子 钩子 触发时机 BeforeDelete 删除前 AfterDelete 删除后 8.3 定义钩子 type User struct { ID uint Name string Password string CreatedAt time.Time UpdatedAt time.Time } // BeforeCreate 创建前钩子 func (u *User) BeforeCreate(tx *gorm.DB) (err error) { u.CreatedAt = time. https://blog.911015.com/gorm-study/09.html Mon, 01 Jan 0001 00:00:00 +0000 https://blog.911015.com/gorm-study/09.html 第九章：迁移与结构管理 9.1 自动迁移概述 GORM 的自动迁移功能可以根据模型定义自动创建或更新数据库表结构。 // 基础用法 db.AutoMigrate(&User{}) // 多个模型 db.AutoMigrate(&User{}, &Product{}, &Order{}) // 指定表名 db.Table("my_users").AutoMigrate(&User{}) 9.2 AutoMigrate 行为 自动迁移会做什么 创建新表 添加缺失的列 创建缺失的索引和外键 自动迁移不会做什么 不会删除不用的列（保护数据） 不会修改列类型（可能导致数据丢失） 不会删除索引 不会重命名列 9.3 迁移方法 普通迁移 db.AutoMigrate(&User{}) 静默迁移（不输出日志） db.Set("gorm:table_options", "ENGINE=InnoDB").AutoMigrate(&User{}) 检查表是否存在 // 检查表是否存在 hasTable := db.Migrator().HasTable(&User{}) hasTable = db.Migrator().HasTable("users") // 检查列是否存在 hasColumn := db.Migrator().HasColumn(&User{}, "Name") // 检查索引是否存在 hasIndex := db.Migrator().HasIndex(&User{}, "idx_name") 9.4 表操作 创建表 db.Migrator().CreateTable(&User{}) // 带有选项 db.Set("gorm:table_options", "ENGINE=InnoDB CHARSET=utf8mb4").Migrator().CreateTable(&User{}) 删除表 db.Migrator().DropTable(&User{}) db.Migrator().DropTable("users") db.Migrator().DropTable("users", "products") 重命名表 db. https://blog.911015.com/gorm-study/10.html Mon, 01 Jan 0001 00:00:00 +0000 https://blog.911015.com/gorm-study/10.html 第十章：性能优化 10.1 连接池优化 核心参数 sqlDB, err := db.DB() if err != nil { log.Fatal(err) } // 最大空闲连接数（建议：连接数 / 2） sqlDB.SetMaxIdleConns(25) // 最大打开连接数（建议：连接数） sqlDB.SetMaxOpenConns(50) // 连接最大生命周期（防止连接过期） sqlDB.SetConnMaxLifetime(30 * time.Minute) // 连接最大空闲时间（Go 1.15+） sqlDB.SetConnMaxIdleTime(10 * time.Minute) 不同场景推荐配置 场景 MaxIdleConns MaxOpenConns ConnMaxLifetime 低并发 Web 10-25 25-50 30m 高并发 API 50-100 100-200 15m 批处理任务 5-10 20-30 60m 微服务 5-15 20-40 30m 10.2 查询优化 只查询需要的字段 // 差：SELECT * db.Find(&users) // 好：只选需要的字段 db.Select("id", "name", "email").Find(&users) // 更好：使用特定结构体 type UserListItem struct { ID uint Name string } var items []UserListItem db. https://blog.911015.com/gorm-study/11.html Mon, 01 Jan 0001 00:00:00 +0000 https://blog.911015.com/gorm-study/11.html 第十一章：高级特性 11.1 上下文（Context）支持 GORM 完全支持 Go 的 context.Context，可用于超时控制、链路追踪等。 超时控制 ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second) defer cancel() // 所有数据库操作都使用上下文 db.WithContext(ctx).Find(&users) db.WithContext(ctx).Create(&user) db.WithContext(ctx).Update("name", "张三") 传递元数据 // 在 context 中存储当前用户ID ctx := context.WithValue(context.Background(), "userID", currentUserID) // 在钩子中使用 func (u *User) BeforeCreate(tx *gorm.DB) error { if userID := tx.Statement.Context.Value("userID"); userID != nil { // 记录创建人 } return nil } 链路追踪 import "go.opentelemetry.io/otel" func TraceMiddleware() func(*gorm.DB) { return func(db *gorm.DB) { ctx := db.Statement.Context tracer := otel. https://blog.911015.com/gorm-study/12.html Mon, 01 Jan 0001 00:00:00 +0000 https://blog.911015.com/gorm-study/12.html 第十二章：插件与扩展 12.1 插件机制概述 GORM 提供了强大的插件机制，允许开发者在数据库操作的不同阶段注入自定义逻辑。 12.2 常用官方插件 Prometheus 监控 import "github.com/wei840222/gorm-prom" db.Use(gormprom.New(gormprom.Config{ DBName: "myapp", // 数据库名称 StartServer: true, // 启动 HTTP 服务 HTTPServerPort: 8080, // 服务端口 })) // 访问 http://localhost:8080/metrics 查看指标 乐观锁 import "gorm.io/plugin/optimisticlock" type Product struct { ID uint Name string Version optimisticlock.Version // 版本号 Stock int } // 更新时自动检查版本号 result := db.Model(&product).Update("stock", product.Stock-1) if result.RowsAffected == 0 { // 版本冲突，需要重试 } 读写分离 import "gorm.io/plugin/dbresolver" db.Use(dbresolver.Register(dbresolver.Config{ Sources: []gorm.Dialector{mysql.Open("write_dsn")}, Replicas: []gorm. https://blog.911015.com/gorm-study/13.html Mon, 01 Jan 0001 00:00:00 +0000 https://blog.911015.com/gorm-study/13.html 第十三章：实战案例 - 博客系统 13.1 项目概述 我们将构建一个完整的博客系统，包含以下功能模块： 用户模块：注册、登录、个人中心 文章模块：发布、编辑、分类、标签 评论模块：文章评论、回复 管理后台：数据统计、内容管理 13.2 项目结构 blog-example/ ├── go.mod ├── main.go ├── config/ │ └── config.go ├── model/ │ ├── base.go │ ├── user.go │ ├── article.go │ ├── category.go │ ├── tag.go │ ├── comment.go │ └── migrate.go ├── dao/ │ ├── user_dao.go │ ├── article_dao.go │ └── comment_dao.go ├── service/ │ ├── user_service.go │ ├── article_service.go │ └── comment_service.go ├── api/ │ ├── handler/ │ │ ├── user_handler. https://blog.911015.com/gorm-study/14.html Mon, 01 Jan 0001 00:00:00 +0000 https://blog.911015.com/gorm-study/14.html 第十四章：常见问题与最佳实践 14.1 错误处理 常见错误类型 import ( "errors" "gorm.io/gorm" ) // 记录不存在 err := db.First(&user, 100).Error if errors.Is(err, gorm.ErrRecordNotFound) { // 处理记录不存在 } // 重复键错误（MySQL） if mysqlErr, ok := err.(*mysql.MySQLError); ok { if mysqlErr.Number == 1062 { // 唯一约束冲突 } } // 外键约束错误 if errors.Is(err, gorm.ErrForeignKeyViolated) { // 外键约束违反 } // 约束验证错误 if errors.Is(err, gorm.ErrCheckConstraintViolated) { // 检查约束违反 } 错误处理最佳实践 type DatabaseError struct { Code string Message string Err error } func (e *DatabaseError) Error() string { return e. https://blog.911015.com/gorm-study/15.html Mon, 01 Jan 0001 00:00:00 +0000 https://blog.911015.com/gorm-study/15.html 第十五章：GORM Gen 类型安全 ORM 15.1 GORM Gen 简介 GORM Gen 是基于 GORM 的代码生成工具，提供类型安全的查询 API，解决了原生 GORM 的以下问题： 原生 GORM 问题 GORM Gen 解决方案 字符串字段名易出错 编译时检查的类型安全 API 缺少 IDE 智能提示 完全的类型推导和补全 重构时容易遗漏 编译错误提示需要修改的地方 复杂查询可读性差 链式调用，流畅表达 15.2 安装与配置 安装 go get -u gorm.io/gen 代码生成配置 package main import ( "gorm.io/driver/mysql" "gorm.io/gen" "gorm.io/gorm" ) func main() { g := gen.NewGenerator(gen.Config{ OutPath: "./dao/query", // 生成代码的输出路径 OutFile: "./dao/query/gen.go", // 输出文件名 // 模型包名 ModelPkgPath: "./dao/model", // 生成模式 Mode: gen. https://blog.911015.com/gorm-study/16.html Mon, 01 Jan 0001 00:00:00 +0000 https://blog.911015.com/gorm-study/16.html 第十六章：综合实战 - 企业级项目 16.1 项目概述 构建一个企业级用户权限+订单管理系统，综合运用前面所有知识点： 用户权限模块：RBAC 权限控制 订单模块：复杂业务逻辑、事务处理 技术栈：GORM + GORM Gen 混用 16.2 系统架构 enterprise-example/ ├── cmd/ │ └── server/ │ └── main.go ├── internal/ │ ├── domain/ # 领域模型 │ │ ├── user.go │ │ ├── role.go │ │ ├── permission.go │ │ └── order.go │ ├── repository/ # 数据访问层 │ │ ├── user_repo.go │ │ └── order_repo.go │ ├── service/ # 业务逻辑层 │ │ ├── user_service.go │ │ └── order_service.