README_ZH_CN.md (20496B)
1 # Sonic 2 3 [English](README.md) | 中文 4 5 一个速度奇快的 JSON 序列化/反序列化库，由 JIT （即时编译）和 SIMD （单指令流多数据流）加速。 6 7 ## 依赖 8 9 - Go 1.15~1.20 10 - Linux/MacOS/Windows 11 - Amd64 架构 12 13 ## 特色 14 15 - 运行时对象绑定，无需代码生成 16 - 完备的 JSON 操作 API 17 - 快，更快，还要更快！ 18 19 ## 基准测试 20 21 对于**所有大小**的 json 和**所有使用场景**， **Sonic 表现均为最佳**。 22 - [中型](https://github.com/bytedance/sonic/blob/main/decoder/testdata_test.go#L19) (13kB, 300+ 键, 6 层) 23 ```powershell 24 goversion: 1.17.1 25 goos: darwin 26 goarch: amd64 27 cpu: Intel(R) Core(TM) i9-9880H CPU @ 2.30GHz 28 BenchmarkEncoder_Generic_Sonic-16 32393 ns/op 402.40 MB/s 11965 B/op 4 allocs/op 29 BenchmarkEncoder_Generic_Sonic_Fast-16 21668 ns/op 601.57 MB/s 10940 B/op 4 allocs/op 30 BenchmarkEncoder_Generic_JsonIter-16 42168 ns/op 309.12 MB/s 14345 B/op 115 allocs/op 31 BenchmarkEncoder_Generic_GoJson-16 65189 ns/op 199.96 MB/s 23261 B/op 16 allocs/op 32 BenchmarkEncoder_Generic_StdLib-16 106322 ns/op 122.60 MB/s 49136 B/op 789 allocs/op 33 BenchmarkEncoder_Binding_Sonic-16 6269 ns/op 2079.26 MB/s 14173 B/op 4 allocs/op 34 BenchmarkEncoder_Binding_Sonic_Fast-16 5281 ns/op 2468.16 MB/s 12322 B/op 4 allocs/op 35 BenchmarkEncoder_Binding_JsonIter-16 20056 ns/op 649.93 MB/s 9488 B/op 2 allocs/op 36 BenchmarkEncoder_Binding_GoJson-16 8311 ns/op 1568.32 MB/s 9481 B/op 1 allocs/op 37 BenchmarkEncoder_Binding_StdLib-16 16448 ns/op 792.52 MB/s 9479 B/op 1 allocs/op 38 BenchmarkEncoder_Parallel_Generic_Sonic-16 6681 ns/op 1950.93 MB/s 12738 B/op 4 allocs/op 39 BenchmarkEncoder_Parallel_Generic_Sonic_Fast-16 4179 ns/op 3118.99 MB/s 10757 B/op 4 allocs/op 40 BenchmarkEncoder_Parallel_Generic_JsonIter-16 9861 ns/op 1321.84 MB/s 14362 B/op 115 allocs/op 41 BenchmarkEncoder_Parallel_Generic_GoJson-16 18850 ns/op 691.52 MB/s 23278 B/op 16 allocs/op 42 BenchmarkEncoder_Parallel_Generic_StdLib-16 45902 ns/op 283.97 MB/s 49174 B/op 789 allocs/op 43 BenchmarkEncoder_Parallel_Binding_Sonic-16 1480 ns/op 8810.09 MB/s 13049 B/op 4 allocs/op 44 BenchmarkEncoder_Parallel_Binding_Sonic_Fast-16 1209 ns/op 10785.23 MB/s 11546 B/op 4 allocs/op 45 BenchmarkEncoder_Parallel_Binding_JsonIter-16 6170 ns/op 2112.58 MB/s 9504 B/op 2 allocs/op 46 BenchmarkEncoder_Parallel_Binding_GoJson-16 3321 ns/op 3925.52 MB/s 9496 B/op 1 allocs/op 47 BenchmarkEncoder_Parallel_Binding_StdLib-16 3739 ns/op 3486.49 MB/s 9480 B/op 1 allocs/op 48 49 BenchmarkDecoder_Generic_Sonic-16 66812 ns/op 195.10 MB/s 57602 B/op 723 allocs/op 50 BenchmarkDecoder_Generic_Sonic_Fast-16 54523 ns/op 239.07 MB/s 49786 B/op 313 allocs/op 51 BenchmarkDecoder_Generic_StdLib-16 124260 ns/op 104.90 MB/s 50869 B/op 772 allocs/op 52 BenchmarkDecoder_Generic_JsonIter-16 91274 ns/op 142.81 MB/s 55782 B/op 1068 allocs/op 53 BenchmarkDecoder_Generic_GoJson-16 88569 ns/op 147.17 MB/s 66367 B/op 973 allocs/op 54 BenchmarkDecoder_Binding_Sonic-16 32557 ns/op 400.38 MB/s 28302 B/op 137 allocs/op 55 BenchmarkDecoder_Binding_Sonic_Fast-16 28649 ns/op 455.00 MB/s 24999 B/op 34 allocs/op 56 BenchmarkDecoder_Binding_StdLib-16 111437 ns/op 116.97 MB/s 10576 B/op 208 allocs/op 57 BenchmarkDecoder_Binding_JsonIter-16 35090 ns/op 371.48 MB/s 14673 B/op 385 allocs/op 58 BenchmarkDecoder_Binding_GoJson-16 28738 ns/op 453.59 MB/s 22039 B/op 49 allocs/op 59 BenchmarkDecoder_Parallel_Generic_Sonic-16 12321 ns/op 1057.91 MB/s 57233 B/op 723 allocs/op 60 BenchmarkDecoder_Parallel_Generic_Sonic_Fast-16 10644 ns/op 1224.64 MB/s 49362 B/op 313 allocs/op 61 BenchmarkDecoder_Parallel_Generic_StdLib-16 57587 ns/op 226.35 MB/s 50874 B/op 772 allocs/op 62 BenchmarkDecoder_Parallel_Generic_JsonIter-16 38666 ns/op 337.12 MB/s 55789 B/op 1068 allocs/op 63 BenchmarkDecoder_Parallel_Generic_GoJson-16 30259 ns/op 430.79 MB/s 66370 B/op 974 allocs/op 64 BenchmarkDecoder_Parallel_Binding_Sonic-16 5965 ns/op 2185.28 MB/s 27747 B/op 137 allocs/op 65 BenchmarkDecoder_Parallel_Binding_Sonic_Fast-16 5170 ns/op 2521.31 MB/s 24715 B/op 34 allocs/op 66 BenchmarkDecoder_Parallel_Binding_StdLib-16 27582 ns/op 472.58 MB/s 10576 B/op 208 allocs/op 67 BenchmarkDecoder_Parallel_Binding_JsonIter-16 13571 ns/op 960.51 MB/s 14685 B/op 385 allocs/op 68 BenchmarkDecoder_Parallel_Binding_GoJson-16 10031 ns/op 1299.51 MB/s 22111 B/op 49 allocs/op 69 70 BenchmarkGetOne_Sonic-16 3276 ns/op 3975.78 MB/s 24 B/op 1 allocs/op 71 BenchmarkGetOne_Gjson-16 9431 ns/op 1380.81 MB/s 0 B/op 0 allocs/op 72 BenchmarkGetOne_Jsoniter-16 51178 ns/op 254.46 MB/s 27936 B/op 647 allocs/op 73 BenchmarkGetOne_Parallel_Sonic-16 216.7 ns/op 60098.95 MB/s 24 B/op 1 allocs/op 74 BenchmarkGetOne_Parallel_Gjson-16 1076 ns/op 12098.62 MB/s 0 B/op 0 allocs/op 75 BenchmarkGetOne_Parallel_Jsoniter-16 17741 ns/op 734.06 MB/s 27945 B/op 647 allocs/op 76 BenchmarkSetOne_Sonic-16 9571 ns/op 1360.61 MB/s 1584 B/op 17 allocs/op 77 BenchmarkSetOne_Sjson-16 36456 ns/op 357.22 MB/s 52180 B/op 9 allocs/op 78 BenchmarkSetOne_Jsoniter-16 79475 ns/op 163.86 MB/s 45862 B/op 964 allocs/op 79 BenchmarkSetOne_Parallel_Sonic-16 850.9 ns/op 15305.31 MB/s 1584 B/op 17 allocs/op 80 BenchmarkSetOne_Parallel_Sjson-16 18194 ns/op 715.77 MB/s 52247 B/op 9 allocs/op 81 BenchmarkSetOne_Parallel_Jsoniter-16 33560 ns/op 388.05 MB/s 45892 B/op 964 allocs/op 82 ``` 83 - [小型](https://github.com/bytedance/sonic/blob/main/testdata/small.go) (400B, 11 个键, 3 层) 84  85 - [大型](https://github.com/bytedance/sonic/blob/main/testdata/twitter.json) (635kB, 10000+ 个键, 6 层) 86  87 88 要查看基准测试代码，请参阅 [bench.sh](https://github.com/bytedance/sonic/blob/main/bench.sh) 。 89 90 ## 工作原理 91 92 请参阅 [INTRODUCTION_ZH_CN.md](./docs/INTRODUCTION_ZH_CN.md). 93 94 ## 使用方式 95 96 ### 序列化/反序列化 97 98 默认的行为基本上与 `encoding/json` 相一致，除了 HTML 转义形式（参见 [Escape HTML](https://github.com/bytedance/sonic/blob/main/README.md#escape-html)) 和 `SortKeys` 功能（参见 [Sort Keys](https://github.com/bytedance/sonic/blob/main/README.md#sort-keys)）**没有**遵循 [RFC8259](https://datatracker.ietf.org/doc/html/rfc8259) 。 99 ```go 100 import "github.com/bytedance/sonic" 101 102 var data YourSchema 103 // Marshal 104 output, err := sonic.Marshal(&data) 105 // Unmarshal 106 err := sonic.Unmarshal(output, &data) 107 ``` 108 109 ### 流式输入输出 110 111 Sonic 支持解码 `io.Reader` 中输入的 json，或将对象编码为 json 后输出至 `io.Writer`，以处理多个值并减少内存消耗。 112 - 编码器 113 ```go 114 var o1 = map[string]interface{}{ 115 "a": "b", 116 } 117 var o2 = 1 118 var w = bytes.NewBuffer(nil) 119 var enc = sonic.ConfigDefault.NewEncoder(w) 120 enc.Encode(o1) 121 enc.Encode(o2) 122 fmt.Println(w.String()) 123 // Output: 124 // {"a":"b"} 125 // 1 126 ``` 127 - 解码器 128 ```go 129 var o = map[string]interface{}{} 130 var r = strings.NewReader(`{"a":"b"}{"1":"2"}`) 131 var dec = sonic.ConfigDefault.NewDecoder(r) 132 dec.Decode(&o) 133 dec.Decode(&o) 134 fmt.Printf("%+v", o) 135 // Output: 136 // map[1:2 a:b] 137 ``` 138 139 ### 使用 `Number` / `int64` 140 141 ```go 142 import "github.com/bytedance/sonic/decoder" 143 144 var input = `1` 145 var data interface{} 146 147 // default float64 148 dc := decoder.NewDecoder(input) 149 dc.Decode(&data) // data == float64(1) 150 // use json.Number 151 dc = decoder.NewDecoder(input) 152 dc.UseNumber() 153 dc.Decode(&data) // data == json.Number("1") 154 // use int64 155 dc = decoder.NewDecoder(input) 156 dc.UseInt64() 157 dc.Decode(&data) // data == int64(1) 158 159 root, err := sonic.GetFromString(input) 160 // Get json.Number 161 jn := root.Number() 162 jm := root.InterfaceUseNumber().(json.Number) // jn == jm 163 // Get float64 164 fn := root.Float64() 165 fm := root.Interface().(float64) // jn == jm 166 ``` 167 168 ### 对键排序 169 170 考虑到排序带来的性能损失（约 10% ）， sonic 默认不会启用这个功能。如果你的组件依赖这个行为（如 [zstd](https://github.com/facebook/zstd)) ，可以仿照下面的例子： 171 ```go 172 import "github.com/bytedance/sonic" 173 import "github.com/bytedance/sonic/encoder" 174 175 // Binding map only 176 m := map[string]interface{}{} 177 v, err := encoder.Encode(m, encoder.SortMapKeys) 178 179 // Or ast.Node.SortKeys() before marshal 180 var root := sonic.Get(JSON) 181 err := root.SortKeys() 182 ``` 183 184 ### HTML 转义 185 186 考虑到性能损失（约15%）， sonic 默认不会启用这个功能。你可以使用 `encoder.EscapeHTML` 选项来开启（与 `encoding/json.HTMLEscape` 行为一致）。 187 ```go 188 import "github.com/bytedance/sonic" 189 190 v := map[string]string{"&&":"<>"} 191 ret, err := Encode(v, EscapeHTML) // ret == `{"\u0026\u0026":{"X":"\u003c\u003e"}}` 192 ``` 193 194 ### 紧凑格式 195 Sonic 默认将基本类型（ `struct` ， `map` 等）编码为紧凑格式的 JSON ，除非使用 `json.RawMessage` or `json.Marshaler` 进行编码： sonic 确保输出的 JSON 合法，但出于性能考虑，**不会**加工成紧凑格式。我们提供选项 `encoder.CompactMarshaler` 来添加此过程， 196 197 ### 打印错误 198 199 如果输入的 JSON 存在无效的语法，sonic 将返回 `decoder.SyntaxError`，该错误支持错误位置的美化输出。 200 ```go 201 import "github.com/bytedance/sonic" 202 import "github.com/bytedance/sonic/decoder" 203 204 var data interface{} 205 err := sonic.UnmarshalString("[[[}]]", &data) 206 if err != nil { 207 /* One line by default */ 208 println(e.Error()) // "Syntax error at index 3: invalid char\n\n\t[[[}]]\n\t...^..\n" 209 /* Pretty print */ 210 if e, ok := err.(decoder.SyntaxError); ok { 211 /*Syntax error at index 3: invalid char 212 213 [[[}]] 214 ...^.. 215 */ 216 print(e.Description()) 217 } else if me, ok := err.(*decoder.MismatchTypeError); ok { 218 // decoder.MismatchTypeError is new to Sonic v1.6.0 219 print(me.Description()) 220 } 221 } 222 ``` 223 224 #### 类型不匹配 [Sonic v1.6.0] 225 226 如果给定键中存在**类型不匹配**的值， sonic 会抛出 `decoder.MismatchTypeError` （如果有多个，只会报告最后一个），但仍会跳过错误的值并解码下一个 JSON 。 227 ```go 228 import "github.com/bytedance/sonic" 229 import "github.com/bytedance/sonic/decoder" 230 231 var data = struct{ 232 A int 233 B int 234 }{} 235 err := UnmarshalString(`{"A":"1","B":1}`, &data) 236 println(err.Error()) // Mismatch type int with value string "at index 5: mismatched type with value\n\n\t{\"A\":\"1\",\"B\":1}\n\t.....^.........\n" 237 fmt.Printf("%+v", data) // {A:0 B:1} 238 ``` 239 ### `Ast.Node` 240 241 Sonic/ast.Node 是完全独立的 JSON 抽象语法树库。它实现了序列化和反序列化，并提供了获取和修改通用数据的鲁棒的 API。 242 243 #### 查找/索引 244 245 通过给定的路径搜索 JSON 片段，路径必须为非负整数，字符串或 `nil` 。 246 ```go 247 import "github.com/bytedance/sonic" 248 249 input := []byte(`{"key1":[{},{"key2":{"key3":[1,2,3]}}]}`) 250 251 // no path, returns entire json 252 root, err := sonic.Get(input) 253 raw := root.Raw() // == string(input) 254 255 // multiple paths 256 root, err := sonic.Get(input, "key1", 1, "key2") 257 sub := root.Get("key3").Index(2).Int64() // == 3 258 ``` 259 **注意**：由于 `Index()` 使用偏移量来定位数据，比使用扫描的 `Get()` 要快的多，建议尽可能的使用 `Index` 。 Sonic 也提供了另一个 API， `IndexOrGet()` ，以偏移量为基础并且也确保键的匹配。 260 261 #### 修改 262 263 使用 ` Set()` / `Unset()` 修改 json 的内容 264 ```go 265 import "github.com/bytedance/sonic" 266 267 // Set 268 exist, err := root.Set("key4", NewBool(true)) // exist == false 269 alias1 := root.Get("key4") 270 println(alias1.Valid()) // true 271 alias2 := root.Index(1) 272 println(alias1 == alias2) // true 273 274 // Unset 275 exist, err := root.UnsetByIndex(1) // exist == true 276 println(root.Get("key4").Check()) // "value not exist" 277 ``` 278 279 #### 序列化 280 要将 `ast.Node` 编码为 json ，使用 `MarshalJson()` 或者 `json.Marshal()` （必须传递指向节点的指针） 281 ```go 282 import ( 283 "encoding/json" 284 "github.com/bytedance/sonic" 285 ) 286 287 buf, err := root.MarshalJson() 288 println(string(buf)) // {"key1":[{},{"key2":{"key3":[1,2,3]}}]} 289 exp, err := json.Marshal(&root) // WARN: use pointer 290 println(string(buf) == string(exp)) // true 291 ``` 292 293 #### APIs 294 - 合法性检查： `Check()`, `Error()`, `Valid()`, `Exist()` 295 - 索引： `Index()`, `Get()`, `IndexPair()`, `IndexOrGet()`, `GetByPath()` 296 - 转换至 go 内置类型： `Int64()`, `Float64()`, `String()`, `Number()`, `Bool()`, `Map[UseNumber|UseNode]()`, `Array[UseNumber|UseNode]()`, `Interface[UseNumber|UseNode]()` 297 - go 类型打包： `NewRaw()`, `NewNumber()`, `NewNull()`, `NewBool()`, `NewString()`, `NewObject()`, `NewArray()` 298 - 迭代： `Values()`, `Properties()`, `ForEach()`, `SortKeys()` 299 - 修改： `Set()`, `SetByIndex()`, `Add()` 300 301 ## 兼容性 302 由于开发高性能代码的困难性， Sonic **不**保证对所有环境的支持。对于在不同环境中使用 Sonic 构建应用程序的开发者，我们有以下建议： 303 304 - 在 **Mac M1** 上开发：确保在您的计算机上安装了 Rosetta 2，并在构建时设置 `GOARCH=amd64` 。 Rosetta 2 可以自动将 x86 二进制文件转换为 arm64 二进制文件，并在 Mac M1 上运行 x86 应用程序。 305 - 在 **Linux arm64** 上开发：您可以安装 qemu 并使用 `qemu-x86_64 -cpu max` 命令来将 x86 二进制文件转换为 arm64 二进制文件。qemu可以实现与Mac M1上的Rosetta 2类似的转换效果。 306 307 对于希望在不使用 qemu 下使用 sonic 的开发者，或者希望处理 JSON 时与 `encoding/JSON` 严格保持一致的开发者，我们在 `sonic.API` 中提供了一些兼容性 API 308 - `ConfigDefault`: 在支持 sonic 的环境下 sonic 的默认配置（`EscapeHTML=false`，`SortKeys=false`等）。行为与具有相应配置的 `encoding/json` 一致，一些选项，如 `SortKeys=false` 将无效。 309 - `ConfigStd`: 在支持 sonic 的环境下与标准库兼容的配置（`EscapeHTML=true`，`SortKeys=true`等）。行为与 `encoding/json` 一致。 310 - `ConfigFastest`: 在支持 sonic 的环境下运行最快的配置（`NoQuoteTextMarshaler=true`）。行为与具有相应配置的 `encoding/json` 一致，某些选项将无效。 311 312 ## 注意事项 313 314 ### 预热 315 由于 Sonic 使用 [golang-asm](https://github.com/twitchyliquid64/golang-asm) 作为 JIT 汇编器，这个库并不适用于运行时编译，第一次运行一个大型模式可能会导致请求超时甚至进程内存溢出。为了更好地稳定性，我们建议在运行大型模式或在内存有限的应用中，在使用 `Marshal()/Unmarshal()` 前运行 `Pretouch()`。 316 ```go 317 import ( 318 "reflect" 319 "github.com/bytedance/sonic" 320 "github.com/bytedance/sonic/option" 321 ) 322 323 func init() { 324 var v HugeStruct 325 326 // For most large types (nesting depth <= option.DefaultMaxInlineDepth) 327 err := sonic.Pretouch(reflect.TypeOf(v)) 328 329 // with more CompileOption... 330 err := sonic.Pretouch(reflect.TypeOf(v), 331 // If the type is too deep nesting (nesting depth > option.DefaultMaxInlineDepth), 332 // you can set compile recursive loops in Pretouch for better stability in JIT. 333 option.WithCompileRecursiveDepth(loop), 334 // For a large nested struct, try to set a smaller depth to reduce compiling time. 335 option.WithCompileMaxInlineDepth(depth), 336 ) 337 } 338 ``` 339 340 ### 拷贝字符串 341 342 当解码 **没有转义字符的字符串**时， sonic 会从原始的 JSON 缓冲区内引用而不是复制到新的一个缓冲区中。这对 CPU 的性能方面很有帮助，但是可能因此在解码后对象仍在使用的时候将整个 JSON 缓冲区保留在内存中。实践中我们发现，通过引用 JSON 缓冲区引入的额外内存通常是解码后对象的 20% 至 80% ，一旦应用长期保留这些对象（如缓存以备重用），服务器所使用的内存可能会增加。我们提供了选项 `decoder.CopyString()` 供用户选择，不引用 JSON 缓冲区。这可能在一定程度上降低 CPU 性能。 343 344 ### 传递字符串还是字节数组？ 345 为了和 `encoding/json` 保持一致，我们提供了传递 `[]byte` 作为参数的 API ，但考虑到安全性，字符串到字节的复制是同时进行的，这在原始 JSON 非常大时可能会导致性能损失。因此，你可以使用 `UnmarshalString()` 和 `GetFromString()` 来传递字符串，只要你的原始数据是字符串，或**零拷贝类型转换**对于你的字节数组是安全的。我们也提供了 `MarshalString()` 的 API ，以便对编码的 JSON 字节数组进行**零拷贝类型转换**，因为 sonic 输出的字节始终是重复并且唯一的，所以这样是安全的。 346 347 ### 加速 `encoding.TextMarshaler` 348 349 为了保证数据安全性， `sonic.Encoder` 默认会对来自 `encoding.TextMarshaler` 接口的字符串进行引用和转义，如果大部分数据都是这种形式那可能会导致很大的性能损失。我们提供了 `encoder.NoQuoteTextMarshaler` 选项来跳过这些操作，但你**必须**保证他们的输出字符串依照 [RFC8259](https://datatracker.ietf.org/doc/html/rfc8259) 进行了转义和引用。 350 351 352 ### 泛型的性能优化 353 354 在 **完全解析**的场景下， `Unmarshal()` 表现得比 `Get()`+`Node.Interface()` 更好。但是如果你只有特定 JSON 的部分模式，你可以将 `Get()` 和 `Unmarshal()` 结合使用： 355 ```go 356 import "github.com/bytedance/sonic" 357 358 node, err := sonic.GetFromString(_TwitterJson, "statuses", 3, "user") 359 var user User // your partial schema... 360 err = sonic.UnmarshalString(node.Raw(), &user) 361 ``` 362 甚至如果你没有任何模式，可以用 `ast.Node` 代替 `map` 或 `interface` 作为泛型的容器： 363 ```go 364 import "github.com/bytedance/sonic" 365 366 root, err := sonic.GetFromString(_TwitterJson) 367 user := root.GetByPath("statuses", 3, "user") // === root.Get("status").Index(3).Get("user") 368 err = user.Check() 369 370 // err = user.LoadAll() // only call this when you want to use 'user' concurrently... 371 go someFunc(user) 372 ``` 373 为什么？因为 `ast.Node` 使用 `array` 来存储其子节点： 374 - 在插入（反序列化）和扫描（序列化）数据时，`Array` 的性能比 `Map` **好得多**； 375 - **哈希**（`map[x]`）的效率不如**索引**（`array[x]`）高效，而 `ast.Node` 可以在数组和对象上使用索引； 376 - 使用 `Interface()` / `Map()` 意味着 sonic 必须解析所有的底层值，而 `ast.Node` 可以**按需解析**它们。 377 378 **注意**：由于 `ast.Node` 的惰性加载设计，其**不能**直接保证并发安全性，但你可以调用 `Node.Load()` / `Node.LoadAll()` 来实现并发安全。尽管可能会带来性能损失，但仍比转换成 `map` 或 `interface{}` 更为高效。 379 380 ## 社区 381 382 Sonic 是 [CloudWeGo](https://www.cloudwego.io/) 下的一个子项目。我们致力于构建云原生生态系统。