💽

IndexedDB APIとちょっと仲良くなろう

に公開

🧽 きっかけ

アップロードした画像をサーバーなどを使わずに一時的に保存したく、localStorageについて調べていたがピンとくる解決方法がなかった。

その時に IndexedDB APIを使うと良さそう ということを見つけたのでそのお勉強をしてみた。
localStorageに関する記事は↓
https://zenn.dev/mt5/articles/b83d00d28eef9b

ℹ️ ご案内

以下で書いてます
📣 言語 → TypeScript
🚋 フレームワーク → Nuxt3

🗂️ IndexedDB APIとは

https://developer.mozilla.org/ja/docs/Web/API/IndexedDB_API

上記のドキュメントによると

IndexedDB は、ファイルや blob を含む大量の構造化データをクライアント側で保存するための低レベル API です。

🤨
もうちょっと見てみると

ウェブストレージは比較的少量のデータを保存するのに有用ではありますが、構造化された非常に多くのデータを扱うには不十分です。IndexedDB が解決策を提供します。

sessionStorageとかlocalStorageとかのウェブストレージだと大容量のデータを扱うには大変だからそれを解決してくれるものということ。らしい。

というわけで、今回の需要と合いそうなので試しに使ってみる。

🚿 使い方

【結論】急いでいる人向け

最終的にはこんな感じで書いた。

const dbReq = window.indexedDB.open('DB_HOGE');
dbReq.onupgradeneeded = () => {
  const db = dbReq.result;
  if (!db.objectStoreNames.contains('storeName')) {
    db.createObjectStore('storeName');
  }
};
dbReq.onsuccess = () => {
  console.log('接続は成功している');
  // DB操作ができるオブジェクトを取得
  const db = dbReq.result;

  // storeNameという保管庫に対して読み書き権限を付けた接続を開始 
  const trans = db.transaction('storeName', 'readwrite');
  // storeNameという保管庫を取得
  const store = trans.objectStore('storeName');

  // 今の段階でhogeKeyが存在するか確認
  const value = store.get('hogeKey');

  if (value) {
    // 存在する場合はput
    const putRequest = store.put('hogeValueUpdated', 'hogeKey');
    putRequest.onsuccess = () => {
      console.log('データの更新に成功している');
    };
  } else {
    // 存在しない場合はadd
    const addRequest = store.add('hogeValue', 'hogeKey');
    addRequest.onsuccess = () => {
      console.log('データの追加に成功している');
    };
  };

  // 先ほど追加したhogeKeyの値を表示し、きちんと格納できているか確認
  const getRequest = store.get('hogeKey');
  getRequest.onsuccess = () => {
    console.log('取得したデータ:', getRequest.result);
  };

  // transactionの完了を確認
  trans.oncomplete = () => {
    console.log('トランザクションが完了している');
    db.close();
  };
};

以下に詳細な手順を書いていく。

1. データベース接続

https://developer.mozilla.org/ja/docs/Web/API/IDBFactory/open

DB_HOGE というデータベースに接続しようとした場合は以下のように書く

const dbReq = window.indexedDB.open('DB_HOGE');

dbReqはあくまでも データベースを開くための要求 にすぎないので開いた後の処理は dbReq.onsuccess() で記載する

const dbReq = window.indexedDB.open('DB_HOGE');
dbReq.onsuccess = () => {
  console.log('接続は成功している');
  // DB操作ができるオブジェクトを取得
  const db = dbReq.result;
};

2. トランザクションの開始

https://developer.mozilla.org/ja/docs/Web/API/IDBTransaction

すべてのデータの読み書きはトランザクション内で行われます。

とのことでトランザクションを開始する。

const dbReq = window.indexedDB.open('DB_HOGE');
dbReq.onsuccess = () => {
  console.log('接続は成功している');
  // DB操作ができるオブジェクトを取得
  const db = dbReq.result;

  // storeNameという保管庫に対して読み書き権限を付けた接続を開始 
  const trans = db.transaction('storeName', 'readwrite');
};

でも、上記のように書くとエラーが起こってしまう。

Uncaught NotFoundError: Failed to execute 'transaction' on 'IDBDatabase': One of the specified object stores was not found.

なぜなら storeName という保管庫なるものが存在しないから。

今回初めて DB_HOGE データベースを作成したので設定をしてあげる。

3. オブジェクトストア(保存庫)の設定

https://developer.mozilla.org/ja/docs/Web/API/IDBOpenDBRequest/upgradeneeded_event

dbReq.upgradeneeded() イベントを呼び出してデータを保存する保存庫を作成する。
この保存庫をオブジェクトストアというらしい。

db.objectStoreNames で存在するオブジェクトストア一覧を取得できるので、storeNameが存在しない場合はdb.createObjectStore()で新しいオブジェクトストアを作成する。

dbReq.onupgradeneeded = () => {
  const db = dbReq.result;
  if (!db.objectStoreNames.contains('storeName')) {
    db.createObjectStore('storeName');
  };
};

ちなみに、
upgradeneeded() はデータベースが新規作成されたりバージョンアップされたりした時になんらかの処理を走らせるものになっている。
なので

新しくデータベース作ってみた
↓
transaction()動かないなぁ...
↓
あ、オブジェクトストアの設定忘れてた!

となった場合はデータベースのバージョンアップかデータベースの削除が必要。
保存しているデータが破棄されてもいいなら削除しちゃってもいいかもだが現時点の自分に合わせた方で 🙆

/** バージョンアップの書き方 */ 
const dbReq = window.indexedDB.open('DB_HOGE');
// さっき↑のように定義していた場合は↓のようにバージョン指定してあげる
const dbReq = window.indexedDB.open('DB_HOGE', 2);

/** 削除の書き方 */
window.indexedDB.deleteDatabase('DB_HOGE');

4. というわけで再びトランザクションを開始する

const dbReq = window.indexedDB.open('DB_HOGE');
dbReq.onupgradeneeded = () => {
  const db = dbReq.result;
  if (!db.objectStoreNames.contains('storeName')) {
    db.createObjectStore('storeName');
  };
};
dbReq.onsuccess = () => {
  console.log('接続は成功している');
  // DB操作ができるオブジェクトを取得
  const db = dbReq.result;

  // storeNameという保管庫に対して読み書き権限を付けた接続を開始 
  const trans = db.transaction('storeName', 'readwrite');
  trans.oncomplete = () => {
    console.log('トランザクションが完了している')
  };
};

でコンソールに表示された。

5. ストアへデータを格納する

https://developer.mozilla.org/ja/docs/Web/API/IDBTransaction/objectStore

https://developer.mozilla.org/ja/docs/Web/API/IDBObjectStore/add

https://developer.mozilla.org/ja/docs/Web/API/IDBObjectStore/get

trans.objectStore()、store.add()、store.get() を用いてデータの追加 & 表示を行ってみる

const dbReq = window.indexedDB.open('DB_HOGE');
dbReq.onupgradeneeded = () => {
  const db = dbReq.result;
  if (!db.objectStoreNames.contains('storeName')) {
    db.createObjectStore('storeName');
  }
};
dbReq.onsuccess = () => {
  console.log('接続は成功している');
  // DB操作ができるオブジェクトを取得
  const db = dbReq.result;

  // storeNameという保管庫に対して読み書き権限を付けた接続を開始 
  const trans = db.transaction('storeName', 'readwrite');
  // storeNameという保管庫を取得
  const store = trans.objectStore('storeName');

  // hogeKeyというkeyに対してhogeValueを追加
  const addRequest = store.add('hogeValue', 'hogeKey');
  addRequest.onsuccess = () => {
    console.log('データの追加に成功している');
  };

  // 先ほど追加したhogeKeyの値を表示し、きちんと格納できているか確認
  const getRequest = store.get('hogeKey');
  getRequest.onsuccess = () => {
    console.log('取得したデータ:', getRequest.result);
  };

  // transactionの完了を確認
  trans.oncomplete = () => {
    console.log('トランザクションが完了している');
  };
};

するとこんな感じでコンソールに表示される。

5(補足). もう1回格納しようとすると...

同じコードをもう1回実行し、再度追加しようとするとコンソールが表示されなくなる。

addRequest.onerror = () => {
  console.error(addRequest.error);
};

のようにエラーを表示してみると↓がコンソールに表示される。

すでにkeyが存在している場合はaddが使えないのでput()で更新という形にする。

6. すでに存在する場合はputにする処理を修正

const dbReq = window.indexedDB.open('DB_HOGE');
dbReq.onupgradeneeded = () => {
  const db = dbReq.result;
  if (!db.objectStoreNames.contains('storeName')) {
    db.createObjectStore('storeName');
  }
};
dbReq.onsuccess = () => {
  console.log('接続は成功している');
  // DB操作ができるオブジェクトを取得
  const db = dbReq.result;

  // storeNameという保管庫に対して読み書き権限を付けた接続を開始 
  const trans = db.transaction('storeName', 'readwrite');
  // storeNameという保管庫を取得
  const store = trans.objectStore('storeName');

  // 今の段階でhogeKeyが存在するか確認
  const value = store.get('hogeKey');

  if (value) {
    // 存在する場合はput
    const putRequest = store.put('hogeValueUpdated', 'hogeKey');
    putRequest.onsuccess = () => {
      console.log('データの更新に成功している');
    };
  } else {
    // 存在しない場合はadd
    const addRequest = store.add('hogeValue', 'hogeKey');
    addRequest.onsuccess = () => {
      console.log('データの追加に成功している');
    };
  };

  // 先ほど追加したhogeKeyの値を表示し、きちんと格納できているか確認
  const getRequest = store.get('hogeKey');
  getRequest.onsuccess = () => {
    console.log('取得したデータ:', getRequest.result);
  };

  // transactionの完了を確認
  trans.oncomplete = () => {
    console.log('トランザクションが完了している');
  };
};

コンソールはこのように表示される!いい感じ

7. 最後にデータベースの接続を閉じる

https://developer.mozilla.org/ja/docs/Web/API/IDBDatabase/close
db.close() を用いてデータベースの接続を閉じたら完了

const dbReq = window.indexedDB.open('DB_HOGE');
dbReq.onupgradeneeded = () => {
  const db = dbReq.result;
  if (!db.objectStoreNames.contains('storeName')) {
    db.createObjectStore('storeName');
  }
};
dbReq.onsuccess = () => {
  console.log('接続は成功している');
  // DB操作ができるオブジェクトを取得
  const db = dbReq.result;

  // storeNameという保管庫に対して読み書き権限を付けた接続を開始 
  const trans = db.transaction('storeName', 'readwrite');
  // storeNameという保管庫を取得
  const store = trans.objectStore('storeName');

  // 今の段階でhogeKeyが存在するか確認
  const value = store.get('hogeKey');

  if (value) {
    // 存在する場合はput
    const putRequest = store.put('hogeValueUpdated', 'hogeKey');
    putRequest.onsuccess = () => {
      console.log('データの更新に成功している');
    };
  } else {
    // 存在しない場合はadd
    const addRequest = store.add('hogeValue', 'hogeKey');
    addRequest.onsuccess = () => {
      console.log('データの追加に成功している');
    };
  };

  // 先ほど追加したhogeKeyの値を表示し、きちんと格納できているか確認
  const getRequest = store.get('hogeKey');
  getRequest.onsuccess = () => {
    console.log('取得したデータ:', getRequest.result);
  };

  // transactionの完了を確認
  trans.oncomplete = () => {
    console.log('トランザクションが完了している');
    db.close();
  };
};

📨 まとめ

IndexedDB APIを使ってみた感想としてはデータベースの接続やトランザクションなどを記載するのでlocalStorageやsessionStorageよりとっつきづらい印象があった。
が、調べ始めたら結構スルスル書けたので慣れれば強い味方かも。
localStorageやsessionStorageより大きなデータを格納できるが、容量の計算方法がPCのディスク全体量の60%とのことでPCによって左右されるみたい。
とはいえウェブストレージの10MiBよりは担保されるだろうから大きなデータを扱う時はIndexedDB APIに軍配が上がるだろうなぁ。

Discussion