86 lines
2.9 KiB
Markdown
86 lines
2.9 KiB
Markdown
[![Sourcegraph](https://sourcegraph.com/github.com/json-iterator/go/-/badge.svg)](https://sourcegraph.com/github.com/json-iterator/go?badge)
|
|
[![GoDoc](http://img.shields.io/badge/go-documentation-blue.svg?style=flat-square)](https://pkg.go.dev/github.com/json-iterator/go)
|
|
[![Build Status](https://travis-ci.org/json-iterator/go.svg?branch=master)](https://travis-ci.org/json-iterator/go)
|
|
[![codecov](https://codecov.io/gh/json-iterator/go/branch/master/graph/badge.svg)](https://codecov.io/gh/json-iterator/go)
|
|
[![rcard](https://goreportcard.com/badge/github.com/json-iterator/go)](https://goreportcard.com/report/github.com/json-iterator/go)
|
|
[![License](http://img.shields.io/badge/license-mit-blue.svg?style=flat-square)](https://raw.githubusercontent.com/json-iterator/go/master/LICENSE)
|
|
[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/json-iterator/Lobby)
|
|
|
|
A high-performance 100% compatible drop-in replacement of "encoding/json"
|
|
|
|
# Benchmark
|
|
|
|
![benchmark](http://jsoniter.com/benchmarks/go-benchmark.png)
|
|
|
|
Source code: https://github.com/json-iterator/go-benchmark/blob/master/src/github.com/json-iterator/go-benchmark/benchmark_medium_payload_test.go
|
|
|
|
Raw Result (easyjson requires static code generation)
|
|
|
|
| | ns/op | allocation bytes | allocation times |
|
|
| --------------- | ----------- | ---------------- | ---------------- |
|
|
| std decode | 35510 ns/op | 1960 B/op | 99 allocs/op |
|
|
| easyjson decode | 8499 ns/op | 160 B/op | 4 allocs/op |
|
|
| jsoniter decode | 5623 ns/op | 160 B/op | 3 allocs/op |
|
|
| std encode | 2213 ns/op | 712 B/op | 5 allocs/op |
|
|
| easyjson encode | 883 ns/op | 576 B/op | 3 allocs/op |
|
|
| jsoniter encode | 837 ns/op | 384 B/op | 4 allocs/op |
|
|
|
|
Always benchmark with your own workload.
|
|
The result depends heavily on the data input.
|
|
|
|
# Usage
|
|
|
|
100% compatibility with standard lib
|
|
|
|
Replace
|
|
|
|
```go
|
|
import "encoding/json"
|
|
json.Marshal(&data)
|
|
```
|
|
|
|
with
|
|
|
|
```go
|
|
import jsoniter "github.com/json-iterator/go"
|
|
|
|
var json = jsoniter.ConfigCompatibleWithStandardLibrary
|
|
json.Marshal(&data)
|
|
```
|
|
|
|
Replace
|
|
|
|
```go
|
|
import "encoding/json"
|
|
json.Unmarshal(input, &data)
|
|
```
|
|
|
|
with
|
|
|
|
```go
|
|
import jsoniter "github.com/json-iterator/go"
|
|
|
|
var json = jsoniter.ConfigCompatibleWithStandardLibrary
|
|
json.Unmarshal(input, &data)
|
|
```
|
|
|
|
[More documentation](http://jsoniter.com/migrate-from-go-std.html)
|
|
|
|
# How to get
|
|
|
|
```
|
|
go get github.com/json-iterator/go
|
|
```
|
|
|
|
# Contribution Welcomed !
|
|
|
|
Contributors
|
|
|
|
- [thockin](https://github.com/thockin)
|
|
- [mattn](https://github.com/mattn)
|
|
- [cch123](https://github.com/cch123)
|
|
- [Oleg Shaldybin](https://github.com/olegshaldybin)
|
|
- [Jason Toffaletti](https://github.com/toffaletti)
|
|
|
|
Report issue or pull request, or email taowen@gmail.com, or [![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/json-iterator/Lobby)
|