JSONとは
JSON(JavaScript Object Notation)は、データを {"キー": 値} の形で表すテキスト形式です。読み書きしやすく、ほとんどのプログラミング言語で扱えるため、Web API のやり取りや設定ファイル(package.json など)で標準的に使われています。
| 型 | 例 |
|---|---|
| 文字列 | "山田"(必ずダブルクォート) |
| 数値 | 30、3.14、-1e10 |
| 真偽値 | true、false |
| null | null |
| 配列 | [1, 2, 3] |
| オブジェクト | {"a": 1} |
JSONエンコード・デコードとは
JSON のエンコードは、プログラムの中のデータ(オブジェクトや配列)を JSON の文字列にすることです。デコードは、その逆で JSON の文字列をデータに戻すことです。シリアライズ・パースと呼ぶこともあります。URLエンコード や Base64エンコード とは別の話で、データの形式を変える点だけが共通しています。
| 言語 | エンコード(データ → JSON) | デコード(JSON → データ) |
|---|---|---|
| JavaScript | JSON.stringify(obj) | JSON.parse(str) |
| Python | json.dumps(obj, ensure_ascii=False) | json.loads(str) |
| PHP | json_encode($v, JSON_UNESCAPED_UNICODE) | json_decode($str, true) |
| Ruby | obj.to_json | JSON.parse(str) |
| Go | json.Marshal(v) | json.Unmarshal(data, &v) |
| Java(Jackson) | mapper.writeValueAsString(obj) | mapper.readValue(str, Type.class) |
エンコードした結果は1行にまとまるため、読みにくいときはこのツールで整形してください。
よくある構文エラー
| 原因 | 誤り | 正しい書き方 |
|---|---|---|
| 末尾のカンマ | {"a": 1,} | {"a": 1} |
| シングルクォート | {'a': 1} | {"a": 1} |
| キーのクォート忘れ | {a: 1} | {"a": 1} |
| コメント | // メモ | JSON ではコメントは書けない |
| undefined / NaN | {"a": undefined} | {"a": null} |
整形(pretty print)と圧縮(minify)の使い分け
改行やインデントは JSON の意味に影響しないため、整形しても圧縮してもデータの中身は同じです。整形は人が読んだり、Git で差分を見たりするため、圧縮は API のレスポンスや保存容量を小さくするために使います。インデントは2スペースが一般的ですが、プロジェクトのルールに合わせて4スペースやタブも選べます。
各言語・ツールでJSONを整形する
| 言語・ツール | 整形する方法 |
|---|---|
| JavaScript | JSON.stringify(obj, null, 2) |
| Python | json.dumps(obj, indent=2, ensure_ascii=False) |
| PHP | json_encode($v, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE) |
| Ruby | JSON.pretty_generate(obj) |
| Go | json.MarshalIndent(v, "", " ") |
| Java(Jackson) | mapper.writerWithDefaultPrettyPrinter().writeValueAsString(obj) |
| jq | jq . data.json(圧縮は jq -c .) |
| Python(コマンド) | python3 -m json.tool data.json |
| VS Code | Shift + Alt + F(Mac は Shift + Option + F)で「ドキュメントのフォーマット」 |
| Chrome 開発者ツール | Network タブでレスポンスを選び、「Preview」で折りたたみ表示 |
Python と PHP は、オプションを付けないと日本語が \u3042 のようにエスケープされます。読みやすくしたいときは ensure_ascii=False / JSON_UNESCAPED_UNICODE を指定してください。
JSONにコメントや末尾カンマを書きたいとき
標準の JSON ではコメントも末尾のカンマも書けません。VS Code の settings.json や tsconfig.json でコメントが書けるのは、JSONC(JSON with Comments)という拡張形式だからです。さらに緩い JSON5 では、シングルクォートやキーのクォート省略も許されます。これらを通常の JSON として読み込むとエラーになるので、設定ファイル以外では標準の JSON に揃えるのが安全です。
よくある質問
大きな数値の桁が変わってしまいます
JavaScript の数値は 253(約9千兆)を超える整数を正確に扱えません。Twitter(X)の ID のような大きな整数は、整形すると末尾の桁が変わる場合があります。正確さが必要な値は文字列として扱ってください。
「キーを並べ替える」は何に使いますか?
オブジェクトのキーをアルファベット順に並べます。2つのJSONを比較(diff)するときに、キーの順番の違いを無視して中身の違いだけを確認できます。
日本語が \u3042 のように表示されるJSONを読みたい
整形すると \uXXXX 形式の文字は日本語に戻って表示されます。文字列だけを変換したい場合は Unicodeエスケープ変換 も使えます。
APIのレスポンスを貼り付けても大丈夫ですか?
入力したJSONはブラウザ内で処理され、サーバーには送信されません。ただし、トークンや個人情報を含むデータは取り扱いに注意してください。
エラーの行番号は出るのに、どこが間違いか分かりません
JSON のパーサーは「正しく読めなくなった場所」を報告するため、本当の原因はその直前にあることが多いです。示された位置のすぐ前にある、カンマの抜け・余分なカンマ・閉じていないクォートや括弧を確認してください。
数値をクォートで囲む必要はありますか?
数値(30)はクォートなし、文字列("30")はクォートありで、型が異なります。郵便番号や電話番号のように先頭の 0 を残したい値や、桁が大きい ID は文字列にしておくと安全です。
JSONとYAML・XMLの違いは?
どれも構造化データを表すテキスト形式です。JSON は書式が厳密で機械処理向き、YAML はインデントで構造を表し設定ファイル向き、XML はタグで囲む形式で古くからの文書やSOAPで使われます。Web API のやり取りでは JSON が最も一般的です。
JSONエンコードとURLエンコードの違いは?
JSON エンコードはデータを JSON 形式の文字列にすること、URL エンコードは URL に入れられない文字を %E3%81%82 のような形に置き換えることです。JSON を URL のクエリに渡すときは、JSON エンコードをしたあとに URL エンコードも行います。