GORM 与 Gin 项目集成#

数据库依赖注入#

1
type UserRepository struct {
2
  db *gorm.DB
3
}
4

5
func NewUserRepository(db *gorm.DB) *UserRepository {
6
  return &UserRepository{db: db}
7
}
8

9
func (r *UserRepository) FindByID(ctx context.Context, id uint) (User, error) {
10
  var user User
11
  err := r.db.WithContext(ctx).First(&user, id).Error
12
  return user, err
13
}

构造时传入 *gorm.DB，便于测试时替换为 SQLite、事务对象或 SQL mock；不要在 Repository 内部偷偷创建全局连接。

Service 负责事务#

1
type UserService struct {
2
  db    *gorm.DB
3
  users *UserRepository
4
}
5

6
func NewUserService(db *gorm.DB, users *UserRepository) *UserService {
7
  return &UserService{db: db, users: users}
8
}
9

10
func (s *UserService) CreateUser(ctx context.Context, user User) error {
11
  return s.db.WithContext(ctx).Transaction(func(tx *gorm.DB) error {
12
    if err := tx.Create(&user).Error; err != nil {
13
      return err
14
    }
15
    return tx.Create(&UserAudit{UserID: user.ID, Action: "created"}).Error
16
  })
17
}

如果 Repository 需要参与事务，可以让 Service 为事务创建绑定了 tx 的 Repository，或让 Repository 方法接收当前数据库句柄；关键是所有操作必须在同一个事务对象上。

Handler 传递请求上下文#

1
func (h *UserHandler) Get(c *gin.Context) {
2
  id, err := strconv.ParseUint(c.Param("id"), 10, 64)
3
  if err != nil {
4
    c.JSON(http.StatusBadRequest, gin.H{"error": "invalid id"})
5
    return
6
  }
7

8
  user, err := h.service.GetUser(c.Request.Context(), uint(id))
9
  if errors.Is(err, ErrUserNotFound) {
10
    c.JSON(http.StatusNotFound, gin.H{"error": "user not found"})
11
    return
12
  }
13
  if err != nil {
14
    c.Error(err)
15
    return
16
  }
17

18
  c.JSON(http.StatusOK, user)
19
}

请求结束或取消时，数据库查询可以感知上下文。统一错误处理中间件负责把领域错误转换为 HTTP 响应，Handler 不要泄露数据库 DSN 或驱动错误详情。

启动与关闭#

1
func run() error {
2
  db, err := OpenDatabase()
3
  if err != nil {
4
    return err
5
  }
6
  sqlDB, err := db.DB()
7
  if err != nil {
8
    return err
9
  }
10
  defer sqlDB.Close()
11

12
  if err := db.AutoMigrate(&User{}, &UserAudit{}); err != nil {
13
    return err
14
  }
15

16
  r := gin.New()
17
  r.Use(gin.Logger(), gin.Recovery())
18
  // 注册 handler、路由和服务
19

20
  server := &http.Server{
21
    Addr:              ":8080",
22
    Handler:           r,
23
    ReadHeaderTimeout: 5 * time.Second,
24
    ReadTimeout:       10 * time.Second,
25
    WriteTimeout:      10 * time.Second,
26
    IdleTimeout:       60 * time.Second,
27
  }
28
  return server.ListenAndServe()
29
}

生产项目应使用 signal.NotifyContext 监听退出信号，先停止接收新请求，再等待在途请求完成，最后关闭 sql.DB。

测试策略#

Repository 集成测试使用临时 SQLite 或测试 MySQL，不依赖开发者本机数据。
Service 测试重点验证事务成功、失败回滚和并发冲突。
Handler 测试验证参数校验、HTTP 状态码和错误映射。
原生 SQL 和方言特性必须在目标数据库上测试，SQLite 不能证明 MySQL/PostgreSQL 行为一致。
测试结束清理数据库文件、连接和临时数据。

常见反模式#

全局 var DB *gorm.DB 被所有包直接读写。
Handler 中直接 db.Where(...).Find(...)，导致业务规则和持久化散落。
每个请求 gorm.Open 一次，绕过连接池复用。
用 context.Background() 替代请求上下文，导致取消和超时失效。
把数据库错误原样返回给客户端。
依赖启动时 AutoMigrate 承担全部生产迁移。

与现有 Gin 笔记的关系#

Gin 目录原有的数据库连接示例已被提炼到：

Gin 的路由、中间件、验证和响应格式继续参考 Gin 框架等原有笔记。

HikariTish

GORM 与 Gin 项目集成#

推荐分层#

数据库依赖注入#

Service 负责事务#

Handler 传递请求上下文#

启动与关闭#

测试策略#

常见反模式#

与现有 Gin 笔记的关系#

官方资料#

继续阅读

换条路线

HikariTish

GORM 与 Gin 项目集成#

推荐分层#

数据库依赖注入#

Service 负责事务#

Handler 传递请求上下文#

启动与关闭#

测试策略#

常见反模式#

与现有 Gin 笔记的关系#

官方资料#

分享文章

沿着主题读

换条路线