如何优雅地处理 Web 服务中的错误

Question

我正在使用 gin 编写一个简单的 REST API。我已经阅读了许多关于在 go 中减少错误处理重复性的帖子和文本，但我似乎无法完全理解如何在 gin 处理程序中执行此操作。

我的服务所做的只是对数据库运行一些查询并将结果作为 JSON 返回，因此典型的处理程序如下所示

func DeleteAPI(c *gin.Context) {
    var db = c.MustGet("db").(*sql.DB)
    query := "DELETE FROM table WHERE some condition"
    tx, err := db.Begin()
    if err != nil {
        c.JSON(400, gin.H{"error": err.Error()})
        return
    }
    defer tx.Rollback()
    result, err := tx.Exec(query)
    if err != nil {
        c.JSON(400, gin.H{"error": err.Error()})
        return
    }
    num, err := result.RowsAffected()
    if err != nil {
        c.JSON(400, gin.H{"error": err.Error()})
        return
    }
    err = tx.Commit()
    if err != nil {
        c.JSON(400, gin.H{"error": err.Error()})
        return
    }
    c.JSON(200, gin.H{"deleted": num})
}

如您所见，即使是这个简单的处理程序也会重复相同的“if err != nil”模式四次。在基于“选择”的 API 中，我有两倍的 API，因为在绑定输入数据时可能会出现错误，而在将响应编组为 JSON 时会出现错误。有没有好办法让这个更干？

Answer 1

您可以使用助手使其稍微更干燥：

func handleError(c *gin.Context, err error) bool {
    if err != nil {
        c.JSON(400, gin.H{"error": err.Error()})
        return true
    }
    return false
}

用作：

err = tx.Commit()
if handleError(c,err) {
    return
}

这只会将错误处理行数从 4 行减少到 3 行，但它确实抽象掉了重复的逻辑，允许您将重复的错误处理更改为一个处理错误的地方而不是任何地方（例如，如果您想添加错误日志记录，或更改错误响应等）

Answer 2

我通常的方法是使用包装函数。这样做的好处是（相对于 Adrian 的答案——这也是一个很好的答案，顺便说一句），将错误处理以更 Go-惯用的形式（return result, err，而不是用handleError(err) 类型调用乱扔代码） ，同时仍将其合并到一个位置。

func DeleteAPI(c *gin.Context) {
    num, err := deleteAPI(c)
    if err != nil {
        c.JSON(400, gin.H{"error": err.Error()})
        return
    }
    c.JSON(200, gin.H{"deleted": num})
}

func deleteAPI(c *gin.Context) (int, error) {
    var db = c.MustGet("db").(*sql.DB)
    query := "DELETE FROM table WHERE some condition"
    tx, err := db.Begin()
    if err != nil {
        return 0, err
    }
    defer tx.Rollback()
    result, err := tx.Exec(query)
    if err != nil {
        return 0, err
    }
    num, err := result.RowsAffected()
    if err != nil {
        return 0, err
    }
    err = tx.Commit()
    if err != nil {
        return 0, err
    }
    return num, nil
}

对我（以及一般来说，对于 Go 程序员）来说，优先考虑代码的可读性而不是 DRY。在我看来，在三个选项（您的原始版本、Adrian 的版本和我的版本）中，我的版本更具可读性，原因很简单，错误以完全惯用的方式处理，并且它们冒泡到顶部处理程序。如果您的控制器最终调用其他返回错误的函数，则同样的方法也同样有效。通过将所有错误处理移至最顶层函数，您可以在所有其余代码中摆脱错误处理混乱（除了简单的 'if err != nil { return err }` 构造）。

同样值得注意的是，这种方法可以与 Adrian 的强大结合，特别是与多个处理程序一起使用时，通过更改“包装”功能：

func DeleteAPI(c *gin.Context) {
    result, err := deleteAPI(c)
    if handleError(c, err) {
        return
    }
    c.JSON(200, gin.H{"deleted": num})
}