golang进阶(六)——restful开发优雅处理error

前言

golang的error处理一直被人诟病，其实通过设计模式可以很好的处理error，这里就以restful开发为例讲下error优雅的处理

resuful开发中，error处理有两个目的，一可以将错误信息返回给用户，二要方便调试，为了达到优雅还要一点，不要到处都是各种if语言

当然作为优雅的代码还有一点要保证，就是尽量不写重复的代码

panic处理

在这里我们把panic处理一下，把panic的if判断也封装到一个方法里，并且包裹上堆栈信息（这里用到了github.com/pkg/errors包，具体使用在这里就不赘述了，可以看github上的文档），方便调试：

func ThrowError(err error) {
    if err != nil {
        panic(errors.WithStack(err))
    }
}

我们调用的时候相当简单

// MarshalJson 把对象以json格式放到response中
func MarshalJson(w http.ResponseWriter, v interface{}) {
    data, err := json.Marshal(v)
    ThrowError(err)
    w.Write(data)
}

// UnMarshalJson 从request中取出对象
func UnMarshalJson(req *http.Request, v interface{}) {
    result, err := ioutil.ReadAll(req.Body)
    err = errors.New("TEST")
    ThrowError(err)
    json.Unmarshal([]byte(bytes.NewBuffer(result).String()), v)
}

这样就把一个错误逐级上抛，直到遇到处理的recover

revocer处理

我们把相应的recover也封装了一下

func CatchError(w http.ResponseWriter, req *http.Request) {
    if r := recover(); r != nil {
        resp := &model.Resp{Code: "9001", Msg: r.(error).Error()}
        MarshalJson(w, resp)
        fmt.Printf("%+v\n", r.(error))
    }
}

把错误返回给用户，并且打印错误的信息，包括堆栈

统一处理

作为restful统一处理的地方，一般都是ServeHttp方法，但是如果用了第三方mux，强行改源码不太雅观，而且mux也有升级的时候，总不能升级一次改一次吧，那么这里使用一种包装的方法

type MyRouter struct {
    *mux.Router
}

func (r *MyRouter) ServeHTTP(w http.ResponseWriter, req *http.Request) {
    defer tools.CatchError(w, req)
    r.Router.ServeHTTP(w, req)
}

func NewAPIMux() http.Handler {
    r := &MyRouter{mux.NewRouter()}
    s := r.PathPrefix("/api").Subrouter()
    initUserApi(s)

    r.PathPrefix("/").Handler(http.StripPrefix("/", http.FileServer(http.Dir("web/"))))
    return r
}

如此这般，error就优雅的处理了，无论任何地方，只需要按业务调用ThrowError方法，客户端就可以收到错误信息，服务端还可以同时打印错误的堆栈信息

示例输出