GORM 通过 WithContext 方法提供了 Context 支持

单会话模式

单会话模式通常被用于执行单次操作

  1. db.WithContext(ctx).Find(&users)

持续会话模式

持续会话模式通常被用于执行一系列操作,例如:

  1. tx := db.WithContext(ctx)
  2. tx.First(&user, 1)
  3. tx.Model(&user).Update("role", "admin")

Context 超时

对于长 Sql 查询,你可以传入一个带超时的 context 给 db.WithContext 来设置超时时间,例如:

  1. ctx, cancel := context.WithTimeout(context.Background(), 2*time.Second)
  2. defer cancel()
  3. db.WithContext(ctx).Find(&users)

Hooks/Callbacks 中的 Context

您可以从当前 Statement中访问 Context 对象,例如︰

  1. func (u *User) BeforeCreate(tx *gorm.DB) (err error) {
  2. ctx := tx.Statement.Context
  3. // ...
  4. return
  5. }

Chi 中间件示例

在处理 API 请求时持续会话模式会比较有用。例如,您可以在中间件中为 *gorm.DB 设置超时 Context,然后使用 *gorm.DB 处理所有请求

下面是一个 Chi 中间件的示例:

  1. func SetDBMiddleware(next http.Handler) http.Handler {
  2. return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
  3. timeoutContext, _ := context.WithTimeout(context.Background(), time.Second)
  4. ctx := context.WithValue(r.Context(), "DB", db.WithContext(timeoutContext))
  5. next.ServeHTTP(w, r.WithContext(ctx))
  6. })
  7. }
  8. r := chi.NewRouter()
  9. r.Use(SetDBMiddleware)
  10. r.Get("/", func(w http.ResponseWriter, r *http.Request) {
  11. db, ok := ctx.Value("DB").(*gorm.DB)
  12. var users []User
  13. db.Find(&users)
  14. // 你的其他 DB 操作...
  15. })
  16. r.Get("/user", func(w http.ResponseWriter, r *http.Request) {
  17. db, ok := ctx.Value("DB").(*gorm.DB)
  18. var user User
  19. db.First(&user)
  20. // 你的其他 DB 操作...
  21. })

注意 通过 WithContext 设置的 Context 是线程安全的,参考会话获取详情

Logger

Logger 也可以支持 Context,可用于日志追踪,查看 Logger 获取详情