高分排行榜

物件

用其他語言的術語來說，JSON 物件就是「雜湊」、「映射」或「字典」。

JSON 對_物件_的定義如下：

物件是一組無序的名稱／值配對。 物件以{左大括號開始，以}右大括號結束。 每個_名稱_後面接著:冒號，而_名稱／值_配對之間以,逗號分隔。

名稱必須是字串。 名稱_的另一個說法是_鍵。

_值_可以是任何 JSON 型別。 同一個物件裡的不同_值_可以是不同的型別，就像下面這個例子。

{
  "name": "Jane",
  "age": 42,
  "pets": ["cat", "fish"],
  "address": {"street": "123 Main St", "city": "Springfield"}
}

請注意，_最後_一組鍵值配對後面不可以有逗號。

建立物件

用大括號收集名稱／值配對。 雖然名稱必須是字串，但只要名稱類似識別字（由英數字元和底線組成，且開頭不是數字），就不需要加上引號。

{name: "Jane", age: 42}

也可以使用不屬於_類似識別字_的鍵。 只要為它們加上引號就好。

{"first name": "Jane", "last name": "Lopez", age: 42}

如果名稱是某個運算式的結果，這個運算式必須放在括號裡。

$ echo "Jane" | jq -Rc '{.: 42}'
# verbose error message ...

$ echo "Jane" | jq -Rc '{(.): 42}'
{"Jane":42}

索引

用點記法就能從物件取出值。

{name: "Jane", age: 42} | .age    # => 42

如果沒辦法用識別字表示某個鍵，就改用括號記法。

"name" as $key | {name: "Jane", age: 42} | .$key    # => error
"name" as $key | {name: "Jane", age: 42} | .[$key]  # => "Jane"

新增或修改鍵值配對

要在陣列中新增一組鍵值配對，或是更新既有鍵的值，請使用=賦值運算子，並在左邊放一個索引運算式。

{name: "Jane", age: 42} | .sport = "tennis" | .age = 21
# => {
#      "name": "Jane",
#      "age": 21,
#      "sport": "tennis"
#    }

+運算子會_合併_物件。

{Richard: 54} + {Jane: 42}
# => {
#      "Richard": 54,
#      "Jane": 42
#    }

移除鍵

用del函式移除鍵。 它會回傳更新後的物件。

{name: "Jane", age: 42} | del(.age)   # => {"name": "Jane"}

del的參數是索引運算式（使用點記法或括號記法），會對應到物件中的某個鍵。 jq把它稱為路徑運算式。 只給一個字串是不夠的。

{name: "Jane", age: 42} | del(name)        # error: name/0 is not defined
{name: "Jane", age: 42} | del("name")      # error: Invalid path expression with result "name"
{name: "Jane", age: 42} | del(.name)       # OK
{name: "Jane", age: 42} | del(.["name"])   # OK

成員資格

• 要測試物件裡有沒有某個鍵，請使用has函式。

  {name: "Jane", age: 42} as $example
  |
    ($example | has("name")),    # => true
    ($example | has("sport"))    # => false
  

• 用in測試某個鍵是否在物件裡。

  {name: "Jane", age: 42} as $example
  |
    ("name"  | in($example)),    # => true
    ("sport" | in($example))     # => false
  

列出所有鍵

用keys函式輸出所有鍵的陣列。

{name: "Jane", age: 42} | keys   # => ["age", "name"]

請注意，keys會_排序_這些鍵。 如果想按原本的順序取出鍵，請改用keys_unsorted。

沒有對等的函式可以列出所有的_值_。 不過.[]篩選器會把物件的值以_串流_的形式輸出，而這個串流可以用[...]陣列建構式接住。

[{first: "Jane", last: "Lopez", status: "awesome!"} | .[]]
# => ["Jane", "Lopez", "awesome!"]

疊代

• map_values(filter)函式會把篩選器套用到物件裡的每個_值_。

  {first: "Jane", last: "Lopez", status: "awesome!"}
  | map_values(ascii_upcase)
  # => {"first": "JANE", "last": "LOPEZ", "status": "AWESOME!"}
  

• 要疊代一個物件，必須先把它轉成由鍵值物件組成的陣列。 to_entries函式就是做這件事的。

  {name: "Jane", age: 42} | to_entries'
  # => [
  #      {
  #        "key": "name",
  #        "value": "Jane"
  #      },
  #      {
  #        "key": "age",
  #        "value": 42
  #      }
  #    ]
  

  到這裡就能使用陣列的疊代函式，例如map。

• from_entries函式則是反過來：把由鍵值物件組成的陣列轉換成物件。

  [
    {"key":"name", "value":"Jane"},
    {"key":"age", "value":42}
  ] | from_entries                  # =>{"name": "Jane", "age": 42}
  

• 想把篩選器套用到物件裡的_每一組_鍵值配對，請使用with_entries(filter)函式。

  例如，假設有一個把名稱對應到年齡的物件，就能像下面這樣把鍵和值互換。

  {"Jane": 42, "Richard": 54}
  | with_entries({key: (.value | tostring), value: .key})
  

  輸出

  {
    "42": "Jane",
    "54": "Richard"
  }
  

  with_entries(filter)等同於

  to_entries | map(filter) | from_entries