Decoding JSON using json.Unmarshal vs json.NewDecoder.Decode

huangapple go评论89阅读模式
英文:

Decoding JSON using json.Unmarshal vs json.NewDecoder.Decode

问题

我正在开发一个API客户端,在请求时需要对JSON负载进行编码,并从响应中解码JSON体。

我已经阅读了几个库的源代码,从我所看到的情况来看,我基本上有两种可能的方法来编码和解码JSON字符串。

第一种是使用json.Unmarshal,将整个响应字符串传递给它:

data, err := ioutil.ReadAll(resp.Body)
if err == nil && data != nil {
    err = json.Unmarshal(data, value)
}

第二种是使用json.NewDecoder.Decode

err = json.NewDecoder(resp.Body).Decode(value)

在我的情况下,当处理实现了io.Reader接口的HTTP响应时,第二种方法似乎需要更少的代码。但是,既然我都见过这两种方法,我想知道是否有任何偏好,是否应该使用一种解决方案而不是另一种。

此外,这个问题的被接受的答案说:

> 请使用json.Decoder而不是json.Unmarshal

但它没有提到原因。我真的应该避免使用json.Unmarshal吗?

英文:

I'm developing an API client where I need to encode a JSON payload on request and decode a JSON body from the response.

I've read the source code from several libraries and from what I have seen, I have basically two possibilities for encoding and decoding a JSON string.

Use json.Unmarshal passing the entire response string

data, err := ioutil.ReadAll(resp.Body)
if err == nil && data != nil {
    err = json.Unmarshal(data, value)
}

or using json.NewDecoder.Decode

err = json.NewDecoder(resp.Body).Decode(value)

In my case, when dealing with HTTP responses that implements io.Reader, the second version seems to be require less code, but since I've seen both I wonder if there is any preference whether I should use a solution rather than the other.

Moreover, the accepted answer from this question says

> Please use json.Decoder instead of json.Unmarshal.

but it didn't mention the reason. Should I really avoid using json.Unmarshal?

答案1

得分: 365

这真的取决于你的输入是什么。如果你查看json.DecoderDecode方法的实现,它会在将JSON值解组为Go值之前将整个JSON值缓存在内存中。所以在大多数情况下,它不会更节省内存(尽管这在将来的语言版本中可能会改变)。

所以一个更好的经验法则是:

  • 如果你的数据来自io.Reader流,或者你需要从数据流中解码多个值,请使用json.Decoder
  • 如果你已经将JSON数据存储在内存中,请使用json.Unmarshal

对于从HTTP请求中读取的情况,我会选择json.Decoder,因为显然你是从一个流中读取数据。

英文:

It really depends on what your input is. If you look at the implementation of the Decode method of json.Decoder, it buffers the entire JSON value in memory before unmarshalling it into a Go value. So in most cases it won't be any more memory efficient (although this could easily change in a future version of the language).

So a better rule of thumb is this:

  • Use json.Decoder if your data is coming from an io.Reader stream, or you need to decode multiple values from a stream of data.
  • Use json.Unmarshal if you already have the JSON data in memory.

For the case of reading from an HTTP request, I'd pick json.Decoder since you're obviously reading from a stream.

答案2

得分: 8

我在《Go Web编程》这本书中找到了这一段。但是没有给出解释。

> 那么我们何时使用Decoder而不是Unmarshal呢?

这取决于输入的方式。如果你的数据来自一个io.Reader流,比如http.Request的Body,那么使用Decoder。如果你的数据是一个字符串或者存储在内存中的某个地方,那么使用Unmarshal。

英文:

I found this paragraph in the Go web programming book. But there is no explanation given

> So when do we use Decoder versus Unmarshal?

That depends on the input. If your data is coming from an io.Reader
stream, like the Body of an http.Request, use Decoder. If you have the
data in a string or somewhere in memory, use Unmarshal.

huangapple
  • 本文由 发表于 2014年1月18日 06:34:55
  • 转载请务必保留本文链接:https://go.coder-hub.com/21197239.html
匿名

发表评论

匿名网友

:?: :razz: :sad: :evil: :!: :smile: :oops: :grin: :eek: :shock: :???: :cool: :lol: :mad: :twisted: :roll: :wink: :idea: :arrow: :neutral: :cry: :mrgreen:

确定