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

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

テックアカデミーマガジンは受講者数No.1のプログラミングスクール「テックアカデミー」が運営。初心者向けにプロが解説した記事を公開中。現役エンジニアの方はこちらをご覧ください。 ※ アンケートモニター提供元:GMOリサーチ株式会社 調査期間:2021年8月12日~8月16日  調査対象:2020年8月以降にプログラミングスクールを受講した18~80歳の男女1,000名  調査手法:インターネット調査

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

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

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

田島悠介

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

大石ゆかり

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

田島悠介

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

大石ゆかり

お願いします!

目次

1時間でできる無料体験!

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のエスケープ文字であるため、JSONのエスケープで\(バックスラッシュ)が再度付与されるためです。

ちなみに、「1」の後の/(スラッシュ)はエスケープしても良い文字ですが、必須ではありません。

scriptタグを使うような場合など必要な場合だけエスケープしてください。

コラム

実は私も!?独学で損する人の特徴

「スクールは高いから独学で成功する」という気持ちの方は多いと思います。
もちろんその方が金額は低く抑えられるでしょう。
ただ 独学には向き不向きがあり、実はスクールが向いている人も大勢います。

そんな方のために参考として、 テックアカデミー卒業生がスクールを選んだ理由 をご紹介します。

  • ・困って挫折しそうなときに、質問や相談できる相手がいる環境で学んでいきたいなと思った
  • ・わかった気になっているだけだったので、自分を追い込む環境に置いた方がいいと感じた
  • ・スクールのカリキュラムで市場に求められるスキルを学ぶべきと思った

少しでも当てはまる部分があれば、 スクールが向いているかもしれません。
お試しのつもりで、まずは一度 無料相談 に参加してみませんか?

現役エンジニア・デザイナーに何でも気軽に相談できる30分すべて無料で できます。
無理な勧誘は一切ない ので、お気軽にご参加ください。

今なら相談した方限定の割引・参加特典付き! 無料相談はこちら

まとめ

JSONデータの扱いとエスケープについて紹介しました。

JSONの構文チェックができるサイトもたくさんあるので、構文の確認をする場合に使ってみてください。JSONLintは構文の確認ができるサイトの1つです。

監修してくれたメンター

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

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

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

大石ゆかり

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

田島悠介

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

大石ゆかり

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

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

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

初心者・未経験でもできる。まずはテックアカデミーに相談しよう

プログラミングを独学していて、このように感じた経験はないでしょうか?

  • ・調べてもほしい情報が見つからない
  • ・独学のスキルが実際の業務で通用するのか不安
  • ・目標への学習プランがわからず、迷子になりそう

テックアカデミーでは、このような 学習に不安を抱えている方へ、現役エンジニア講師とマンツーマンで相談できる機会を無料で提供 しています。
30分間、オンラインでどんなことでも質問し放題です。

「受けてよかった」と感じていただけるよう 厳しい試験を通過した講師 があなたの相談に真摯に向き合います。

「ただ気になることを相談したい」
「漠然としているがプロの話を聞いてみたい」

こんな気持ちでも大丈夫です。

無理な勧誘は一切ありません ので、まずはお気軽にご参加ください。
※体験用のカリキュラムも無料で配布いたします。(1週間限定)

今なら参加者限定の割引特典付き! 無料相談を予約する