HTML5 localStorage でブラウザにデータを永続保存！同期・非同期処理を使い分ける

2024-06-19

HTML5 localStorage の同期・非同期処理について

まず、localStorage の基本的な動作を理解しておきましょう。

localStorage にデータを保存する操作は、同期処理として扱われます。
つまり、setItem() メソッドを実行すると、その時点でデータはブラウザのストレージに保存され、すぐに次の処理に移ることができます。

// 同期処理でデータを保存
localStorage.setItem('key', 'value');

// 次の処理にすぐに移る
console.log('Data saved!');

保存完了の確認

しかし、データが確実に保存されたことを確認したい場合は、非同期処理を用いる必要があります。

なぜなら、ブラウザによっては、localStorageへの書き込み処理が完了するまでに時間がかかる場合があるからです。特に、大量のデータを保存する場合や、ブラウザの負荷が高い場合などに顕著です。

非同期処理の実装

非同期処理でlocalStorageの操作を行うには、Promise や callback関数 を使用します。

Promiseの場合

// 非同期処理でデータを保存
localStorage.setItem('key', 'value')
  .then(() => {
    console.log('Data saved!');
  })
  .catch(error => {
    console.error('Error saving data:', error);
  });

callback関数の場合

// 非同期処理でデータを保存
localStorage.setItem('key', 'value', function(error) {
  if (error) {
    console.error('Error saving data:', error);
    return;
  }
  console.log('Data saved!');
});

これらのコードでは、setItem() メソッドが完了した後に、then() メソッドや callback関数内の処理が実行されます。

まとめ

localStorage のデータ保存自体は同期処理で行われますが、保存完了の確認や、保存処理に伴うエラー処理は非同期処理で行うことが重要です。
非同期処理を用いることで、ブラウザの処理状況に関わらず、確実にデータを扱うことができます。

補足

近年では、IndexedDB や Web Storage API などの、より高度な非同期ストレージ技術も登場しています。

用途や目的に応じて、適切なストレージ技術を選択することが重要です。

HTML5 localStorage の同期・非同期処理：サンプルコード

<!DOCTYPE html>
<html>
<head>
  <title>localStorage 同期処理</title>
</head>
<body>
  <button onclick="saveDataSync()">データを同期保存</button>
  <script>
    function saveDataSync() {
      // 同期処理でデータを保存
      localStorage.setItem('key', 'value');

      // 次の処理にすぐに移る
      console.log('Data saved!');
    }
  </script>
</body>
</html>

非同期処理 (Promise)

<!DOCTYPE html>
<html>
<head>
  <title>localStorage 非同期処理 (Promise)</title>
</head>
<body>
  <button onclick="saveDataAsync()">データを非同期保存</button>
  <script>
    function saveDataAsync() {
      // 非同期処理でデータを保存
      localStorage.setItem('key', 'value')
        .then(() => {
          console.log('Data saved!');
        })
        .catch(error => {
          console.error('Error saving data:', error);
        });
    }
  </script>
</body>
</html>

非同期処理 (callback関数)

<!DOCTYPE html>
<html>
<head>
  <title>localStorage 非同期処理 (callback関数)</title>
</head>
<body>
  <button onclick="saveDataAsyncCallback()">データを非同期保存</button>
  <script>
    function saveDataAsyncCallback() {
      // 非同期処理でデータを保存
      localStorage.setItem('key', 'value', function(error) {
        if (error) {
          console.error('Error saving data:', error);
          return;
        }
        console.log('Data saved!');
      });
    }
  </script>
</body>
</html>

説明

上記のサンプルコードでは、それぞれ異なる方法でlocalStorageにデータを保存します。
同期処理 の例では、setItem() メソッドを直接呼び出し、保存完了後にログを出力しています。
非同期処理 (Promise) の例では、then() メソッドを使用して、保存完了後に処理を実行しています。
非同期処理 (callback関数) の例では、setItem() メソッドの第二引数にcallback関数を渡し、保存完了後に処理を実行しています。

これらの例は、localStorage の基本的な操作方法と、同期・非同期処理の概念を理解するのに役立ちます。

より実践的な例については、実際のアプリケーションの要件に合わせてコードを調整する必要があります。

同期処理

前述の通り、localStorage.setItem() メソッドを直接呼び出す方法です。最もシンプルで分かりやすい方法ですが、保存完了の確認やエラー処理が十分に行えないという欠点があります。

Promise オブジェクトを使用して、非同期的にデータを保存する方法です。保存完了後に処理を実行したり、エラー処理を適切に行うことができます。近年では、非同期処理を扱う上で主流な方法となっています。

localStorage.setItem() メソッドの第二引数にcallback関数を渡す方法です。Promiseよりも古い方法ですが、非同期処理の基本的な概念を理解するのに役立ちます。

それぞれの方法の比較

方式	利点	欠点
同期処理	シンプル、分かりやすい	保存完了確認/エラー処理が不十分
非同期処理 (Promise)	保存完了確認/エラー処理が可能、コードが読みやすい	非同期処理の概念理解が必要
非同期処理 (callback関数)	非同期処理の基本を理解しやすい	Promiseよりも冗長な記述になる

上記以外にも、以下のような方法があります。