作为golang里面最受欢迎的web开发框架Gin一直以高性能和简单著称,官方提供的文档,甚至一个小时就能看完。笔者也是gin的拥趸,时常用gin来开发RESTfulApi。不得不说golang是一门开发速度和性能相对平衡的语言,性能和开发速度都是杠杠的。
golang的错误处理一直以来都被人吐槽,虽然官方说2.0的时候会解决,但一切还尚未可知。我们在写业务逻辑的时候每一个错误都必须去处理不免觉得有些繁琐。幸好golang可以函数式编程,可以对代码中的一些异常和错误统一进行处理,返回统一的错误格式。
一个团队应当有一份 RESTful API 的规范,而在规范中应该规范响应格式,包括所有错误响应的格式。比如我们规定一个简单错误返回格式。
{
首先我们创建一个gin的项目。如官方示例如下:
package
在HandlerFunc里面写自己业务逻辑时候,我们每一步都需要做错误处理,那么可不可以简化这个流程,所有的错误处理留给HandlerFunc之后呢?
我们先看看gin的HandlerFunc,没有任何返回值。
type HandlerFunc func(*Context)
带着这个思考我们定义一个type
type
这样一来我们的HandlerFunc就变成一个有返回值的函数,那么有什么办法让gin的HandlerFunc支持我们定义的这个函数格式呢?这时候我们想到了在golang里面函数是一等公民,我们可以把函数作为参数或者返回值。我们试着把这个定义好HandlerFunc作为一个参数传进函数返回一个gin支持的HandlerFunc。下面我们来尝试一下。代码如下:
package
编译执行,然后访问http://127.0.0.1:8080/ping我们会发现和原来的结果一模一样。既然我们在wrapper函数中执行了handler,并且这个函数有返回值,那么一切问题就很好解决了,我们可以在这里拿到错误然后进行统一的错误处理并且返回统一的格式。我们按照先前的规定定义一个结构体。并且让他实现Error的接口。
// api错误的结构体
定义几个错误处理的函数
const
这时候我们开始统一错误处理了。代码如下
func
写一个伪代码试试
func
重启一下服务访问一下http://127.0.0.1:8080/ping
{
不出所料。当然我们还需要对404也处理一下,我们定义一个方法。
func
404的时候用该方法,NoMethod和NoRoute为gin提供,详细看源代码。
func
访问一个不存在的url http://127.0.0.1:8080/user
{
当当当,完成。