PR

クッキーより便利になったブラウザ標準ストレージ - Web Storage

2012年10月18日(木)
山田 祥寛(YAMADA, Yoshihiro)

Web Storage(以降、ストレージ)とは、ブラウザ標準で用意されたデータストアの一種です。データを特定するための名前(キー)と値との組み合わせでデータを管理することから、Key-Value型データストアと呼ばれることもあります。あまりに複雑なデータ管理には不向きですが、ちょっとしたデータを管理するのに有効です(*)

*)例えばAmazonでは「この商品を買った人はこんな商品も買っています」という表示項目のページ番号管理に、ストレージを利用しています。

このようなデータストアとしては、従来、クッキー(Cookie)がありましたが、表1のような違いがあります。環境が許すのであれば、今後はストレージを優先して利用することをお勧めします。

表1:ストレージとクッキーの違い

項目 ストレージ クッキー
データサイズ 大(5MB) 小(4KB)
有効期限 なし あり
通信 発生しない リクエスト都度、サーバにも送信
[第5回目次]
  • TIPS 034:ストレージにデータを保存する
  • TIPS 035:ストレージのデータを取得する
  • TIPS 036:ストレージのデータをツールから確認する
  • TIPS 037:ストレージからすべてのデータを取り出す
  • TIPS 038:ストレージ上のデータを削除する
  • TIPS 039:ストレージにオブジェクトを出し入れする
  • TIPS 040:ストレージの登録/更新/削除を監視する

サンプル一式は、会員限定特典としてダウンロードできます。記事末尾をご確認ください。

ストレージは、大きくセッションストレージとローカルストレージに分類できます。両者の違いは有効範囲です。

セッションストレージ(Session Storage)は、ブラウザが起動している間だけ有効です。ブラウザを閉じたタイミングでデータは破棄されますし、異なるウィンドウ/タブ同士でもデータを共有することはできません。

一方、ローカルストレージ(Local Storage)は、オリジン単位でデータを管理します。ブラウザを閉じてもデータが消えることはありませんし、異なるウィンドウ/タブからも同じデータを共有することが可能です。

オリジンとは「http://www.wings.msn.to:8080/」のように、「プロトコル://ホスト:ポート番号」の組み合わせのことです。ストレージはオリジンの単位で独立していますので、現在のホストで保存したデータを異なるホストで読み込むということはできません。

アプリを利用している間だけ維持しておきたい情報はセッションストレージを、閉じたあとも維持したい情報はローカルストレージという使い分けになるでしょう。先ほどのAmazonの例であれば、その場限りの情報なのでセッションストレージを利用しています。

表2:WebStorageの対応バージョン

ブラウザ 対応バージョン
Internet Explorer 8以降
Firefox 3.6以降
Google Chrome 8以降
Safari 5以降
Opera 11以降

TIPS 034:ストレージにデータを保存する

さまざまな記法で、ストレージにデータを保存してみましょう。例えば以下は、現在時刻をローカルストレージに保存する例です。

[リスト01]ストレージに現在時刻を保存するコード(set.html)

  window.addEventListener('DOMContentLoaded',
    function() {
      // ストレージが利用できるかをチェック(1)
      if (localStorage) {
        // ローカルストレージを呼び出し(2)
        var storage = localStorage;
        var current = (new Date()).toLocaleString();
        // ストレージに現在時刻をセット(3)
        storage.setItem('lastAccessed', current);
        storage.lastAccessed2 = current;
        storage['lastAccessed3'] = current;
      }
    }
  );

ストレージは新しい機能なので、利用する前にまず、ブラウザが対応しているかをチェックしなければなりません。これを行っているのが(1)です。

localStorage(正確にはwindow.localStorage)は、ローカルストレージにアクセスするためのプロパティです。(1)ではlocalStorageプロパティにアクセスしてみて、アクセスできればストレージに対応していると判断し、以降の処理を行っているわけです(第1回第2回にも登場した「機能テスト」です)。

ストレージを利用する際は、最初にlocalStorageプロパティの値(localStorageオブジェクト)を変数storageに格納しておくと良いでしょう(2)。これによって、あとから格納先のストレージが変更になった場合にも、コード全体に影響が及ばなくなります。

もしもセッションストレージを利用するならば、6行目を以下のように差し替えてください。以降のデータの出し入れは、ローカルストレージ/セッションストレージに関わらず、同じ要領で行えます。

  var storage = sessionStorage;

ストレージにデータを保存しているのは、(3)の箇所です。3種類の記法について、それぞれ確認しておきましょう。

表3:ストレージにデータを保存する方法

記法 構文
setItemメソッド storage.setItem(名前, 値)
プロパティ構文 storage.名前 = 値
ハッシュ構文 storage[名前] = 値

いずれの方法を利用しても構いませんが、同じアプリの中では同じ記法で統一するのが可読性という意味で望ましいでしょう。

名前は、原則としてJavaScriptの識別子のルールに沿うようにしてください。setItemメソッド、ハッシュ構文では自由な名前指定が可能ですが、名前によってはプロパティ構文でアクセスできないものが出てしまうためです。

また、ストレージは同じオリジンの中で共有されます。それは、アプリが大規模になれば、それだけ名前重複の危険が増えるということです。それを踏まえて、一般的な変数よりも具体的な名前を付けるよう意識してください。

TIPS 035:ストレージのデータを取得する

ストレージから保存済みのデータを取り出してみましょう。サンプルを実行するにあたっては、あらかじめ前のTIPSのサンプル(set.html)を実行しておいてください。

[リスト02]ストレージからキーlastAccessedのデータを取り出すコード(get.html)

  window.addEventListener('DOMContentLoaded',
    function() {
      // ストレージが利用できるかをチェック
      if (localStorage) {
        // ローカルストレージをセット
        var storage = localStorage;
        // ストレージからキーlastAccessedを取得
        window.alert(storage.getItem('lastAccessed'));
        window.alert(storage.lastAccessed2);
        window.alert(storage['lastAccessed3']);
      }
    }
  );
図1:ストレージに保存されたデータをダイアログに表示

ストレージからデータを取得するにも、設定の場合と同じく3種類の記法を利用できます。

表4:ストレージからデータを取得する方法

記法 構文
getItemメソッド storage.getItem(名前)
プロパティ構文 変数 = storage.名前
ハッシュ構文 変数 = storage[名前]
Think IT会員限定特典
  • ブラウザ標準ストレージWeb Storageを使ったサンプル

著者
山田 祥寛(YAMADA, Yoshihiro)
WINGSプロジェクト

有限会社 WINGSプロジェクトが運営する、テクニカル執筆コミュニティ(代表:山田祥寛)。おもな活動は、Web開発分野の書籍/雑誌/Web記事の執筆。ほかに海外記事の翻訳、講演なども幅広く手がける。2011年3月時点での登録メンバは36名で、現在もプロジェクトメンバーを募集中。

連載記事一覧

Think IT会員サービスのご案内

Think ITでは、より付加価値の高いコンテンツを会員サービスとして提供しています。会員登録を済ませてThink ITのWebサイトにログインすることでさまざまな限定特典を入手できるようになります。

Think IT会員サービスのご案内

関連記事