forked from mirror/go-json
122 lines
2.6 KiB
Markdown
122 lines
2.6 KiB
Markdown
# go-json
|
|
|
|
|
|
[](https://pkg.go.dev/github.com/goccy/go-json?tab=doc)
|
|
|
|
Fast JSON encoder/decoder compatible with encoding/json for Go
|
|
|
|
# Installation
|
|
|
|
```
|
|
go get github.com/goccy/go-json
|
|
```
|
|
|
|
# How to use
|
|
|
|
Replace import statement from `encoding/json` to `github.com/goccy/go-json`
|
|
|
|
```
|
|
-import "encoding/json"
|
|
+import "github.com/goccy/go-json"
|
|
```
|
|
|
|
# Benchmarks
|
|
|
|
```
|
|
$ cd benchmarks
|
|
$ go test -bench .
|
|
```
|
|
|
|
## Encode
|
|
|
|
**Fastest**
|
|
|
|
### SmallStruct
|
|
|
|
<img src="https://user-images.githubusercontent.com/209884/89118973-5a8cd600-d4e5-11ea-8a07-775cf3e32a2f.png"></img>
|
|
|
|
### MediumStruct
|
|
|
|
<img src="https://user-images.githubusercontent.com/209884/89118974-5d87c680-d4e5-11ea-8f4e-dbb01c2dd861.png"></img>
|
|
|
|
### LargeStruct
|
|
|
|
<img src="https://user-images.githubusercontent.com/209884/89118977-5f518a00-d4e5-11ea-8bfe-1455fc71c963.png"></img>
|
|
|
|
## Decode
|
|
|
|
**So faster than json-iterator/go**
|
|
|
|
## json.Unmarshal
|
|
|
|
### SmallStruct
|
|
|
|
<img src="https://user-images.githubusercontent.com/209884/89118870-5b713800-d4e4-11ea-9c80-47008d998e70.png"></img>
|
|
|
|
### MediumStruct
|
|
|
|
<img src="https://user-images.githubusercontent.com/209884/89118884-86f42280-d4e4-11ea-965c-b72764870ed0.png"></img>
|
|
|
|
### LargeStruct
|
|
|
|
<img src="https://user-images.githubusercontent.com/209884/89118902-9c694c80-d4e4-11ea-94e6-8c888cdb6361.png"></img>
|
|
|
|
## Stream Decode
|
|
|
|
### SmallStruct
|
|
|
|
<img src="https://user-images.githubusercontent.com/209884/89118906-b0ad4980-d4e4-11ea-80fb-2a6e9e7a066e.png"></img>
|
|
|
|
### MediumStruct
|
|
|
|
<img src="https://user-images.githubusercontent.com/209884/89118917-c02c9280-d4e4-11ea-8ba8-776cdbf970df.png"></img>
|
|
|
|
### LargeStruct
|
|
|
|
<img src="https://user-images.githubusercontent.com/209884/89118920-c28eec80-d4e4-11ea-91cc-424cfe726539.png"></img>
|
|
|
|
# Status
|
|
|
|
## Type
|
|
|
|
Currently supported all types
|
|
|
|
## API
|
|
|
|
- [ ] `Compact`
|
|
- [ ] `HTMLEscape`
|
|
- [ ] `Indent`
|
|
- [x] `Marshal`
|
|
- [x] `MarshalIndent`
|
|
- [x] `Unmarshal`
|
|
- [ ] `Valid`
|
|
- [x] `NewDecoder`
|
|
- [x] `(*Decoder).Buffered`
|
|
- [x] `(*Decoder).Decode`
|
|
- [ ] `(*Decoder).DisallowUnknownFields`
|
|
- [x] `(*Decoder).InputOffset`
|
|
- [x] `(*Decoder).More`
|
|
- [x] `(*Decoder).Token`
|
|
- [ ] `(*Decoder).UseNumber`
|
|
- [x] `Delim`
|
|
- [x] `(Delim).String`
|
|
- [x] `NewEncoder`
|
|
- [x] `(*Encoder).Encode`
|
|
- [x] `(*Encoder).SetEscapeHTML`
|
|
- [x] `(*Encoder).SetIndent`
|
|
|
|
### Error
|
|
|
|
- [ ] `InvalidUTF8Error`
|
|
- [x] `InvalidUnmarshalError`
|
|
- [x] `MarshalerError`
|
|
- [x] `SyntaxError`
|
|
- [ ] `UnmarshalFieldError`
|
|
- [ ] `UnmarshalTypeError`
|
|
- [x] `UnsupportedTypeError`
|
|
- [x] `UnsupportedValueError`
|
|
|
|
# License
|
|
|
|
MIT
|