RESTFUN API读取和返回HTTP请求

核心：

·如何读取HTTP请求数据
·如何返回数据
·如何定制业务的返回格式

读取和返回参数：

在业务开发过程中，需要读取请求参数（消息体和HTTTP Header），经过业务处理后返回指定格式的消息。

读取HTTP信息：

·Param()：返回URL的参数值，例如
router.GET(“/user/:id”,func(c *gin.Context) {
id:=c.Param(“id”)
})
·Query()：读取URL的地址参数，例如
// GET /path?id=1234&name=Manu&value=
c.Query(“id”) == “1234”
c.Query(“name”) == “Manu”
c.Query(“value”) == “”
c.Query(“wtf”) == “”
·DefaultQuery()：类似 Query()，但是如何key不存在，会返回默认值，例如//GET /?name=Manu&lastname=
c.DefaultQuery(“name”, “unknown”) == “Manu”
c.DefaultQuery(“id”, “none”) == “none”
c.DefaultQuery(“lastname”, “none”) == “”
·Bind()：检查 Content-Type 类型，将消息体作为指定的格式解析到 Go struct 变量中。apiserver 采用的媒体类型是 JSON，所以 Bind() 是按 JSON 格式解析的。
·GetHeader()：获取 HTTP 头。

返回HTTP消息：

因为要返回指定的格式，apiserver 封装了自己的返回函数，通过统一的返回函数 SendResponse 来格式化返回。

增加返回函数：

API 返回入口函数，供所有的服务模块返回时调用，所以这里将入口函数添加在 handler 目录下，handler/handler.go 的源码为：
package handler

import (
“net/http”

"apiserver/pkg/errno"

"github.com/gin-gonic/gin"

)

type Response struct {
Code int json:"code"
Message string json:"message"
Data interface{} json:"data"
}

func SendResponse(c *gin.Context, err error, data interface{}) {
code, message := errno.DecodeErr(err)

// always return http.StatusOK
c.JSON(http.StatusOK, Response{
	Code:    code,
	Message: message,
	Data:    data,
})

}
可以看到返回格式固定为：
type Response struct {
Code int json:"code"
Message string json:"message"
Data interface{} json:"data"
}
在返回结构体中，固定有 Code 和 Message 参数，这两个参数通过函数 DecodeErr() 解析 error 类型的变量而来（DecodeErr() 在上一节介绍过）。Data 域为 interface{} 类型，可以根据业务自己的需求来返回，可以是 map、int、string、struct、array 等 Go 语言变量类型。SendResponse() 函数通过 errno.DecodeErr(err) 来解析出 code 和 message，并填充在 Response 结构体中。

在业务处理函数中读取和返回数据：

package user

import (
“fmt”

"apiserver/handler"
"apiserver/pkg/errno"

"github.com/gin-gonic/gin"
"github.com/lexkong/log"

)

// Create creates a new user account.
func Create(c *gin.Context) {
var r CreateRequest
if err := c.Bind(&r); err != nil {
SendResponse(c, errno.ErrBind, nil)
return
}

admin2 := c.Param("username")
log.Infof("URL username: %s", admin2)

desc := c.Query("desc")
log.Infof("URL key param desc: %s", desc)

contentType := c.GetHeader("Content-Type")
log.Infof("Header Content-Type: %s", contentType)

log.Debugf("username is: [%s], password is [%s]", r.Username, r.Password)
if r.Username == "" {
	SendResponse(c, errno.New(errno.ErrUserNotFound, fmt.Errorf("username can not found in db: xx.xx.xx.xx")), nil)
	return
}

if r.Password == "" {
	SendResponse(c, fmt.Errorf("password is empty"), nil)
}

rsp := CreateResponse{
	Username: r.Username,
}

// Show the user information.
SendResponse(c, nil, rsp)

}
**建议：**如果消息体有 JSON 参数需要传递，针对每一个 API 接口定义独立的 go struct 来接收，比如 CreateRequest 和 CreateResponse，并将这些结构体统一放在一个 Go 文件中，以方便后期维护和修改。