JavaScriptでJSONのエスケープを行う方法を現役エンジニアが解説【初心者向け】

初心者向けにJavaScriptでJSONのエスケープを行う方法について解説しています。データフォーマットのひとつJSONの特徴と構文規則、エスケープ処理を行う理由とエスケープが必要な文字の例、書き方を学習しましょう。

TechAcademyマガジンは受講者数No.1のオンラインプログラミングスクールTechAcademy [テックアカデミー]が運営。初心者向けに解説した記事を公開中。現役エンジニアの方はこちらをご覧ください。

JavaScriptでJSONのエスケープを行う方法について、TechAcademyのメンター(現役エンジニア)が実際のコードを使用して初心者向けに解説します。

そもそもJavaScriptについてよく分からないという方は、JavaScriptとは何なのかについて解説した記事を読むとさらに理解が深まります。

 

なお本記事は、TechAcademyのオンラインブートキャンプJavaScript/jQuery講座の内容をもとにしています。

 

田島悠介

今回は、JavaScriptに関する内容だね!

大石ゆかり

どういう内容でしょうか?

田島悠介

JSONのエスケープを行う方法について詳しく説明していくね!

大石ゆかり

お願いします!

 

目次

 

JSONとは

JSONはJavaScript Object Notationの略で、JavaScriptのオブジェクトをベースにしたデータのフォーマットです。そのため、JSONのフォーマットとJavaScriptのオブジェクトはよく似た形をしています。

下記はJSONデータの例です。

{
  "name": "テックアカデミージュニア",
  "age": 15,
  "langulage": "JavaScript"
}

JSONのフォーマットでおさえておきたいポイントを2つ紹介します。

文字列は”(ダブルクォート)で囲う

JavaScriptでは’(シングルクォート)でも囲えますが、JSONは”(ダブルクォート)のみです。

プロパティ名は必ず”(ダブルクォート)で囲う

値は数値や配列の場合などに”(ダブルクォート)で囲わないことがありますが、プロパティ名は”(ダブルクォート)で囲う必要があります。その他JSONの仕様については、情報通信システムの標準化団体であるEcmaインターナショナルから出ているJSONデータのpdfで確認できます。

 

[PR] フロントエンドで挫折しない学習方法を動画で公開中

エスケープ処理の必要性

エスケープ処理とは、構文に影響を及ぼすような文字を、影響がでない別の文字に置き換えることです。例えばJSONの場合、文字列を”(ダブルクォート)で囲いますが、下記のように途中に”がある場合、どこからどこまでが文字列かわからなくなり、構文エラーになります。

"テックアカデミー"ジュニア "

エスケープは直前に\(バックスラッシュ)を使いおこないます。/(スラッシュ)と間違えないように注意してください。先程の文字列をエスケープする場合は下記のようになります。

"テックアカデミー\"ジュニア "

他にエスケープが必要な文字は下記になります。
“(ダブルクォート)
\(バックスラッシュ)
U+0000からU+001Fまでの制御文字

制御文字とは、改行とかタブなどのことです。制御文字を表示できるエディタもありますが、基本的には表示はされずに動作する文字になります。

 

JavaScriptでJSONのエスケープを行う方法

JavaScriptのオブジェクトをどこかのネットワークに送るような場合に、データの形式にJSONフォーマットが指定されるケースが増えています。JavaScriptのオブジェクトをJSONフォーマットに変換する場合は、JSON.stringifyメソッドを使います。また、JSON.stringifyメソッドを使うとエスケープが必要な文字がエスケープされます。

下記にJavaScriptのオブジェクトを用意しました。

{ "name": `2020"1/1 あいう	えお
かき\くけ\\こ` }

プロパティ名はnameとしています。
値はJavaScriptの文字列に、`(バッククォート)を使いテンプレート文字列として、下記の5つのエスケープ対象の文字を含んでいます。

  1. 「2020」の後の”(ダブルクォート)
  2. 「あいう」の後のタブ文字(テキスト上は見えませんがタブによるスペースができています)
  3. 「えお」の後の改行文字(テキスト上は見えませんが改行されています)
  4. 「かき」の後の\(バックスラッシュ)
  5. 「くけ」の後の\\(バックスラッシュ2つ)

このJavaScriptのオブジェクトをJSON.stringifyを使ってJSON文字列に変換して見ます。

let jsonString = JSON.stringify( { "name": `2020"1/1 あいう	えお
かき\くけ\\こ` });

jsonStringという変数にJSON文字列が格納されました。格納されたJSON文字列は下記になります。

{"name":"2020\"1/1 あいう\tえお\nかきくけ\\こ"}

格納された結果から、エスケープされた文字を確認します。

  1. 「2020」の後の”(ダブルクォート)は、前に\がついてエスケープされています
  2. 「あいう」の後のタブ文字は、\tにエスケープされています
  3. 「えお」の後の改行文字は、\nにエスケープされています
  4. 「かき」の後の\は、消えています。これは、\(バックスラッシュ)がJavaScriptのエスケープ文字であるためJSONに変換される前になくなるためです
  5. 「くけ」の後の\\は、\\のままです。これは、\がJavaScriptのエスケープ文字であるため、\が1つとみなされ、JSONのエスケープで\が再度付与されるためです。

ちなみに、「1」の後の/(スラッシュ)はエスケープしても良い文字ですが、必須ではありません。scriptタグを使うような場合など必要な場合だけエスケープしてください。

 

まとめ

JSONデータの扱いとエスケープについて紹介しました。JSONの構文チェックができるサイトもたくさんあるので、構文の確認をする場合に使ってみてください。JSONLintは構文の確認ができるサイトの1つです。

 

監修してくれたメンター

横山茂雄(よこやましげお)

フリーエンジニアとして活動中。サーバーサイドからフロントまで時代の波に合わせてスキルを変化させてきました。

言語、フレームワーク、DB、現場、いずれも転々としながら、筋トレも欠かさない体育会系エンジニアです。TechAcademyジュニアのゲームアプリコースを担当しています。

 

大石ゆかり

内容分かりやすくて良かったです!

田島悠介

ゆかりちゃんも分からないことがあったら質問してね!

大石ゆかり

分かりました。ありがとうございます!

 

TechAcademyでは、初心者でもJavaScript・jQueryを使ったWebサービス公開を習得できるオンラインブートキャンプJavaScript/jQuery講座を開催しています。

挫折しない学習方法を知れる説明動画や、現役エンジニアとのビデオ通話とチャットサポート、学習用カリキュラムを体験できる無料体験も実施しているので、ぜひ参加してみてください。