处理跨层上下文取消

问题内容

我正在开发一个带有控制器、服务、存储库等的分层后端 API。

上下文

这些层中的每个方法都采用 context.Context 作为其包含请求上下文的第一个参数。这很方便，因为任何方法都可以访问各种与请求相关的数据（例如correlationID等）

每个请求上下文都有一个由下面的 TimeoutMiddleware 设置的超时：

func TimeoutMiddleware(timeoutFn func(*gin.Context) time.Duration) gin.HandlerFunc {
    return func(c *gin.Context) {
        timeout := timeoutFn(c)
        ctx, cancel := context.WithTimeout(c.Request.Context(), timeout)
        defer cancel()

        c.Request = c.Request.WithContext(ctx)

        c.Next()
    }
}

func TimeoutFn(c *gin.Context) time.Duration {
    return conf.HTTPRouter.DefaultContextTimeout
}

挑战

这个想法是在请求上下文超时时优雅地停止任何正在进行的操作。 根据我对上下文和并发性的理解（非常少），我构建了这个辅助函数：

package helpers

import "context"

// Checks for context cancellation and returns ctx.Err() if canceled.
func HandleContextCancel(ctx context.Context) error {
    select {
    case <-ctx.Done(): // If the context is canceled
        return ctx.Err() // return immediately with the canceled error.

    default: 
        return nil // Continue with the normal processing.
    }
}

理论上，如果我想尽快停止任何操作，我需要在应用程序中每个方法的开头调用此函数，如下所示：< /p>

func DoSomething(ctx context.Context, ...) resterrors.RestErr {
if err := helpers.HandleContextCancel(ctx); err != nil {
    return resterrors.NewRequestTimeoutError(
        fmt.Errorf("DoSomething: %w", err),
    )
}
// ...

同时，我知道在访问数据库的存储库中，大多数函数都需要上下文，例如 Query、QueryRow、Exec ...，如下所示：

rows, err := pgclient.GetSession().Query(ctx, query, param1, ...)

因此，每次在上面的行中出现错误时，我必须检查错误是否不是由于上下文取消所致，而不是仅返回 internal_server_error 和错误消息，如下所示：

rows, err := pgclient.GetSession().Query(ctx, query, param1, ...)
if err != nil {
   return helpers.MapRepoError("DoSomething: Query Error:", err)
}

func MapRepoError(location string, err error) resterrors.RestErr {
    if errors.Is(err, context.DeadlineExceeded) {
        return resterrors.NewRequestTimeoutError(
            fmt.Errorf("%s request_timeout", location),
        )
    }
    return resterrors.NewInternalServerError(
        fmt.Errorf("%s %w", location, err),
    )
}

使用 HandleContextCancel 函数看起来有点多余，您对此有何看法？

正确答案

您不需要 HandleContextCancel 函数，您可以简单地执行以下操作：

if ctx.Err()!=nil {
  // Context timed out or canceled. Return
  return ctx.Err()
}

如果您的其他错误处理函数正确地包装了此错误（即它们实现了 Unwrap() error 方法，那么您可以在顶层检查错误是否包含超时/取消错误，并决定您要处理什么类型的错误喜欢返回。你不必每一层都这样做。

以上就是处理跨层上下文取消的详细内容，更多请关注编程网其它相关文章！