1
0
mirror of https://github.com/json-iterator/go.git synced 2024-11-30 08:36:43 +02:00
json-iterator/README.md

67 lines
2.1 KiB
Markdown
Raw Normal View History

2016-12-11 17:55:55 +02:00
jsoniter (json-iterator) is fast and flexible JSON parser available in [Java](https://github.com/json-iterator/java) and [Go](https://github.com/json-iterator/go)
2016-11-30 18:56:25 +02:00
2016-12-11 17:55:55 +02:00
# Why jsoniter?
2016-11-30 18:56:25 +02:00
2016-12-12 19:13:15 +02:00
* Jsoniter is the fastest JSON parser. It could be up to 10x faster than normal parser, data binding included. Shameless self [benchmark](http://jsoniter.com/benchmark.html)
* Extremely flexible api. You can mix and match three different styles: bind-api, any-api or iterator-api. Checkout your [api choices](http://jsoniter.com/api.html)
* Unique iterator api can iterate through JSON directly, zero memory allocation! See how [iterator](http://jsoniter.com/api.html#iterator-api) works
# Show off
Here is a quick show off, for more complete report you can checkout the full [benchmark](http://jsoniter.com/benchmark.html) with [in-depth optimization](http://jsoniter.com/benchmark.html#optimization-used) to back the numbers up
![go-medium](http://jsoniter.com/benchmarks/go-medium.png)
2016-12-11 17:55:55 +02:00
2016-12-15 17:49:56 +02:00
# Bind-API is the best
2016-12-12 02:08:37 +02:00
2016-12-15 17:49:56 +02:00
Bind-api should always be the first choice. Given this JSON document `[0,1,2,3]`
2016-12-12 02:08:37 +02:00
Parse with Go bind-api
```go
import "github.com/json-iterator/go"
iter := jsoniter.ParseString(`[0,1,2,3]`)
val := []int{}
iter.Read(&val)
fmt.Println(val[3])
```
2016-12-15 17:49:56 +02:00
# Iterator-API for quick extraction
2016-12-12 02:08:37 +02:00
2016-12-15 17:49:56 +02:00
When you do not need to get all the data back, just extract some.
2016-12-12 02:08:37 +02:00
Parse with Go iterator-api
```go
import "github.com/json-iterator/go"
2016-12-15 17:49:56 +02:00
iter := ParseString(`[0, [1, 2], [3, 4], 5]`)
count := 0
2016-12-12 02:08:37 +02:00
for iter.ReadArray() {
2016-12-15 17:49:56 +02:00
iter.skip()
count++
2016-12-12 02:08:37 +02:00
}
2016-12-15 17:49:56 +02:00
fmt.Println(count) // 4
2016-12-12 02:08:37 +02:00
```
2016-12-15 17:49:56 +02:00
# Any-API for maximum flexibility
Parse with Go any-api
```go
import "github.com/json-iterator/go"
iter := jsoniter.ParseString(`[{"field1":"11","field2":"12"},{"field1":"21","field2":"22"}]`)
val := iter.ReadAny()
fmt.Println(val.ToInt(1, "field2")) // 22
```
Notice you can extract from nested data structure, and convert any type to the type to you want.
2016-12-12 02:08:37 +02:00
# How to get
```
go get github.com/json-iterator/go
```
# Contribution Welcomed !
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)