JavaScriptのlocalStorage(動く例つき)

JavaScriptのlocalStorage

JavaScriptのlocalStorage:使用例、JSON、容量制限 | We.Inc

ライブのプレイグラウンドでlocalStorageを試し、保存した設定、ショッピングカート、テーマの実用的な例をコピーできます。JSONの扱い、容量制限、エラー、タブ間の同期も解説します。

localStorageは、オリジンごとにキーと値を保存するブラウザーの仕組みで、タブやブラウザーを閉じてもデータが残ります。保存にはsetItem(key, value)、読み取りにはgetItem(key)、削除にはremoveItem(key)、全消去にはclear()を呼び出します。値は常に文字列なので、オブジェクトはJSON.stringifyとJSON.parseで変換します。

Storage APIのすべてを1枚にまとめた表

  • メンバー
  • 動作
  • 戻り値
  • setItem(key, value)
  • エントリーを1件追加または上書きする
  • getItem(key)
  • エントリーを1件読み取る
  • 文字列、存在しない場合はnull
  • removeItem(key)
  • エントリーを1件削除する
  • clear()
  • このオリジンのすべてのエントリーを削除する
  • key(index)
  • 指定した位置にあるエントリーの名前
  • 文字列またはnull
  • 保存されているエントリーの数
  • 数値

ローカルストレージのバグの多くは、3つの意外な性質から生まれます。すべてが文字列に変わること、呼び出しが例外を投げる場合があること、データが1つの正確なオリジンに結びついていることです。下のプレイグラウンドは自分のブラウザーに書き込むので、これらのルールを実際に確認できます。続く例では、設定、ショッピングカート、テーマ切り替えの安全なパターンを紹介します。

  • プレイグラウンドにキーと値を入力し、保存を押します。エントリーがブラウザー内のこのページのストレージに書き込まれます。
  • 読み取りを押すと値を取得し、削除を押すと取り除きます。下の表には、このサイトが保存しているすべてのキーが表示されます。
  • 値の種類をオブジェクトに切り替えると、JSON.stringifyがテキストに変換し、JSON.parseが元に戻す様子を確認できます。
  • 下の例はどれも自分のプロジェクトにコピーできます。どの例もストレージへのアクセスをtryとcatchで囲んでいます。
  • shop:cartのようにキーに接頭辞を付けましょう。そうすれば、同じオリジン上の2つのスクリプトが互いのデータを上書きしません。
  • 構造化されたデータの横にバージョン番号を保存しておけば、リニューアル後に古い形式のデータを移行できます。
  • パスワード、トークン、個人情報は絶対にここに保存してはいけません。ページ上で動くどのスクリプトもすべてのエントリーを読めます。
  • 起動時に1回だけ読み取り、値はメモリに保持しましょう。各呼び出しは同期的で、メインスレッドをブロックします。
  • 訪問者がタブを閉じたらデータを消したい場合は、sessionStorageを使いましょう。

よくある質問

ローカルストレージにはどれくらいのデータを保存できますか?

MDNによると、現在のブラウザーではオリジンごとにlocalStorageが5 MiB、sessionStorageが別に5 MiBまでです。文字列はUTF-16で保存されるため、保存できる文字数はバイト数から想像するより少なくなります。上限を超えて書き込むとQuotaExceededErrorが発生します。

ローカルストレージのデータに有効期限はありますか?

ありません。エントリーは、コードで削除するか訪問者がサイトのデータを消去するまで残ります。プライベートウィンドウでは、最後のプライベートタブを閉じたときにブラウザーが消去します。有効期限が必要な場合は、値と一緒にタイムスタンプを保存し、読み取り時に確認しましょう。

getItemが"[object Object]"を返すのはなぜですか?

setItemは渡されたものを何でも文字列に変換します。普通のオブジェクトは[object Object]というテキストになり、データは失われます。JSON.stringify(obj)で保存し、JSON.parseで読み戻しましょう。

ローカルストレージはhttpとhttpsで共有されますか?

いいえ。ストレージはオリジン、つまりスキーム、ホスト、ポートの組み合わせに属します。http://example.comとhttps://example.comはそれぞれ別のストレージを持ち、サブドメインも同様です。

ブラウザーのタブ間で変更を同期するには?

windowでstorageイベントを監視します。同じオリジンの開いているドキュメントの1つが値を変更すると、ほかのドキュメントでこのイベントが発火し、key、oldValue、newValueが渡されます。変更を行ったタブ自身はこのイベントを受け取りません。

ローカルストレージとCookie、どちらを使うべきですか?

Cookieはリクエストのたびにサーバーへ送られるため、セッションに向いています。ローカルストレージはブラウザーの外に出ることがなく、より多くのデータを保存でき、テーマ、下書き、折りたたんだサイドバーなどのインターフェースの状態に向いています。

ローカルストレージが適している場面

  • インターフェースのちょっとした記憶に最適です。最後に開いたタブ、閉じたバナー、メッセージの下書き、好みの単位などです。こうしたデータが失われても少し不便になるだけで害はなく、ユーザーが簡単に消去できる性質とも合っています。
  • 失ってはいけないデータ、別の端末からも見る必要があるデータ、大量のデータには向いていません。注文はサーバーに、大きな構造化データは非同期で動くIndexedDBに保存すべきです。

すべての呼び出しにtryとcatchが必要な理由

  • 訪問者がサイトのデータを無効にしている場合など、ストレージがブロックされているとブラウザーはSecurityErrorを投げます。また、file:のURLで開いたページの動作はブラウザーによって異なります。ストレージがいっぱいの場合は、書き込み時にQuotaExceededErrorが発生します。
  • 失敗時に代わりの値を返す小さなラッパーを用意すれば、ページのほかの部分は動き続けます。下の例はすべてこの形を使っています。

安全に使うために

  • ストレージ内のデータは、サードパーティのウィジェットや、クロスサイトスクリプティングのバグで注入されたコードも含め、そのオリジン上のどのスクリプトからも読めます。ページに対して公開されているものとして扱いましょう。
  • 読み戻したデータも信頼できない入力です。使う前に検証し、HTMLとしてではなく必ずテキストとして表示しましょう。

localStorage、sessionStorage、Cookieの比較

データの保存期間と、誰が必要とするかでストレージを選ぶ

  • localStorage
  • sessionStorage
  • Cookie
  • 保存期間
  • 削除されるまで
  • タブを閉じるまで
  • 有効期限まで
  • タブ間での共有
  • あり、同じオリジン
  • なし、1つのタブのみ
  • あり
  • サーバーへの送信
  • なし
  • なし
  • あり、リクエストのたびに
  • 容量(MDNの数値)
  • オリジンごとに5 MiB
  • オリジンごとに5 MiB
  • 小さい、上限はブラウザーごとに異なる
  • APIの形式
  • 同期
  • 同期
  • document.cookieの文字列

コピーして使える例

JSONに対応した安全な読み書きヘルパー

ストレージのブロック、容量の超過、壊れたJSONを1か所で処理するので、ほかのコードで対処する必要はありません。

訪問者の設定を記憶する

デフォルト値と保存済みの値をマージするため、後で新しい設定を追加しても古い保存データが壊れません。

再読み込みしても消えない小さなショッピングカート

変更のたびに新しい配列を作って書き戻します。価格は引き続き決済時にサーバーが決定します。

システム設定にフォールバックするテーマ選択

何も保存されていなければ、OSの設定が優先されます。間違ったテーマが一瞬表示されるのを防ぐため、headの早い段階で実行しましょう。

有効期限付きのエントリー

ローカルストレージには組み込みの有効期限がないため、値と一緒に期限を保存し、読み取り時に古いエントリーを削除します。

開いているタブを同期する

storageイベントは同じオリジンのほかのすべてのタブに届くため、再読み込みなしでカートのバッジを更新できます。

このブラウザーではストレージがブロックされているため、すべての呼び出しが例外を投げます。コードにフォールバックが必要です。

{name}が発生しました:{message}

先にキーを入力してください。

{call}で{n}文字を保存しました。

{call}はnullを返しました:そのキーのエントリーはありません。

JSON.parseの結果:{value}

保存されたテキストはJSONではありません:{value}

{call}は文字列{value}を返しました

{call}が完了しました。

プレイグラウンドのエントリーを{n}件削除しました。このサイトのほかのキーはそのままです。

{name}プレイグラウンド

自分のブラウザーでエントリーを保存、読み取り、削除し、このサイトが保存しているすべてのキーを確認できます。プレイグラウンドのキーはdemo:で始まるため、サイトのキーと衝突しません。

キー

値

値の種類

プレーンな文字列

オブジェクト(JSON)

保存

読み取り

削除

プレイグラウンドのキーを消去

ここに結果が表示されます。

ブラウザーに保存されたプレイグラウンドのエントリー({n})

保存された文字列

無料で始める · クレジットカード不要

関連: ガイド|Webマーケティングと集客を学ぶ

製品

ご利用いただける方

機能

リソース

会社情報

サイトマップを見る