错误处理

概述

错误处理这里并非指 error 堆栈处理，错误管理等，而是指 HTTP 的错误处理。

使用示例

我们来模拟当 error 为 *errors.CodeMsg 类型时，以 code-msg 格式响应错误。

  1. package main
  3. import (
  4.     "go/types"
  5.     "net/http"
  7.     "github.com/zeromicro/go-zero/rest"
  8.     "github.com/zeromicro/go-zero/rest/httpx"
  9.     "github.com/zeromicro/x/errors"
  10.     xhttp "github.com/zeromicro/x/http"
  11. )
  13. func main() {
  14.     srv := rest.MustNewServer(rest.RestConf{
  15.         Port: 8080,
  16.     })
  17.     srv.AddRoute(rest.Route{
  18.         Method:  http.MethodPost,
  19.         Path:    "/hello",
  20.         Handler: handle,
  21.     })
  22.     defer srv.Stop()
  23.     // httpx.SetErrorHandler 仅在调用了 httpx.Error 处理响应时才有效。
  24.     httpx.SetErrorHandler(func(err error) (int, any) {
  25.         switch e := err.(type) {
  26.         case *errors.CodeMsg:
  27.             return http.StatusOK, xhttp.BaseResponse[types.Nil]{
  28.                 Code: e.Code,
  29.                 Msg:  e.Msg,
  30.             }
  31.         default:
  32.             return http.StatusInternalServerError, nil
  33.         }
  34.     })
  35.     srv.Start()
  36. }
  38. type HelloRequest struct {
  39.     Name string `json:"name"`
  40. }
  42. type HelloResponse struct {
  43.     Msg string `json:"msg"`
  44. }
  46. func handle(w http.ResponseWriter, r *http.Request) {
  47.     var req HelloRequest
  48.     if err := httpx.Parse(r, &req); err != nil {
  49.         httpx.Error(w, err)
  50.         return
  51.     }
  53.     if req.Name == "error" {
  54.         // 模拟参数错误
  55.         httpx.Error(w, errors.New(400, "参数错误"))
  56.         return
  57.     }
  59.     httpx.OkJson(w, HelloResponse{
  60.         Msg: "hello " + req.Name,
  61.     })
  62. }
  1. $ curl --location '127.0.0.1:8080/hello' \
  2. --header 'Content-Type: application/json' \
  3. --data '{
  4.     "name":"go-zero"
  5. }'
  6. {"msg":"hello go-zero"}
  8. $ curl --location '127.0.0.1:8080/hello' \
  9. --header 'Content-Type: application/json' \
  10. --data '{
  11.     "name":"error"
  12. }'
  13. {"code":400,"msg":"参数错误","data":{}}
错误处理 - 图1温馨提示

这里仅演示 httpx.SetErrorHandler 的用法，如需指定 HTTP 统一响应格式请参考 《统一响应格式》