【JavaScript ECMAScript】JSON::JSON.stringify静的メソッドの使い方
JSON.stringify()静的メソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
JSON.stringify()メソッドは、JavaScriptのオブジェクトやプリミティブな値を、軽量なデータ交換フォーマットであるJSON（JavaScript Object Notation）形式の文字列に変換するメソッドです。このメソッドは、Webアプリケーションでデータをサーバーに送信する際や、ブラウザのlocalStorageなどのストレージにオブジェクトを保存する際に非常に重要です。JavaScriptのオブジェクトを直接ストレージに保存したり、HTTP通信で送信したりすることはできないため、一度文字列に変換する必要があります。
第一引数には、JSON形式に変換したいJavaScriptの値を指定します。オブジェクト、配列、文字列、数値、真偽値、nullなどを変換できます。第二引数には、オプションで変換するプロパティをフィルタリングする関数（replacer関数）や、含めるプロパティ名を指定する文字列配列を渡すことが可能です。これにより、オブジェクトの一部分のみを変換したり、機密情報を除外したりする柔軟な制御が行えます。第三引数には、生成されるJSON文字列のインデント（スペースやタブ）の数を指定できます。これにより、デバッグ時や人が読む際の可読性を向上させることができます。
関数、Symbol、undefined、または循環参照を持つオブジェクトなど、JSON形式で表現できない値は変換時に無視されるか、エラーの原因となる場合がありますのでご注意ください。変換に成功した場合、結果としてJSON形式の文字列が返されます。
構文(syntax)
1JSON.stringify(value, replacer, space)
引数(parameters)
value, replacer = undefined, space = undefined
- value: JSON に変換したい JavaScript の値 (オブジェクト、配列、プリミティブ値など)
- replacer = undefined: オプション。JSON 文字列に含めるプロパティをフィルタリングしたり、値の変換を行ったりするための関数または配列
- space = undefined: オプション。JSON 文字列のインデントに使用するスペースまたは文字列。整形された出力を生成します
戻り値(return)
string
JavaScriptオブジェクトをJSON形式の文字列に変換したものを返します。