go-zero针对文本的序列化和反序列化次要在三个中央应用

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

残缺示例可参照上面这篇文章：

  • 疾速构建高并发微服务

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

1.2 数据校验以用户user.api文件为例

type (    createUserReq struct {        age    int8   `json:"age,default=20,range=(12:100]"` // 年龄        name   string `json:"name"`                          // 名字        alias  string `json:"alias,optional"`                // 别名        sex    string `json:"sex,options=male|female"`       // 性别        avatar string `json:"avatar,default=default.png"`    // 头像    }    createUserRes struct {        success bool `json:"success"` // 是否胜利    })service user {    @doc(        summary: 创立订单    )    @handler CreateUserHandler    post /user/add(createUserReq) returns(createUserRes)}

数据校验有很多种形式，包含以下但不限：

  • age：默认不输出为20，输出则取值范畴为(12:100]，前开后闭
  • name：必填，不可为空
  • alias：选填，可为空
  • sex：必填，取值为male或female
  • avatar：选填，默认为default.png

更多详情参见unmarshaler_test.go

2. http api返回体的序列化

  • 应用官网默认的encoding/json包序列化，在此不再累赘

3. 配置文件的反序列化

  • 配置文件的反序列化和http api申请体的反序列化应用同一套解析规定，可参照http api申请体的反序列化

4. 我的项目地址

https://github.com/tal-tech/go-zero

好将来技术