mirror of
https://github.com/json-iterator/go.git
synced 2025-03-26 21:12:40 +02:00
simplify readme
This commit is contained in:
parent
fe9fa8900e
commit
2051e3b8ae
61
README.md
61
README.md
@ -2,60 +2,37 @@
|
||||
|
||||
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)
|
||||
|
||||
# Why jsoniter?
|
||||
# Usage
|
||||
|
||||
* 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
|
||||
100% compatibility with standard lib
|
||||
|
||||
# Show off
|
||||
Replace
|
||||
|
||||
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
|
||||
|
||||

|
||||
|
||||
# Bind-API is the best
|
||||
|
||||
Bind-api should always be the first choice. Given this JSON document `[0,1,2,3]`
|
||||
|
||||
Parse with Go bind-api
|
||||
|
||||
```go
|
||||
import "github.com/json-iterator/go"
|
||||
iter := jsoniter.ParseString(`[0,1,2,3]`)
|
||||
var := iter.Read()
|
||||
fmt.Println(val)
|
||||
```
|
||||
import "encoding/json"
|
||||
json.Marshal(&data)
|
||||
```
|
||||
|
||||
# Iterator-API for quick extraction
|
||||
with
|
||||
|
||||
When you do not need to get all the data back, just extract some.
|
||||
|
||||
Parse with Go iterator-api
|
||||
|
||||
```go
|
||||
```
|
||||
import "github.com/json-iterator/go"
|
||||
iter := ParseString(`[0, [1, 2], [3, 4], 5]`)
|
||||
count := 0
|
||||
for iter.ReadArray() {
|
||||
iter.Skip()
|
||||
count++
|
||||
}
|
||||
fmt.Println(count) // 4
|
||||
jsoniter.Marshal(&data)
|
||||
```
|
||||
|
||||
# Any-API for maximum flexibility
|
||||
Replace
|
||||
|
||||
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
|
||||
```
|
||||
import "encoding/json"
|
||||
json.Unmarshal(input, &data)
|
||||
```
|
||||
|
||||
Notice you can extract from nested data structure, and convert any type to the type to you want.
|
||||
with
|
||||
|
||||
```
|
||||
import "github.com/json-iterator/go"
|
||||
jsoniter.Unmarshal(input, &data)
|
||||
```
|
||||
|
||||
# How to get
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user