JSONの整形・構文チェック|3つの方法とツール、具体例を解説

 2023.04.13  株式会社システムインテグレータ

TSC

JSONJavaScript Object Notation)は、データ交換用の軽量なフォーマットで、人間にもコンピューターにも理解しやすい構造を持っています。

一方で、JSONデータを扱う際には、整形や構文チェックが重要です。今回は、JSONの整形・構文チェックの方法とおすすめツールについて解説します。

Young pretty asian woman touching digital hologram

JSONの整形とは

JSONの整形とは、JSONデータを見やすく、読みやすい形式に変換することです。整形されたJSONデータは、インデントやスペースが適切に調整されており、データ構造が一目で分かるようになります。これにより、デバッグやデータ解析が効率的に行えます。

JSONの整形の例

以下に、整形前と整形後のJSONデータの例を示します。

整形前のJSONデータ:

整形前のJSONデータ:

{"name":"Madoka","age":14,"hobbies":["painting","traveling","archery"],"address":{"country":"Japan","city":"Tokyo"}}

 

整形後のJSONデータ:
{
        "name": "Madoka",
        "age": 14,
        "hobbies": [
                "painting",
                "traveling",
                "archery"
        ],
        "address": {
                "country": "Japan",
                "city": "Tokyo"
        }
}

整形後のJSONデータでは、インデントや改行が適切に調整され、データ構造が一目で分かりますよね。これにより、データの読みやすさが向上し、デバッグや解析が容易になります。

JSONの構文チェックとは

JSONの構文チェックとは、JSONデータの文法が正しいか確認することです。構文エラーがあると、データの解析や処理ができなくなってしまいます。

JSONの構文 よくある間違いの例

JSONの構文でよく間違えられるポイントの1つは、「キー(プロパティ名)と文字列リテラルのクォーテーション」です。

 JSONでは、キー(プロパティ名)と文字列リテラルの両方にダブルクォーテーション(")を使用する必要があります。シングルクォーテーション(')やバックティック(`)は使用できません。しかし、JavaScriptのオブジェクトリテラルではシングルクォーテーションやバックティックが許容されているため、誤ってそれらを使用してしまうことがあります。

正しいJSONの例:
{
        "name": "Hitomi",
        "age": 14
}

誤ったJSONの例(キーにシングルクォーテーションを使用):

{
        'name': 'Hitomi',
        'age': 14
}

 

JSONの整形・構文チェック方法

JSONの整形・構文チェックには、さまざまな方法がありますが、主に以下の3つの方法があります。
   a. オンラインツールを使用する
   b. プログラミング言語の機能を利用する
   c. コードエディターのプラグインを利用する

(方法1)オンラインツールを使用した整形・構文チェック

JSON整形・構文チェックツールの一例を紹介します。

JSON Formatter & Validatorhttps://jsonformatter.curiousconcept.com/
JSONデータを貼り付けるだけで、簡単に整形や構文チェックができるツールです。エラー箇所のハイライト表示もあります。

JSONLinthttps://jsonlint.com/
JSONデータの整形・構文チェックができるだけでなく、データを圧縮する機能もあるツールです。

 ただし、オンラインツールを使用する際には、特にセキュリティとプライバシーへの配慮が必要です。機密性の高い情報や個人情報が含まれるJSONデータを整形・構文チェックする場合、第三者にデータが漏洩するリスクがあるため、注意が必要です。信頼性のあるツールを選ぶことや、事前にセンシティブな情報を削除・マスキングすることが重要です。

 (方法2)プログラミング言語の機能を利用した整形・構文チェック

プログラミング言語のライブラリやメソッドを利用したチェック方法もあります。

Pythonjsonモジュール
Pythonの標準ライブラリであるjsonモジュールを使用すると、JSONデータの整形や構文チェックが簡単にできます。

JavaScriptJSON.parse() JSON.stringify()
JavaScriptの標準機能を利用することで、JSONデータの整形や構文チェックが可能です。JSON.parse()は、JSON文字列をオブジェクトに変換し、構文チェックを行います。一方、JSON.stringify()は、オブジェクトを整形されたJSON文字列に変換します。

 (方法3)コードエディターのプラグインを利用した整形・構文チェック

最後にエディタを利用したチェック方法の例を2つ紹介します。

Visual Studio CodePrettier
Visual Studio CodeVSCode)は、多くの開発者に支持されているコードエディターです。Prettierというプラグインをインストールすることで、JSONデータの整形・構文チェックが簡単に行えます。

Atomatom-beautify
Atomは、GitHubが開発したオープンソースのコードエディターです。atom-beautifyというプラグインをインストールすることで、JSONデータの整形・構文チェックができます。

まとめ

本記事では、JSONデータの整形・構文チェックについて、その方法とおすすめツールを紹介しました。

整形や構文チェックは、JSONデータの読みやすさやデバッグ作業の効率を向上させる重要なステップです。セキュリティやプライバシーにも注意を払いながら、整形・構文チェックをしっかり行い、より良いソフトウェア開発を実現していきましょう!


-----参考情報-----
■TV出演動画:ええじゃない課Biz(2022/05/29 放送 TOKYO MX)
アンタッチャブル柴田さん、アルコ&ピースさんがレギュラーのビジネス情報番組「ええじゃない課Biz」にて、プログラミングスキル判定サービス「TOPSIC」と企業・学校対抗プログラミングコンテスト「PG BATTLE」のご紹介をさせていただきました。


教養としてのプログラミング入門BOOK

RELATED POST関連記事


RECENT POST「プログラミング」の最新記事


プログラミング

【初心者向け】SQLとは?データベース言語の基礎知識から具体例まで分かりやすく解説

プログラミング

【初心者向け】JSONとは?データ形式の基礎や書き方、使用例などを解説

プログラミング

UPDATE文(SQLを基本から学ぶシリーズ)

プログラミング

サーバーサイドエンジニアとは? 仕事内容や年収、必要なスキル・知識を解説

JSONの整形・構文チェック|3つの方法とツール、具体例を解説

TOPSIC TOPへ

新規CTA

TOPSIC-SQL4コマ漫画

RANKING人気資料ランキング

RANKING人気記事ランキング

RECENT POST 最新記事