登录
首页 >  Golang >  Go问答

在绑定之前处理压缩的 JSON 数据

来源:stackoverflow

时间:2024-02-27 11:48:26 380浏览 收藏

从现在开始,努力学习吧!本文《在绑定之前处理压缩的 JSON 数据》主要讲解了等等相关知识点,我会在golang学习网中持续更新相关的系列文章,欢迎大家关注并积极留言建议。下面就先一起来看一下本篇正文内容吧,希望能帮到你!

问题内容

我想编写一个 api,它将通过 post 发送 gzipped json 数据。虽然下面的代码可以处理正文中的简单 json,但如果 json 被压缩,则无法处理。

在使用c.shouldbindjson之前我们是否需要显式处理解压?

如何重现

package main

import (
    "github.com/gin-gonic/gin"
    "log"
    "net/http"
)

func main() {
    r := gin.default()

    r.post("/postgzip", func(c *gin.context) {
        
        type postdata struct {
            data string `binding:"required" json:"data"`
        }
        
        var postdata postdata
        if err := c.shouldbindjson(&postdata); err != nil {
            log.println("error parsing request body", "error", err)
            c.abortwithstatusjson(http.statusbadrequest, gin.h{"error": err.error()})
            return
        }
        log.printf("%s", postdata)
        if !c.isaborted() {
            c.string(200, postdata.data)
        }
    })
    r.run()
}
❯ echo '{"data" : "hello"}' | curl -x post -h "content-type: application/json" -d @- localhost:8080/postgzip
hello

期望

$ echo '{"data" : "hello"}' | gzip | curl -v -i -x post -h "content-type: application/json" -h "content-encoding: gzip" --data-binary @- localhost:8080/postgzip
hello

实际结果

$ echo '{"data" : "hello"}' | gzip | curl -v -i -X POST -H "Content-Type: application/json" -H "Content-Encoding: gzip" --data-binary @- localhost:8080/postgzip
{"error":"invalid character '\\x1f' looking for beginning of value"}

环境

  • go版本:go版本go1.17.2 darwin/amd64
  • 杜松子酒版本(或提交参考):v1.7.4
  • 操作系统:macos monterey

正确答案


在使用 c.shouldbindjson 之前我们是否需要显式处理解压?

当然。 gin shouldbindjson 对您的有效负载可能或可能不编码一无所知。 It expects JSON input,正如方法名称所示。

如果您希望编写可重用的代码,可以实现 Binding 接口。

一个非常简单的例子:

type gzipjsonbinding struct {
}

func (b *gzipjsonbinding) name() string {
    return "gzipjson"
}

func (b *gzipjsonbinding) bind(req *http.request, dst interface{}) error {
    r, err := gzip.newreader(req.body)
    if err != nil {
        return err
    }
    raw, err := io.readall(r)
    if err != nil {
        return err
    }
    return json.unmarshal(raw, dst)
}

然后可以与 c.ShouldBindWith 一起使用,它允许使用任意绑定引擎:

err := c.shouldbindwith(&postdata, &gzipjsonbinding{})

打开 content-encoding 的完整工作示例

卷曲尝试使用它

$ echo '{"data" : "hello"}' | gzip | curl -x post -h "content-type: application/json" -h "content-encoding: gzip" --data-binary @- localhost:8080/json
hello
$ curl -x post -h "content-type: application/json" --data-raw '{"data" : "hello"}' localhost:8080/json
hello
package main

import (
    "bytes"
    "compress/gzip"
    "encoding/json"
    "fmt"
    "github.com/gin-gonic/gin"
    "github.com/gin-gonic/gin/binding"
    "io"
    "log"
    "net/http"
)

type PostData struct {
    Data string `binding:"required" json:"data"`
}

func main() {
    r := gin.Default()
    r.POST("/json", func(c *gin.Context) {

        var postdata PostData

        contentEncodingHeader := c.GetHeader("Content-Encoding")
        switch contentEncodingHeader {
        case "gzip":
            if err := c.ShouldBindBodyWith(&postdata, gzipJSONBinding{}); err != nil {
                log.Println("Error parsing GZIP JSON request body", "error", err)
                c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
                return
            }
        case "":
            if err := c.ShouldBindJSON(&postdata); err != nil {
                log.Println("Error parsing JSON request body", "error", err)
                c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
                return
            }
        default:
            log.Println("unsupported Content-Encoding")
            c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "unsupported Content-Encoding"})
            return

        }

        log.Printf("%s", postdata)
        if !c.IsAborted() {
            c.String(200, postdata.Data)
        }
    })
    r.Run()
}

type gzipJSONBinding struct{}

func (gzipJSONBinding) Name() string {
    return "gzipjson"
}

func (gzipJSONBinding) Bind(req *http.Request, obj interface{}) error {
    if req == nil || req.Body == nil {
        return fmt.Errorf("invalid request")
    }
    r, err := gzip.NewReader(req.Body)
    if err != nil {
        return err
    }
    raw, err := io.ReadAll(r)
    if err != nil {
        return err
    }
    return json.Unmarshal(raw, obj)
}

func (gzipJSONBinding) BindBody(body []byte, obj interface{}) error {
    r, err := gzip.NewReader(bytes.NewReader(body))
    if err != nil {
        return err
    }
    return decodeJSON(r, obj)
}

func decodeJSON(r io.Reader, obj interface{}) error {
    decoder := json.NewDecoder(r)

    if err := decoder.Decode(obj); err != nil {
        return err
    }
    return validate(obj)
}

func validate(obj interface{}) error {
    if binding.Validator == nil {
        return nil
    }
    return binding.Validator.ValidateStruct(obj)
}

以上就是本文的全部内容了,是否有顺利帮助你解决问题?若是能给你带来学习上的帮助,请大家多多支持golang学习网!更多关于Golang的相关知识,也可关注golang学习网公众号。

声明:本文转载于:stackoverflow 如有侵犯,请联系study_golang@163.com删除
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>