Go中使用gjson來操作JSON資料的實現

2022-08-14 10:00:01

獲取值

Get查詢指定路徑, 通過.來區分. 比如"name.last"或者"age". 如果找到了匹配路徑, 將返回結果.

package main
import "github.com/tidwall/gjson"
const json = `{"name":{"first":"Janet","last":"Prichard"},"age":47}`
func main() {
    value := gjson.Get(json, "name.last")
    println(value.String())
}

輸出結果:

Prichard

同時有 GetMany 方法批次獲取值, 也有 GetBytes 方法獲取位元組切片.

路徑解析

路徑是一系列被.分隔的key拼接而成. 路徑可能包含萬用字元'*'和'?'. 通過下標存取陣列值. 通過'#'來獲取值在元素中的排位或存取子路徑. .和萬用字元可以通過''來跳脫.

{
  "name": {"first": "Tom", "last": "Anderson"},
  "age":37,
  "children": ["Sara","Alex","Jack"],
  "fav.movie": "Deer Hunter",
  "friends": [
    {"first": "Dale", "last": "Murphy", "age": 44},
    {"first": "Roger", "last": "Craig", "age": 68},
    {"first": "Jane", "last": "Murphy", "age": 47}
  ]
}

"name.last"          >> "Anderson"
"age"                >> 37
"children"           >> ["Sara","Alex","Jack"]
"children.#"         >> 3
"children.1"         >> "Alex"
"child*.2"           >> "Jack"
"c?ildren.0"         >> "Sara"
"fav.movie"         >> "Deer Hunter"
"friends.#.first"    >> ["Dale","Roger","Jane"]
"friends.1.last"     >> "Craig"

你同樣能通過#[...]來查詢陣列中的第一個匹配的項, 或通過'#[...]#'查詢所有匹配的項. 查詢支援==, !=, <, <=, >, >=比較運運算元和'%'模糊匹配.

friends.#[last=="Murphy"].first    >> "Dale"
friends.#[last=="Murphy"]#.first   >> ["Dale","Jane"]
friends.#[age>45]#.last            >> ["Craig","Murphy"]
friends.#[first%"D*"].last         >> "Murphy"

JSON 行

同樣支援JSON Lines, 使用 .. 字首, 把多行檔案視作陣列. 比如:

{"name": "Gilbert", "age": 61}
{"name": "Alexa", "age": 34}
{"name": "May", "age": 57}
{"name": "Deloise", "age": 44}

..#                   >> 4
..1                   >> {"name": "Alexa", "age": 34}
..3                   >> {"name": "Deloise", "age": 44}
..#.name              >> ["Gilbert","Alexa","May","Deloise"]
..#[name="May"].age   >> 57

ForEachLines 方法可以迭代json.

gjson.ForEachLine(json, func(line gjson.Result) bool{
    println(line.String())
    return true
})

Result Type

GJSON支援json型別包括 string, number, bool, and null. 陣列和物件被擋住基礎型別返回. Result 持有如下其中一種型別:

bool, for JSON booleans
float64, for JSON numbers
string, for JSON string literals
nil, for JSON null

直接存取value:

result.Type    // can be String, Number, True, False, Null, or JSON
result.Str     // holds the string
result.Num     // holds the float64 number
result.Raw     // holds the raw json
result.Index   // index of raw value in original json, zero means index unknown

有各種各樣的方便的函數可以獲取結果:

result.Exists() bool
result.Value() interface{}
result.Int() int64
result.Uint() uint64
result.Float() float64
result.String() string
result.Bool() bool
result.Time() time.Time
result.Array() []gjson.Result
result.Map() map[string]gjson.Result
result.Get(path string) Result
result.ForEach(iterator func(key, value Result) bool)
result.Less(token Result, caseSensitive bool) bool

result.Value() 方法返回 interface{} Go基本型別之一. result.Array() 方法返回一組值. 如果結果是不存在的值, 將會返回空陣列. 如果結果不是JSON陣列, 將會返回只包含一個值的陣列.

boolean >> bool
number  >> float64
string  >> string
null    >> nil
array   >> []interface{}
object  >> map[string]interface{}

64-bit integers

result.Int() 和 result.Uint() 返回的是64位元大數位.

result.Int() int64    // -9223372036854775808 to 9223372036854775807
result.Uint() int64   // 0 to 18446744073709551615

讀取巢狀陣列

假如你想從下列json獲取所有的lastName:

{
  "programmers": [
    {
      "firstName": "Janet", 
      "lastName": "McLaughlin", 
    }, {
      "firstName": "Elliotte", 
      "lastName": "Hunter", 
    }, {
      "firstName": "Jason", 
      "lastName": "Harold", 
    }
  ]
}

你可以使用如下路徑programmers.#.lastName:

result := gjson.Get(json, "programmers.#.lastName")
for _, name := range result.Array() {
    println(name.String())
}

你同樣能獲取陣列裡的物件:

name := gjson.Get(json, `programmers.#[lastName="Hunter"].firstName`)
println(name.String())  // prints "Elliotte"

物件或陣列迭代

ForEach方法允許你快速的迭代物件或陣列. key和value被傳遞給物件的迭代器函數. 只有value被傳遞給陣列. 迭代器返回false將會終止迭代.

簡易的Parse和Get

Parse(json)方法可以簡單的分析json, result.Get(path)查詢結果. 比如, 下面的幾種情況都將返回相同的結果:

gjson.Parse(json).Get("name").Get("last")
gjson.Get(json, "name").Get("last")
gjson.Get(json, "name.last")

檢查value是否存在

有時你想要知道值是否存在.

value := gjson.Get(json, "name.last")
if !value.Exists() {
    println("no last name")
} else {
    println(value.String())
}
// Or as one step
if gjson.Get(json, "name.last").Exists() {
    println("has a last name")
}

驗證JSON

Get* 和 Parse* 方法預期json格式是正常的, 如果不正常, 將會返回不可預料的結果. 如果你讀取的json來源不可預料, 那麼你可以通過GJSON這麼事先驗證.

if !gjson.Valid(json) {
    return errors.New("invalid json")
}
value := gjson.Get(json, "name.last")

反序列化到map

反序列化到map[string]interface{}:

m, ok := gjson.Parse(json).Value().(map[string]interface{})
if !ok {
    // not a map
}
## 處理Bytes
如果你的JSON包含位元組陣列切片, 與其呼叫`Get(string(data), path)`, 不如呼叫[GetBytes](https://godoc.org/github.com/tidwall/gjson#GetBytes)方法更優.
```go
var json []byte = ...
result := gjson.GetBytes(json, path)

如果你在使用gjson.GetBytes(json, path)方法, 並且你想避免從result.Raw 轉換到 []byte, 你可以使用這種模式:

var json []byte = ...
result := gjson.GetBytes(json, path)
var raw []byte
if result.Index > 0 {
    raw = json[result.Index:result.Index+len(result.Raw)]
} else {
    raw = []byte(result.Raw)
}

這是最好的模式, 不會為子切片重新分配記憶體. 這個模式使用了result.Index欄位, 它直接指向了raw data所處原來json中的位置. 如果result.Raw是轉換成[]byte的, result.Index將會為0.

一次獲取多個值

GetMany方法可以用於同時獲取多個值.

results := gjson.GetMany(json, "name.first", "name.last", "age")

返回值是[]Result型別, 總是返回正傳入路徑個數的數量.

到此這篇關於Go中使用gjson來操作JSON資料的實現的文章就介紹到這了,更多相關Go gjson操作JSON內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！