如何高效定义和验证restful请求的参数_go-zero api 自定义参数校验(3)

最新推荐文章于 2024-07-22 14:10:07 发布

2401_84923269

最新推荐文章于 2024-07-22 14:10:07 发布

阅读量740

点赞数 7

分类专栏：程序员文章标签： go 学习面试

本文链接：https://blog.csdn.net/2401_84923269/article/details/138779545

版权

程序员专栏收录该内容

56 篇文章 0 订阅

订阅专栏

网上学习资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。

需要这份系统化的资料的朋友，可以添加戳这里获取

一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！

go-zero针对文本的序列化和反序列化主要在三个地方使用：

http api请求体的反序列化
http api返回体的序列化
配置文件的反序列化

如何高效定义和验证restful请求的参数

1. http api请求体的反序列化

在反序列化的过程中的针对请求数据的数据格式以及数据校验需求，go-zero实现了自己的一套反序列化机制

1.1 数据格式以订单order.api文件为例

type (
	createOrderReq struct {
		token     string `path:"token"`     // 用户token
		productId string `json:"productId"` // 商品ID
		num       int    `json:"num"`       // 商品数量
	}
	createOrderRes struct {
		success bool `json:"success"` // 是否成功
	}
	findOrderReq struct {
		token    string `path:"token"`    // 用户token
		page     int    `form:"page"`     // 页数
		pageSize int8   `form:"pageSize"` // 页大小
	}
	findOrderRes struct {
		orderInfo []orderInfo `json:"orderInfo"` // 商品ID
	}
	orderInfo struct {
		productId   string `json:"productId"`   // 商品ID
		productName string `json:"productName"` // 商品名称
		num         int    `json:"num"`         // 商品数量
	}
	deleteOrderReq struct {
		id string `path:"id"`
	}
	deleteOrderRes struct {
		success bool `json:"success"` // 是否成功
	}
)

service order {
    @doc(
        summary: 创建订单
    )
    @handler CreateOrderHandler
    post /order/add/:token(createOrderReq) returns(createOrderRes)

    @doc(
        summary: 获取订单
    )
    @handler FindOrderHandler
    get /order/find/:token(findOrderReq) returns(findOrderRes)

    @doc(
        summary: 删除订单
    )
    @handler: DeleteOrderHandler
    delete /order/:id(deleteOrderReq) returns(deleteOrderRes)
}

http api请求体的反序列化的tag有三种：

path：http url 路径中参数反序列化/order/add/1234567会解析出来token为1234567
form：http form表单反序列化，需要 header头添加 Content-Type: multipart/form-data/order/find/1234567?page=1&pageSize=20会解析出来token为1234567，page为1，pageSize为20
json：http request json body反序列化，需要 header头添加 Content-Type: application/json{“productId”:“321”,“num”:1}会解析出来productId为321，num为1