Go语言错误处理的优雅实现

查看原文

其他

Go语言错误处理的优雅实现

Original 苦瓜先生 Go开发大全 2021-07-20

收录于话题

#golang 10

#错误处理 1

（给Go开发大全加星标）

【导读】go语言中错误处理一直是一大槽点，本文介绍了作者在错误处理方面的良好实践。

每隔一段时间，各个论坛上都会出现一些关于go语言错误处理的帖子，并且针对go语言的错误处理似乎每个人都有一套自己的看法。有些人说它们应该更像throwable exception 那样（Go开发大全注：该观点类似Java语言中throw exception异常处理，发表该观点的人推测有Java开发背景），另外一些人则更喜欢sum types模式的错误处理，比如类似rust语言中的Result<T, E>错误处理模式。虽然我在typecript中的错误处理方式 https://dev.to/duunitori/mimicing-rust-s-result-type-in-typescript-3pn1

采用了sum types的方法，但我还是喜欢go语言的处理错误的方式。

话虽如此，要真正弄清楚如何正确的处理错误可能还是需要花一点功夫的（无论使用sum type模式还是exception模式）。在这篇文章中，我将介绍go语言中http.Handler中的错误处理方法.

典型示例

如果你想在不对error做任何处理的情况下直接以原始形式返回，那么直接返回的error结果可能让人难以理解且十分困惑。通常的示例代码是这样的。

func copyfile(src, dst) error {
 fsrc, err := os.Open(src)
 if err != nil {
  return err
 }
 defer fsrc.Close()

 fdst, err := os.Open(src)
 if err != nil {
  return err
 }
 defer fdst.Close()

 err := io.Copy(fdst, fsrc)

 return err
}

我很肯定你们大多数人都见过这样的例子，而且这种错误处理还算好的。现在我们来看看可能会出现在http.Hanlder中的类似的情况。

func handleThing(w http.ResponseWriter, r *http.Request) {
 // Our path is something like /thing/3
 id, err := idFromPath(r.URL.Path)
 if err != nil {
  http.Error(w, http.StatusText(http.StatusBadRequest), http.StatusNotFound)
  return
 }

 thing, err := store.GetThingByID(id)
 if err != nil {
  // The error might be sql.NoRows, or it might be something else.
  if store.IsNotFoundErr(err) {
   http.Error(w, http.StatusText(http.StatusNotFound), http.StatusNotFound)
   return
  }
  log.Printf("Failed to get a thing: %v", err)
  http.Error(w, http.StatusText(http.StatusInternalServerError), http.StatusInternalServerError)
  return
 }

 acc := AccountFromRequest(r)
 if acc == nil {
  // No account attached to the request's session -> permission denied.
  http.Error(w, http.StatusText(http.StatusForbidden), http.StatusForbidden)
  return
 }

 has, err := thing.HasPermissionToView(acc)
 if err != nil {
  // For some reason, we failed to check permissions. Better log it.
  log.Printf("Failed to check permissions: %v", err)
  http.Error(w, http.StatusText(http.StatusInternalServerError), http.StatusInternalServerError)
  return
 }

 if !has {
  // Permission denied.
  http.Error(w, http.StatusText(http.StatusForbidden), http.StatusForbidden)
  return
 }

 // All good, send data to the client.
 respond(w, r, decodeThing(thing))
}

上面代码中出现的部分函数定义需要读者去自行补充，但函数要实现的功能有以下几点：

从URL中提取ID参数
使用该ID进行数据库查询
检查客户端是否有权限查看该响应结果
返回结果给客户端

这个函数功能可能会在其他资源类型对象上也需要实现，所以很快就会出现重复需求。想象一下，如果对foo、bar、account等资源也需要做同样的代码实现，那应该怎么办呢？而Django中要实现上面的功能，可以选择这样实现代码

def handle_thing(request):
    id = id_or_bad_request(request)
    thing = thing_or_404(id)

    account = account_or_forbidden(request)

    if not thing.has_permission(account):
        raise Forbidden()

    return JsonResponse(...)

现在这段代码看起来就简单多了，上面的python代码利用了id_or_bad_request, thing_or_404和account_or_forbidden函数来响应请求并且在请求出错时直接抛出错误，并且将对这些错误的处理交由上层逻辑来实现.比如用正确的状态代码来响应结果的同时记录错误堆栈信息。

开始优化go语言代码

我们先在脑海里记下上面的python代码，并想一想如何参考上述的python代码来优化我们的go语言代码中的错误处理逻辑。优化的思路如下：

当代码中出现错误时，我们只想把错误抛出到上层某个地方。这些错误通常是客户端错误，但是不一定百分百就是客户端错误。我们假设也许上层逻辑能解析和处理这些错误
如果错误不是客户端错误，那就需要用日志记录下来错误信息
上层调用者能够响应和处理http.Error的调用。

Golang的错误处理 https://blog.golang.org/error-handling-and-go

中阐述了一些关于在http handler中处理错误的常见做法，并且给出了下面的例子。

func viewRecord(w http.ResponseWriter, r *http.Request) error {
    c := appengine.NewContext(r)
    key := datastore.NewKey(c, "Record", r.FormValue("id"), 0, nil)
    record := new(Record)
    if err := datastore.Get(c, key, record); err != nil {
        return err
    }
    return viewTemplate.Execute(w, record)
}

// NOTE: the following is my adapted version from the example's ServeHTTP to a
// middleware/wrapper

type HandlerE = func(w http.ResponseWriter, r *http.Request) error

func WithError(h HandlerE) http.HandlerFunc {
 return func(w http.ResponseWriter, r *http.Request) {
  if err := h(w, r); err != nil {
   http.Error(w, err.Error(), 500)
  }
 }
}

上面的代码段通过对http.Error的函数调用解决了我们刚提出的问题。但有时我们不想把错误的详细信息暴露给客户端用户，所以我会用一个通用错误，诸如内部服务器错误信息来代替实际出错信息。另外，记录服务器内部错误的原因也很重要，否则就无法排查出具体的错误原因。

采用WithError函数封装

我们希望从实际的http.Handler调用中返回错误，具体的需求是在错误出现时能够向客户端返回处理后的错误信息，并且在返回客户端错误的同时能够记录下错误堆栈信息。代码实现如下。

func WithError(h HandlerE) http.HandlerFunc {
 return func(w http.ResponseWriter, r *http.Request) {
  if err := h(w, r); err != nil {

   if is404err(err) {
    http.Error(w, "not found", 404)
    return
   }

   if isBadRequest(err) {
    http.Error(w, "bad request", 400)
    return
   }

   // Some other special cases...
   // ...

   log.Printf("Something went wrong: %v", err)

   http.Error(w, "Internal server error", 500)
  }
 }
}

代码注释中的那些"其他特殊场景"的需求情况可能会多种多样，而且对于某些hander来说可能会变得具有特异性。另外，我们还需要实现诸如is404err和isBadRequest的其他需求，这些需求都需要我们去实现相应的handler。面对这种情况我们可以利用go语言中的接口interface类型来进行抽象处理。

type ErrorResponder interface {
    // RespondError writes an error message to w. If it doesn't know what to
    // respond, it returns false.
 RespondError(w http.ResponseWriter, r *http.Request) bool
}

有了这个接口，我们可以做很多事情，比如，现在我们的WithError函数变成了这样：


func WithError(h HandlerE) http.HandlerFunc {
 return func(w http.ResponseWriter, r *http.Request) {
  if err := h(w, r); err != nil {
   if er, ok := err.(ErrorResponder); ok {
    if er.RespondError(w, r) {
     return
    }
   }

   log.Printf("Something went wrong: %v", err)

   http.Error(w, "Internal server error", 500)
  }
 }
}

注意到前一节中提到的“特殊场景”是如何消失的吗？它们现在只是ErrorResponder的另一个接口实现。现在Not found和Bad request错误形式如下：


// BadRequest error responds with bad request status code, and optionally with
// a json body.
type BadRequestError struct {
 err  error
 body interface{}
}

func BadRequest(err error) *BadRequestError {
 return &BadRequestError{err: err}
}

func BadRequestWithBody(body interface{}) *BadRequestError {
 return &BadRequestError{body: body}
}

func (e *BadRequestError) RespondError(w http.ResponseWriter, r *http.Request) bool {
 if e.body == nil {
  http.Error(w, http.StatusText(http.StatusBadRequest), http.StatusBadRequest)
 } else {
  w.WriteHeader(http.StatusBadRequest)

  w.Header().Set("Content-Type", "application/json")
  err := json.NewEncoder(w).Encode(e.body)

  if err != nil {
   log.Printf("Failed to encode a response: %v", err)
  }
 }

 return true
}

func (e *BadRequestError) Error() string {
 return e.err.Error()
}

// Maybe404Error responds with not found status code, if its supplied error
// is sql.ErrNoRows.
type Maybe404Error struct {
 err error
}

func Maybe404(err error) *Maybe404Error {
 return &Maybe404Error{err: err}
}

func (e *Maybe404Error) Error() string {
 return fmt.Sprintf("Maybe404: %v", e.err.Error())
}

func (e *Maybe404Error) Is404() bool {
 return errors.Is(e.err, sql.ErrNoRows)
}

func (e *Maybe404Error) RespondError(w http.ResponseWriter, r *http.Request) bool {
 if !e.Is404() {
  return false
 }

 http.Error(w, http.StatusText(http.StatusNotFound), http.StatusNotFound)
 return true
}

通过参考上面的示例代码，可以轻松地写出诸如处理权限错误的ErrorResponders或其他错误处理函数。

目前进度

通过ErrorResponder接口和WithError函数，我们可以将之前的handleThing处理程序优化如下：

func handleThing(w http.ResponseWriter, r *http.Request) error {
 // Our path is something like /thing/3
 id, err := idFromPath(r.URL.Path)
 if err != nil {
  // Literally bad request. We could use BadRequestWithBody to
  // respond with a fancy information for the client.
  return BadRequest(err)
 }

 thing, err := store.GetThingByID(id)
 if err != nil {
  // Likely a not found issue, but something else might have gone wrong.
  // Maybe404Error handles both cases.
  return Maybe404(err)
 }

 acc := AccountFromRequest(r)
 if acc == nil {
  // No account attached to the request. Client needs to authenticate.
  return AuthenticationRequired()
 }

 has, err := thing.HasPermissionToView(acc)
 if err != nil {
  // Something actually went wrong. Error will be logged and 500 message
  // sent to the client.
  return err
 }

 if !has {
  // Client doesn't have permission to view this resource.
  return PermissionDenied()
 }

 // All good, send data to the client.
 respond(w, r, decodeThing(thing))
}

func main() {
 ...
 mux.Handle("/thing/", WithError(handleThing))
 ...
}

现在的代码看起来就好多了! 我将把整合认证和权限检查的需求作为练习项目留给读者。另一个练习项目是在WithError函数中优化日志记录功能，使得能够记录的错误信息不仅仅是 "Something went wrong: error"这类信息。比如新的日志记录功能要求能够记录请求路径和请求发起人，或者能够记录访问id？

有了上面的这些功能实现，我们就可以

把错误返回到上层代码逻辑中
上层调用者对http.Error的调用更加清晰
客户端之外的错误也可以记录下来

文末总结

有时候,我会惊讶于go语言的错误类型是如此的简单却又如此强大。但有时候，我又会因为想不出如何高效而又正确的使用go语言的错误类型而郁闷不已。在这篇博文中提出的解决方案真的很简单，但也用了我很长时间才弄明白。

我也写过不少关于rust的文章,我有时候会想也许我会在rust语言中实现比go中更好的错误处理方案，并且可能只需要很短时间就可以想出解决方案。但rust中的解决方案可能会是次优的，因为会对错误进行过早的优化处理。关于rust语言思想可参考https://yxonic.github.io/rust-zen/

我写过很多那种 "记录错误（log error），调用http.Error ，然后返回 (return) "类型的的错误处理方法。这种模式的错误处理让我不得不忍受单调且重复的痛苦。而利用rust，我可能会过早的寻求通用解决方案，但是目前的通用解决方案却很糟糕。

最后，我注意到，经验尚浅的开发人员可能不会有勇气去写一个会在整个项目中都会用到WithError封装器。他们希望他们所使用的框架或工具能像django一样提供这样的通用功能实现。又或者他们仅仅处于对go的了解仅仅停留在语言语法层面，而不了解go的底层逻辑和它的语言哲学。这一切都难以定论，而这篇文章也只是对我自己的开发经验做了一个总结反馈而已。

- EOF -

宾曰语云被法学教授投诉：严重侵权，“违法犯罪”！

当“上帝”变为“老天爷”

京东Plus的隐藏特权，很多会员都没领取，白交了会员费...

呼吁四川大学澄清：1998年1月，川大有多少个“姜涛与爱人程月玲”？

二湘：朱令去世一周年，清华学子控诉清华在朱令案中的冷血和无耻