JSONキーをアルファベット順にソートする方法|配列は変わらない

公開ツールJSON整形・キーソートツール

目次
  1. なぜこの問題が起きるのか
  2. ツールを使わずに手作業でキーを並べ替える方法
  3. 並べ替えの前後を実際の例で比較する
  4. よくある勘違いと間違い
  5. まとめ
  6. よくある質問

JSONのキーの並べ替えは、オブジェクトのプロパティの順序だけをアルファベット順(または逆順)に変えるもので、配列の中の要素の順序やデータの値そのものには手を付けません。異なる時点で保存されたJSONやAPIレスポンスの2つを並べて比較したい人、乱雑な設定ファイルを見やすく整理したい人に必要な機能です。どのオプションがどこまで並べ替えるのかを正確に知っておかないと、望む結果は得られません。

まとめ ① 並べ替えはオブジェクトのキーの順序だけを変え、配列要素の順序とすべての値はそのまま保持されます。 ② 「再帰的に並べ替え」をオンにすると、ネストされたオブジェクトや配列内のオブジェクトのキーまで並べ替えられ、オフにすると最も外側のキーだけが並べ替えられます。 ③ JSONの構文が誤っていると、並べ替え結果の代わりにブラウザがそのまま表示するエラーメッセージだけが表示されます。

なぜこの問題が起きるのか

APIレスポンスや設定ファイルは、生成されるたびにキーの順序が変わりやすいものです。コードがオブジェクトにプロパティを追加した順序や、ライブラリが値を出力する順序によって、同じ情報を持つJSONであってもキーの並び順は毎回変わり得ます。

この状態で、昨日保存したJSONと今日受け取ったJSONをdiffや目視で比較すると、値はまったく同じなのに各行の位置だけが違って見えるため、実際の差分を見つけるのが難しくなります。キーを同じルール(アルファベット順)に揃えておけば、こうしたノイズが消え、本当に変わった値だけが目に留まります。

ただし、並べ替えが「内容を整理」してくれるわけではありません。並べ替えはあくまでキーが並ぶ順序を変えるだけです。この境界を正確に理解しておけば、結果を誤解せずに済みます。

ツールを使わずに手作業でキーを並べ替える方法

JSONのキーの並べ替えは、ブラウザや専用ツールがなくても、ターミナルや数行のコードで行えます。代表的な方法は次の2つです。

  • jqを使う: コマンドラインのJSON処理ツールjqには-S(並べ替え)オプションがあります。jq -S '.' data.jsonを実行すると、すべての階層のオブジェクトのキーがアルファベット順に並べ替えられた結果が出力されます。
  • Pythonを使う: python3 -c "import json;print(json.dumps(json.load(open('data.json')),sort_keys=True,indent=2))"を実行すると、同様にすべての階層のキーが並べ替えられた結果が得られます。

どちらの方法も「最上位だけを並べ替える」と「全体を再帰的に並べ替える」を選ぶことはできず、実行すれば常にすべての階層が並べ替えられます。逆に、配列そのものの順序はどちらの方法でも変わりません。jqもPythonも、配列は順序を持つリストとして扱い、並べ替えの対象にはしません。

構文エラーを事前に確認するには

構文が正しいかを事前に確認するには、python3 -m json.tool data.jsonを実行します。JSONが誤っていれば何行目の何列目で問題が起きたかを示すエラーが表示され、正しければフォーマットされた結果がそのまま出力されます。

毎回コマンドを打つ代わりに、ブラウザに貼り付けるだけで同じことを確認できます。当サイトの無料ツール「JSON整形・キーソートツール」で確認する。

JSON整形・キーソートツール

ブラウザで入力したJSONをすぐに整列・整形でき、データがサーバーに送信されることはありません。

並べ替えの前後を実際の例で比較する

次のJSONで並べ替えの前後を比較してみます。

{
  "name": "ワイヤレスイヤホン",
  "price": 89000,
  "stock": { "seoul": 12, "busan": 5, "daegu": 20 },
  "reviews": [
    { "rating": 5, "comment": "良いです" },
    { "rating": 3, "comment": "普通です" }
  ]
}

再帰オプションをオフにすると: 外側のキーだけが並べ替えられます

「キーのアルファベット順並べ替え」だけをオンにし、再帰オプションをオフにした状態で並べ替えると次のようになります。

{
  "name": "ワイヤレスイヤホン",
  "price": 89000,
  "reviews": [
    { "rating": 5, "comment": "良いです" },
    { "rating": 3, "comment": "普通です" }
  ],
  "stock": { "seoul": 12, "busan": 5, "daegu": 20 }
}

最も外側のキー(name、price、reviews、stock)だけがアルファベット順に並べ替えられました。reviews配列内の2件のレビューの順序も、各レビューオブジェクト内のrating・commentの順序も、stock内のseoul・busan・daeguの順序もそのままです。

再帰オプションをオンにすると: 内側のオブジェクトも配列内のオブジェクトも並べ替えられます

同じ状態で「再帰的に並べ替え」もオンにすると、結果が変わります。

{
  "name": "ワイヤレスイヤホン",
  "price": 89000,
  "reviews": [
    { "comment": "良いです", "rating": 5 },
    { "comment": "普通です", "rating": 3 }
  ],
  "stock": { "busan": 5, "daegu": 20, "seoul": 12 }
}

stockオブジェクトのキーがbusan、daegu、seoulの順に並べ替えられ、reviews配列内の各レビューオブジェクトもcomment、ratingの順にキーが並べ替えられました。ところが、reviews配列自体の2件のレビューの「順序」は依然としてそのままです。評価5のレビューが今も1件目です。再帰オプションはオブジェクトのキーの順序にだけ作用し、配列が含む要素の順序には関与しません。

インデントは見やすさだけを変えます

インデントの選択(2スペース/4スペース/タブ)は並べ替え結果や値には影響せず、改行と改行の間の空白の幅だけを変えます。同じ並べ替え結果を2スペースと4スペースでそれぞれ出力すると次のようになります。

{
  "a": 1,
  "b": 2
}
{
    "a": 1,
    "b": 2
}

タブを選ぶと、スペースの代わりにタブ文字でインデントされます。タブはコードエディタのタブ幅の設定によって、画面上で表示される幅が変わることがあります。

構文が間違っていると表示されるエラー

JSONの構文が1か所でも間違っていると、並べ替え結果は一切出力されず、パースに失敗したというエラーメッセージだけが表示されます。たとえば、閉じ中括弧が抜けた{"a":1を入力すると、ブラウザは"Unexpected end of JSON input"のように、入力が途中で途切れているというエラーを投げます。

余分なカンマが1つ付いた{"a":1,"b":2,}のように最後の項目の後ろにカンマが残っていたり、キーを引用符なしで{a:1}と書いた場合もパースに失敗します。このときは何文字目で問題が起きたかを示す位置情報を含むエラーが表示されますが、正確な文言や位置の表記はブラウザ(JavaScriptエンジン)やバージョンによって多少異なります。

共通しているのは1点です。ツールが自らエラーメッセージを作り出しているのではなく、JavaScriptエンジンが実際に投げたエラーをそのまま表示しているという点です。エラーメッセージに書かれた位置を見て、その箇所のカンマ・引用符・括弧を確認すればよいでしょう。

よくある勘違いと間違い

並べ替え機能を初めて使うときによくある勘違いをまとめると、次のとおりです。

勘違い実際の動作
並べ替えると配列の順序も変わる配列要素の順序は並べ替えオプションとは関係なく、常にそのままです
並べ替えのチェックボックスだけをオンにすればネストしたオブジェクトもすべて並べ替えられる「再帰的に並べ替え」を別途オンにしないと、内側のオブジェクトまでは並べ替えられません
並べ替えは値(value)も並べ替える変わるのはキーが並ぶ順序だけで、値は元のままです
構文が少し間違っていても勝手に整えてくれる構文が間違っているとパース自体が失敗し、結果は一切出力されません
逆順の並べ替えは元(入力)の順序に戻すことだ逆順はZ-Aのアルファベット逆順であり、入力した元の順序ではありません

まとめ

  • 並べ替えはオブジェクトのキーの順序だけをアルファベット順(または逆順)に変え、配列要素の順序とすべての値はそのまま保持します。
  • 「再帰的に並べ替え」をオフにすると最も外側のキーだけが、オンにするとネストしたオブジェクトや配列内のオブジェクトのキーまで並べ替えられます。
  • インデント(2スペース/4スペース/タブ)は見やすくするためのフォーマットにすぎず、並べ替え結果や値には影響しません。
  • JSONの構文が間違っていると、結果の代わりにJavaScriptエンジンが実際に投げたエラーメッセージがそのまま表示されます。
  • jq -SやPythonのsort_keys=Trueでも同じ作業を手作業で行えますが、これらは常に全体を再帰的に並べ替えるため、「最上位だけを並べ替える」は選べません。
JSON整形・キーソートツール

ブラウザで入力したJSONをすぐに整列・整形でき、データがサーバーに送信されることはありません。

よくある質問

並べ替えると元のデータの値も変わるのでしょうか?

いいえ。変わるのはオブジェクト内でキーが並ぶ順序だけで、文字列・数値・真偽値などの値そのものは一切変わりません。JSONの仕様(RFC 8259)でもオブジェクトのメンバーの順序は意味のある情報として規定されていないため、並べ替えは人が見やすいように順序を変える作業にすぎず、データの意味を変えるものではありません。

数値のキーも 1、2、10 の順に並ぶのでしょうか?

いいえ。並べ替えはキーを文字列として比較するため、"10" と "2" のように数値に見えるキーでも一文字ずつ比較します。最初の文字「1」が「2」より前にあるため、"10" が "2" より先に来る、辞書順(文字列)の並べ替え結果になります。

配列内のオブジェクトの順序を変えたい場合はどうすればよいですか?

この機能ではできません。並べ替えオプションはオブジェクトの「キー」の順序を変えるだけで、配列に含まれる「要素」の順序には、再帰オプションをオンにしても関与しません。要素そのものの順序を変えるには、別途並べ替えの作業が必要です。

入力したJSONはサーバーに送信されますか?

いいえ。解析や並べ替え、フォーマットの処理はすべてブラウザ内だけで行われ、サーバーには送信されません。

この記事は韓国語の原文をもとに作成しています。 韓国語の原文を読む

関連記事

  1. JSオブジェクトをJSONに変換する方法とエラーの原因コンソールからコピーしたJSオブジェクトをJSON.parseに渡すと出るUnexpected tokenエラーの原因を、JSONの文法ルールと比べて解説し、コンソールで変換する手順もまとめました。
  2. JSONスキーマ自動作成の型判定ルールとrequired・anyOfJSONの例を貼り付けるだけでDraft-07スキーマができる仕組みを解説します。文字列・数値・配列の型がどう判定されるのか、requiredとanyOfが何を意味するのか、例1つから作るスキーマの限界まで確認できます。
  3. JSON構文エラー 原因と位置の見つけ方Unexpected tokenなどJSONのエラー位置が何を指すのか、原因になりやすい書き方とあわせて解説。メッセージを読んで原因を絞り込む手順がわかります。
  4. JSON to TypeScript変換 ?と|が付く規則JSONをTypeScriptのinterfaceにするとき、一部の要素にしかないキーに付く?(optional)や、値の型が混ざったときの|(ユニオン)がどの規則で決まるのかを実例で確かめられます。
  5. JSONをYAMLに変換するときの配列とインデントの規則JSONの配列がハイフン(-)のリストに、ネストしたオブジェクトがインデント階層になる規則と、2スペース・4スペースの違い、KubernetesやDocker Composeに貼るときの間違いを整理します。
  6. JSONPathの使い方: 記号ごとの意味を例で確認$や.属性、[数字]、[*]、..がそれぞれ何を選ぶのかを例のJSONで一つずつ確認します。フィルタ式やスライスが使えない理由も事実関係で整理しました。

関連ツール