背景

　　基于现在微服务或者服务化的思想，我们大部分的业务逻辑处理函数都是长这样的：

　　比如grpc服务端：

　　grpc客户端：

　　有些服务我们需要把它包装为RESTful形式的接口，一般需要经历以下步骤：

　　指定HTTP方法、URL

　　鉴权

　　参数绑定

　　处理请求

　　处理响应

　　可以发现，参数绑定、处理响应几乎都是一样模板代码，鉴权也基本上是模板代码(当然有些鉴权可能比较复杂)。

　　而Ginrest库就是为了消除这些模板代码，它不是一个复杂的框架，只是一个简单的库，辅助处理这些重复的事情，为了实现这个能力使用了Go1.18的泛型。

　　特性

　　这个库提供以下特性：

　　封装RESTful请求响应

　　封装RESTful请求为标准格式服务

　　封装标准格式服务处理结果为标准RESTful响应格式：Rsp{code, msg, data}

　　默认使用统一数字错误码格式：[0, 4XXXX, 5XXXX]

　　默认使用标准错误格式：Error{code, msg}

　　默认统一状态码[200, 400, 500]

　　提供Recovery中间件，统一panic时的响应格式

　　提供SetKey()、GetKey()方法，用于存储请求上下文(泛型)

　　提供ReqFunc()，用于设置Req(泛型)

　　使用例子

　　首先我们实现两个简单的服务：

　　然后使用Gin+Ginrest包装为RESTful接口：

　　可以看到Register()里面每个接口都只需要一行代码!

　　运行上面代码，然后尝试访问接口，可以看到返回结果：

　　实现原理

　　Do()和DoOpt()都会转发到do()，它其实是一个模板函数，把脏活累活给处理了：

　　功能列表

　　处理请求

　　用于把一个标准服务封装为一个RESTfulgin.HandlerFunc，对应Do()、DoOpt()函数。

　　DoOpt()相比于Do()多了一个opts参数，因为很多rpc框架客户端都有一个opts参数作为结尾。

　　还有一个BindJSON()，用于把请求体包装为一个Req结构体：

　　如果无法使用Do()和DoOpt()则可以使用此方法。

　　处理响应

　　用于把rsp、error、errcode、errmsg等数据封装为一个JSON格式响应体，对应ProcessRsp()、Success()、Failure()、FailureCodeMsg()函数。

　　比如ProcessRsp()需要带上rsp和error，这样业务里面就不需要再写如下模板代码了：

　　响应格式统一为：

　　Success()用于处理成功情况：

　　其余同理。

　　如果无法使用Do()和DoOpt()则可以使用这些方法。

　　处理错误

　　一般我们都需要在出错时带上一个业务错误码，方便客户端处理。因此我们需要提供一个合适的error类型：

　　我们提供了一些函数方便使用Error，对应NewError()、ToError()、ErrCode()、ErrMsg()、ErrEqual()函数。

　　比如NewError()生成一个Error类型error：

　　请求上下文操作

　　Gin的请求是链式处理的，也就是多个handler顺序的处理一个请求，比如：

　　这个接口经历了Verify和ginrest.Do两个handler，其中我们在Verify的时候通过认证知道了用户的身份信息(比如uid)，我们希望把这个uid存起来，这样可以在业务逻辑里使用。

　　因此我们提供了SetKey()、GetKey()两个函数，用于存储请求上下文：

　　比如认证通过后我们可以设置UID到上下文，然后在reqFunc()里读取设置到req里面(下面介绍)。

　　请求结构体处理

　　上面我们设置了请求上下文，比如UID，但是其实我们并不知道具体这个UID是需要设置到req里的哪个字段，因此我们提供了一个回调函数ReqFunc()，用于设置Req：

　　注

　　如果这个库的设计不符合具体的业务，也可以按照这种思路去封装一个类似的库，只要尽可能的统一请求、响应的格式，就可以减少很多重复的模板代码。