loading...

thumbnail

JSONの扱い方を解説!PythonやJavaScript・Swiftでの基本的な使用法とは。配列取得や出力方法も紹介

本記事にはPython・JavaScript・SwiftにおけるJSONの操作方法をまとめました。

操作で困ったことがある人や、言語ごとの違いを比較したい人は是非参考にしてみてください。

尚、サンプルとなるJSONファイルは共通で以下の「input.json」を使用します。

  1. {
  2.   “id”: 1,
  3.   “name”: “mike”,
  4.   “vaccin”: true,
  5.   “detail”: { “personality”: “friendly”, “disease”: null },
  6.   “children”: [
  7.     { “id”: 2, “name”: “kuro”, “vaccin”: true, “detail”: { “personality”: “sensitive” } },
  8.     { “id”: 3, “name”: “shiro”, “vaccin”: false, “detail”: { “personality”: “clever” }
  9.     }
  10.   ]
  11. }

それでは早速説明を始めていきましょう。

PythonでJSON・辞書型オブジェクト変換

動作確認環境は以下です。

  1. $ python –version
  2. Python 3.8.2

JSON・辞書型オブジェクト変換コード

PythonでJSONを扱う場合はWeb APIからの取得・データベースからの取得・ファイルストレージからの読込などが考えられます。

ここではローカルにあるJSONファイルからJSON定義を読み込み、取得した想定でコードを提示しました。

debug関数で型と変数の値を表示できるようにしています。デバッグの際にご利用下さい。

  1. import json, pprint
  2. def debug(value):
  3.     print(type(value))
  4.     # print(value)
  5.     pp = pprint.PrettyPrinter(indent=2)
  6.     pp.pprint(value)
  7.     return
  8. print(‘— JSONファイル読込 —‘)
  9. readWrapper = open(‘input.json’, ‘r’)
  10. print(‘— JSONの取得 —‘)
  11. inputJson = readWrapper.read()
  12. debug(inputJson)
  13. print(‘— JSONを辞書型オブジェクトに変換 —‘)
  14. dictObj = json.loads(inputJson)
  15. debug(dictObj)
  16. print(‘— 辞書型オブジェクトをJSONに変換 —‘)
  17. jsonStr = json.dumps(dictObj)
  18. debug(jsonStr)
  19. print(‘— JSONファイル書込 —‘)
  20. writeWrapper = open(‘output.json’ , ‘w’)
  21. writeWrapper.write(jsonStr)
  22. print(‘— JSONファイル整形出力 —‘)
  23. print(‘python -m json.tool output.json’)

Pythonでテキストファイルを読み込むときは、TextIOWrapperを使用します。第2引数にrを渡せば読み込み用、wを渡せば書込み用です。

「python -m json.tool output.json」を出力したJSONに対して実行すれば、整形された状態で出力することができます。

またpprintはデバッグ時のデータ表示に便利です。もし見辛い場合はコメントアウトされている通常のprintを利用下さい。

json.loadsとjson.dumps

json.loadsはJSONを辞書型オブジェクトに変換するメソッドです。

PythonでJSONを扱うときは辞書型オブジェクトにパースしてから、追加・編集・削除を行うようにします。

パース(parse)とはデータを解析しやすいデータ構造に変換する処理のことです。

json.loadsとjson.loadは別のメソッドなので注意して下さい。

またjson.dumpsは辞書型オブジェクトをJSONに変換するメソッドです。修正後の辞書型オブジェクトを元のJSON形式に戻します。

PythonでJSON由来の辞書型オブジェクト操作

キーボード,マウス,コーヒー

JSONから取得した辞書型オブジェクトの操作方法と出力方法をまとめました。

JSON由来の辞書型オブジェクト操作コード

以下のコードは前項のコードの下に追加していけば動作します。

  1. print(‘— 辞書型オブジェクトの操作 —‘)
  2. # 参照
  3. print(dictObj[‘name’])
  4. print(dictObj[‘children’])
  5. # 追加
  6. dictObj[‘pattern’] = ‘brown tabby’
  7. print(dictObj[‘pattern’])
  8. debug(dictObj)
  9. # 編集
  10. dictObj[‘pattern’] = ‘calico’
  11. print(dictObj[‘pattern’])
  12. debug(dictObj)
  13. # 削除
  14. dictObj.pop(‘pattern’)
  15. debug(dictObj)

Pythonで辞書型の値にアクセスする際は「オブジェクト[キー]」のように記述します。

またpopメソッドの引数にキーを指定すれば、指定したキーの要素を削除することができます。

辞書型オブジェクト

辞書型あるいはディクショナリ(dictionary)型の特徴はkeyとvalueのセットで1つの要素を表すデータ構造です。

辞書型であればJSONのデータ構造を保ったままPythonで取り扱うことができます。

上記以外にも多くのアクセス方法や操作メソッドが提供されているので、リファレンスなどを参照し適切な方法を見つけて下さい。

PythonでJSON由来の配列操作

オブジェクトが入れ子になっているだけで、基本的な操作方法は前項と変わりません。

異なる点といえば配列の要素にアクセスするときにインデックスを指定するくらいでしょう。

  1. print(‘— 辞書型オブジェクト配列の操作 —‘)
  2. # 参照
  3. print(dictObj[‘children’][0][‘name’])
  4. print(dictObj[‘children’][1][‘name’])
  5. # 追加
  6. dictObj[‘children’].append({
  7.     “id”: 4,
  8.     “name”: “nora”,
  9.     “vaccin”: False,
  10.     “detail”: {
  11.         “personality”: “naughty”
  12.     }
  13. })
  14. debug(dictObj[‘children’])
  15. # 編集
  16. dictObj[‘children’][2][‘name’] = ‘sabi’
  17. dictObj[‘children’][2][‘vaccin’] = True
  18. debug(dictObj[‘children’][2])
  19. # 削除
  20. newHome = dictObj[‘children’].pop()
  21. debug(newHome)
  22. debug(dictObj[‘children’])

JavaScriptでJSON・JavaScriptオブジェクト変換

動作確認環境は以下です。

  • https://code.jquery.com/jquery-3.5.0.min.js
  • Google Chrome v81.0.4044.113

  1. <!DOCTYPE html>
  2. <html lang=”ja”>
  3. <head>
  4. <meta charset=”utf-8″ />
  5. <title>JavaScript JSON</title>
  6. <script src=”https://code.jquery.com/jquery-3.5.0.min.js”
  7.         integrity=”sha256-xNzN2a4ltkB44Mc/Jz3pT4iU1cmeR0FkXs4pru/JxaQ=”
  8.         crossorigin=”anonymous”></script>
  9. </head>
  10. <body>
  11. <script type=”text/javascript” src=”script.js”></script>
  12. </body>
  13. </html>

以降、script.jsのコードを記載します。

JSON・JavaScriptオブジェクト変換コード

クライアント側のブラウザで動作するJavaScriptは、ローカルファイルを読み込むことはできません。

APIやサーバー上のJSONファイルを読み込んで処理を行うのが基本です。

このためサンプルコードは「127.0.0.1:3000」環境でサーバーを起動して動作させるようにしています。

  1. function debug(value) {
  2.   const copy = JSON.parse(JSON.stringify(value));
  3.   console.log(typeof copy);
  4.   console.log(copy);
  5. }
  6. console.log(‘— JSONファイル読込 —‘);
  7. $.getJSON(‘http://127.0.0.1:3000/input.json’, (inputObj) => {
  8.   console.log(‘— JavaScriptオブジェクトの取得 —‘);
  9.   debug(inputObj);
  10.   console.log(‘— JavaScriptオブジェクトをJSONに変換 —‘);
  11.   let jsonStr = JSON.stringify(inputObj);
  12.   debug(jsonStr);
  13.   console.log(‘— JSONをJavaScriptオブジェクトに変換 —‘);
  14.   let jsObj = JSON.parse(jsonStr);
  15.   debug(jsObj);
  16. });

JSON.stringifyとJSON.parse

JavaScriptでJSONをパースする際に使用するのが、JSON.parseメソッドです。

このメソッドで文字列のJSONをJavaScriptオブジェクトに変換します。またJSON.stringifyメソッドで元に戻すことが可能です。

JSONとJavaScriptオブジェクトは別物なので、取り扱う際は混同しないようにご注意下さい。

JSON由来のJavaScriptオブジェクト操作

JavaScriptオブジェクトを操作していきましょう。

JavaScriptオブジェクト操作コード

JavaScriptオブジェクトの操作コードは以下の通りです。

  1. console.log(‘JavaScriptオブジェクトの操作’);
  2. // 参照
  3. console.log(jsObj.name);
  4. console.log(jsObj.children);
  5. // 追加
  6. jsObj.pattern = ‘brown tabby’;
  7. console.log(jsObj.pattern);
  8. debug(jsObj);
  9. // 編集
  10. jsObj.pattern = ‘calico’;
  11. console.log(jsObj.pattern);
  12. debug(jsObj);
  13. // 削除
  14. delete jsObj.pattern;
  15. debug(jsObj);

Pythonと異なり「jsObj.pattern」のようにドットをつなげてアクセスします。

他に特筆すべき点はプロパティの削除メソッドdeleteです。

JSONとJavaScriptオブジェクト

JSONはキーをダブルクオーテーションで囲ってありますが、JavaScriptオブジェクトはキーを囲いません。

またJSONでは配列や同レベルのプロパティの末尾にカンマを付けない仕様になっていますが、JavaScriptオブジェクトでは使用可能です。

またJSONそのものに対して「jsObj.pattern」のように値を取得しようとするとundefinedになってしまいます。

JavaScriptでJSON由来の配列操作

JavaScriptもPythonとほぼ似た要領で値を取得・編集・削除することができるでしょう。

  1. console.log(‘JavaScriptオブジェクト配列の操作’);
  2. // 参照
  3. console.log(jsObj.children[0].name);
  4. console.log(jsObj.children[1].name);
  5. // 追加
  6. jsObj.children.push({
  7.   “id”: 4,
  8.   “name”: “nora”,
  9.   “vaccin”: false,
  10.   “detail”: {
  11.     “personality”: “naughty”
  12.   }
  13. });
  14. debug(jsObj.children);
  15. // 編集
  16. jsObj.children[2].name = ‘sabi’;
  17. jsObj.children[2].vaccin = true;
  18. debug(jsObj.children[2]);
  19. // 削除
  20. let newHome = jsObj.children.pop();
  21. debug(newHome);
  22. debug(jsObj.children);

注意したいのはデバック時のコンソール出力についてです。

debug関数を見ると「JSON.parse(JSON.stringify(value))」していると思います。

これをしないとコンソール出力が全て変更後の値になり、値が変わったのに出力が変わらないという状態になってしまうでしょう。

詳細は「プリミティブ型」「オブジェクト型」「deep copy」などで検索頂ければ記事が出てきます。

SwiftでJSON・データ型オブジェクト変換

動作確認環境は以下です。

  1. $ swift –version
  2. Swift version 5.2.2 (swift-5.2.2-RELEASE)
  3. Target: x86_64-unknown-linux-gnu

JSON・データ型オブジェクト変換コード

Swiftでは非常に厳密な型チェックが行われるため、他の2言語に比べるとかなり異なるコードになってしまっています。

  1. import Foundation
  2. protocol StringOrData { }
  3. extension Data: StringOrData { }
  4. extension String: StringOrData { }
  5. extension Dictionary: StringOrData { }
  6. func debug(value: StringOrData) {
  7.   print(type(of: value))
  8.   debugPrint(value)
  9.   return
  10. }
  11. print(“— JSONファイル読込 —“)
  12. let readHandle = FileHandle(forReadingAtPath: “input.json”)!
  13. print(“— データ型オブジェクトの取得 —“)
  14. let inputJson = readHandle.readDataToEndOfFile()
  15. debug(value: inputJson)
  16. readHandle.closeFile()
  17. print(“— データ型オブジェクトをJSONに変換 —“)
  18. let jsonStr = String(data: inputJson, encoding: .utf8)!
  19. debug(value: jsonStr)
  20. print(“— JSONをデータ型オブジェクトに変換 —“)
  21. let jsonData = jsonStr.data(using: .utf8)!
  22. debug(value: jsonData)
  23. print(“— データ型オブジェクトを辞書型に変換 —“)
  24. var dictObj: Dictionary<String, Any> = [:];
  25. do {
  26.   dictObj = try JSONSerialization.jsonObject(with: jsonData) as! Dictionary<String, Any>
  27.   debug(value: dictObj)
  28. } catch {
  29.   print(error)
  30. }
  31. print(“— JSONファイル書込 —“)
  32. let writeHandle = FileHandle(forWritingAtPath: “output.json”)!
  33. writeHandle.write(jsonData)
  34. writeHandle.closeFile()

Swiftでファイルからデータを読み込むのに利用するのがFileHandleクラスです。

Swiftではデータ型を更にJSONSerialization.jsonObjectで変換してからデータの修正を行わなければなりません。

クラスを定義してCodableプロトコルを使えば、もう少しスマートになるでしょう。

JSONSerialization.jsonObject

JSONSerialization.jsonObjectはデータ型オブジェクト型を、辞書型・配列型のオブジェクトに変換します。

import Foundation」を書かないと利用できないため、コードを移植する際はお気をつけ下さい。

SwiftでJSON由来の辞書型オブジェクト操作

Swiftにおける辞書型オブジェクトの操作方法について見ていきましょう。

JSON由来の辞書型オブジェクト操作コード

Swiftでは普通ダブルクオーテーションを使用します。また関数を呼び出すときに「value:」のような指定が必要です。

  1. print(“— 辞書型オブジェクトの操作 —“)
  2. // 参照
  3. print(dictObj[“name”] ?? “”)
  4. print(dictObj[“children”] ?? “”)
  5. // 追加
  6. dictObj[“pattern”] = “brown tabby”
  7. print(dictObj[“pattern”] ?? “”)
  8. debug(value: dictObj)
  9. // 編集
  10. dictObj[“pattern”] = “calico”
  11. print(dictObj[“pattern”] ?? “”)
  12. debug(value: dictObj)
  13. // 削除
  14. dictObj[“pattern”] = nil
  15. debug(value: dictObj)

また要素を削除するためのメソッドはなく、対象のキーに対してnilを代入することで削除されます。

printメソッド使用時の注意点

printメソッドに決まったように書かれている「?? “”」を削除すると、表示されるのが以下のエラーメッセージです。

「warning: expression implicitly coerced from ‘Any?’ to ‘Any’」

printメソッドは引数に非オプショナル型のインスタンスを指定しなければなりません。

しかしdictObj[“pattern”]の中身が必ずしもStringとは限らないため、警告が表示されてしまいます。

今回はサンプルコードのため上記のような対応をしましたが、実際の開発では値のキャストや変換などの処理が必要でしょう。

SwiftでJSON由来の配列操作

学生、タイピング、キーボード

最後にSwiftでの配列の扱い方について見ていきましょう。これでコードが出てくるのは最後です。

  1. print(“— 辞書型オブジェクト配列の操作 —“)
  2. // 参照
  3. var children = dictObj[“children”] as! [Dictionary<String, Any>]
  4. print(children[0][“name”] ?? “”)
  5. print(children[1][“name”] ?? “”)
  6. // 追加
  7. children.append([
  8.   “id”: 4,
  9.   “name”: “nora”,
  10.   “vaccin”: false,
  11.   “detail”: [
  12.     “personality”: “naughty”
  13.   ]
  14. ])
  15. dictObj[“children”] = children
  16. print(dictObj[“children”] ?? “”)
  17. // 編集
  18. children[2][“name”] = “sabi”
  19. children[2][“vaccin”] = true
  20. debug(value: children[2])
  21. // 削除
  22. let newHome = children.removeLast()
  23. debug(value: newHome)
  24. dictObj[“children”] = children
  25. print(dictObj[“children”] ?? “”)

3行目でわざわざキャストをしているのも、型チェックによる警告やエラーが発生するためです。

他の言語ではremoveやpopでしたが、SwiftではremoveLastメソッドに名称が変わっています。

まとめ

最後に、肝心な部分を言語ごとにまとめてみましょう。

PythonのJSON操作

Pythonは辞書型オブジェクトにパースした状態で解析を行う言語でした。

  • json.loads(JSONを辞書型オブジェクトに変換)
  • json.dumps(辞書型オブジェクトをJSONに変換)

JavaScriptのJSON操作

JavaScriptではJavaScriptオブジェクトに変換したものを操作します。

  • JSON.parse(JSONをJavaScriptオブジェクトに変換)
  • JSON.stringify(JavaScriptオブジェクトをJSONに変換)

SwiftのJSON操作

Swiftではデータ型として取得したJSONを、更に辞書型にパースすることで操作可能にしていました。

  • JSONSerialization.jsonObject(with:) as! Dictionary<String, Any>(データ型オブジェクトを辞書型に変換)

RANKING週間人気コラムランキング

RANKINGカテゴリーランキング

CATEGORY

TAG

TOP