瀏覽器數(shù)據(jù)庫(kù) IndexedDB 入門(mén)

一、概述

隨著瀏覽器的功能不斷增強(qiáng),越來(lái)越多的網(wǎng)站開(kāi)始考慮,將大量數(shù)據(jù)儲(chǔ)存在客戶(hù)端,這樣可以減少?gòu)姆?wù)器獲取數(shù)據(jù),直接從本地獲取數(shù)據(jù)。
現(xiàn)有的瀏覽器數(shù)據(jù)儲(chǔ)存方案,都不適合儲(chǔ)存大量數(shù)據(jù):Cookie 的大小不超過(guò)4KB,且每次請(qǐng)求都會(huì)發(fā)送回服務(wù)器;LocalStorage2.5MB10MB 之間(各家瀏覽器不同),而且不提供搜索功能,不能建立自定義的索引。所以,需要一種新的解決方案,這就是 IndexedDB 誕生的背景。

通俗地說(shuō),IndexedDB 就是瀏覽器提供的本地?cái)?shù)據(jù)庫(kù),它可以被網(wǎng)頁(yè)腳本創(chuàng)建和操作。IndexedDB 允許儲(chǔ)存大量數(shù)據(jù),提供查找接口,還能建立索引。這些都是 LocalStorage所不具備的。就數(shù)據(jù)庫(kù)類(lèi)型而言,IndexedDB 不屬于關(guān)系型數(shù)據(jù)庫(kù)(不支持 SQL 查詢(xún)語(yǔ)句),更接近NoSQL 數(shù)據(jù)庫(kù)。

IndexedDB具有以下特點(diǎn)。
(1)鍵值對(duì)儲(chǔ)存。 IndexedDB 內(nèi)部采用對(duì)象倉(cāng)庫(kù)(object store)存放數(shù)據(jù)。所有類(lèi)型的數(shù)據(jù)都可以直接存入,包括 JavaScript 對(duì)象。對(duì)象倉(cāng)庫(kù)中,數(shù)據(jù)以"鍵值對(duì)"的形式保存,每一個(gè)數(shù)據(jù)記錄都有對(duì)應(yīng)的主鍵,主鍵是獨(dú)一無(wú)二的,不能有重復(fù),否則會(huì)拋出一個(gè)錯(cuò)誤。

(2)異步IndexedDB操作時(shí)不會(huì)鎖死瀏覽器,用戶(hù)依然可以進(jìn)行其他操作,這與 LocalStorage形成對(duì)比,后者的操作是同步的。異步設(shè)計(jì)是為了防止大量數(shù)據(jù)的讀寫(xiě),拖慢網(wǎng)頁(yè)的表現(xiàn)。

(3)支持事務(wù)。 IndexedDB支持事務(wù)(transaction),這意味著一系列操作步驟之中,只要有一步失敗,整個(gè)事務(wù)就都取消,數(shù)據(jù)庫(kù)回滾到事務(wù)發(fā)生之前的狀態(tài),不存在只改寫(xiě)一部分?jǐn)?shù)據(jù)的情況。

(4)同源限制 IndexedDB受到同源限制,每一個(gè)數(shù)據(jù)庫(kù)對(duì)應(yīng)創(chuàng)建它的域名。網(wǎng)頁(yè)只能訪(fǎng)問(wèn)自身域名下的數(shù)據(jù)庫(kù),而不能訪(fǎng)問(wèn)跨域的數(shù)據(jù)庫(kù)。

(5)儲(chǔ)存空間大 IndexedDB的儲(chǔ)存空間比 LocalStorage大得多,一般來(lái)說(shuō)不少于 250MB,甚至沒(méi)有上限。

(6)支持二進(jìn)制儲(chǔ)存。 IndexedDB不僅可以?xún)?chǔ)存字符串,還可以?xún)?chǔ)存二進(jìn)制數(shù)據(jù)(ArrayBuffer 對(duì)象和 Blob 對(duì)象)。

二、基本概念
IndexedDB是一個(gè)比較復(fù)雜的API,涉及不少概念。它把不同的實(shí)體,抽象成一個(gè)個(gè)對(duì)象接口。學(xué)習(xí)這個(gè) API,就是學(xué)習(xí)它的各種對(duì)象接口。

  • 數(shù)據(jù)庫(kù):IDBDatabase 對(duì)象
  • 對(duì)象倉(cāng)庫(kù):IDBObjectStore 對(duì)象
  • 索引: IDBIndex 對(duì)象
  • 事務(wù): IDBTransaction 對(duì)象
  • 操作請(qǐng)求:IDBRequest 對(duì)象
  • 指針: IDBCursor 對(duì)象
  • 主鍵集合:IDBKeyRange 對(duì)象

下面是一些主要的概念。

(1)數(shù)據(jù)庫(kù)

數(shù)據(jù)庫(kù)是一系列相關(guān)數(shù)據(jù)的容器。每個(gè)域名(嚴(yán)格的說(shuō),是協(xié)議 + 域名 + 端口)都可以新建任意多個(gè)數(shù)據(jù)庫(kù)。

IndexedDB 數(shù)據(jù)庫(kù)有版本的概念。同一個(gè)時(shí)刻,只能有一個(gè)版本的數(shù)據(jù)庫(kù)存在。如果要修改數(shù)據(jù)庫(kù)結(jié)構(gòu)(新增或刪除表、索引或者主鍵),只能通過(guò)升級(jí)數(shù)據(jù)庫(kù)版本完成。

(2)對(duì)象倉(cāng)庫(kù)

每個(gè)數(shù)據(jù)庫(kù)包含若干個(gè)對(duì)象倉(cāng)庫(kù)(object store)。它類(lèi)似于關(guān)系型數(shù)據(jù)庫(kù)的表格。

(3)數(shù)據(jù)記錄

對(duì)象倉(cāng)庫(kù)保存的是數(shù)據(jù)記錄。每條記錄類(lèi)似于關(guān)系型數(shù)據(jù)庫(kù)的行,但是只有主鍵和數(shù)據(jù)體兩部分。主鍵用來(lái)建立默認(rèn)的索引,必須是不同的,否則會(huì)報(bào)錯(cuò)。主鍵可以是數(shù)據(jù)記錄里面的一個(gè)屬性,也可以指定為一個(gè)遞增的整數(shù)編號(hào)。

{ id: 1, text: 'foo' }

上面的對(duì)象中,id屬性可以當(dāng)作主鍵。

數(shù)據(jù)體可以是任意數(shù)據(jù)類(lèi)型,不限于對(duì)象。

(4)索引

為了加速數(shù)據(jù)的檢索,可以在對(duì)象倉(cāng)庫(kù)里面,為不同的屬性建立索引。

(5)事務(wù)

數(shù)據(jù)記錄的讀寫(xiě)和刪改,都要通過(guò)事務(wù)完成。事務(wù)對(duì)象提供error、abortcomplete三個(gè)事件,用來(lái)監(jiān)聽(tīng)操作結(jié)果。
三、操作流程
1.使用 IndexedDB的第一步是打開(kāi)數(shù)據(jù)庫(kù),使用indexedDB.open()方法。

var request = window.indexedDB.open(databaseName, version);

這個(gè)方法接受兩個(gè)參數(shù),第一個(gè)參數(shù)是字符串,表示數(shù)據(jù)庫(kù)的名字。如果指定的數(shù)據(jù)庫(kù)不存在,就會(huì)新建數(shù)據(jù)庫(kù)。第二個(gè)參數(shù)是整數(shù),表示數(shù)據(jù)庫(kù)的版本。如果省略,打開(kāi)已有數(shù)據(jù)庫(kù)時(shí),默認(rèn)為當(dāng)前版本;新建數(shù)據(jù)庫(kù)時(shí),默認(rèn)為1。

indexedDB.open()方法返回一個(gè)IDBRequest對(duì)象。這個(gè)對(duì)象通過(guò)三種事件error、success、upgradeneeded,處理打開(kāi)數(shù)據(jù)庫(kù)的操作結(jié)果。

(1)error 事件

error事件表示打開(kāi)數(shù)據(jù)庫(kù)失敗。

request.onerror = function (event) {
  console.log('數(shù)據(jù)庫(kù)打開(kāi)報(bào)錯(cuò)');
};

(2)success 事件

success事件表示成功打開(kāi)數(shù)據(jù)庫(kù)。


var db;

request.onsuccess = function (event) {
  db = request.result;
  console.log('數(shù)據(jù)庫(kù)打開(kāi)成功');
};

這時(shí),通過(guò)request對(duì)象的result屬性拿到數(shù)據(jù)庫(kù)對(duì)象。

(3)upgradeneeded 事件

如果指定的版本號(hào),大于數(shù)據(jù)庫(kù)的實(shí)際版本號(hào),就會(huì)發(fā)生數(shù)據(jù)庫(kù)升級(jí)事件upgradeneeded。

var db;

request.onupgradeneeded = function (event) {
  db = event.target.result;
}

這時(shí)通過(guò)事件對(duì)象的target.result屬性,拿到數(shù)據(jù)庫(kù)實(shí)例。
2.新建數(shù)據(jù)庫(kù)
新建數(shù)據(jù)庫(kù)與打開(kāi)數(shù)據(jù)庫(kù)是同一個(gè)操作。如果指定的數(shù)據(jù)庫(kù)不存在,就會(huì)新建。不同之處在于,后續(xù)的操作主要在upgradeneeded事件的監(jiān)聽(tīng)函數(shù)里面完成,因?yàn)檫@時(shí)版本從無(wú)到有,所以會(huì)觸發(fā)這個(gè)事件。

通常,新建數(shù)據(jù)庫(kù)以后,第一件事是新建對(duì)象倉(cāng)庫(kù)(即新建表)。

request.onupgradeneeded = function(event) {
  db = event.target.result;
  var objectStore = db.createObjectStore('person', { keyPath: 'id' });
}

上面代碼中,數(shù)據(jù)庫(kù)新建成功以后,新增一張叫做person的表格,主鍵是id。

更好的寫(xiě)法是先判斷一下,這張表格是否存在,如果不存在再新建。

request.onupgradeneeded = function (event) {
  db = event.target.result;
  var objectStore;
  if (!db.objectStoreNames.contains('person')) {
    objectStore = db.createObjectStore('person', { keyPath: 'id' });
  }
}

主鍵(key)是默認(rèn)建立索引的屬性。比如,數(shù)據(jù)記錄是{ id: 1, name: '張三' },那么id屬性可以作為主鍵。主鍵也可以指定為下一層對(duì)象的屬性,比如{ foo: { bar: 'baz' } }foo.bar也可以指定為主鍵。

如果數(shù)據(jù)記錄里面沒(méi)有合適作為主鍵的屬性,那么可以讓IndexedDB 自動(dòng)生成主鍵。

var objectStore = db.createObjectStore(
  'person',
  { autoIncrement: true }
);

上面代碼中,指定主鍵為一個(gè)遞增的整數(shù)。

新建對(duì)象倉(cāng)庫(kù)以后,下一步可以新建索引。

request.onupgradeneeded = function(event) {
  db = event.target.result;
  var objectStore = db.createObjectStore('person', { keyPath: 'id' });
  objectStore.createIndex('name', 'name', { unique: false });
  objectStore.createIndex('email', 'email', { unique: true });
}

上面代碼中,IDBObject.createIndex()的三個(gè)參數(shù)分別為索引名稱(chēng)、索引所在的屬性、配置對(duì)象(說(shuō)明該屬性是否包含重復(fù)的值)。
3.新增數(shù)據(jù)
新增數(shù)據(jù)指的是向?qū)ο髠}(cāng)庫(kù)寫(xiě)入數(shù)據(jù)記錄。這需要通過(guò)事務(wù)完成。

function add() {
  var request = db.transaction(['person'], 'readwrite')
    .objectStore('person')
    .add({ id: 1, name: '張三', age: 24, email: 'zhangsan@example.com' });

  request.onsuccess = function (event) {
    console.log('數(shù)據(jù)寫(xiě)入成功');
  };

  request.onerror = function (event) {
    console.log('數(shù)據(jù)寫(xiě)入失敗');
  }
}

add();

上面代碼中,寫(xiě)入數(shù)據(jù)需要新建一個(gè)事務(wù)。新建時(shí)必須指定表格名稱(chēng)和操作模式("只讀"或"讀寫(xiě)")。新建事務(wù)以后,通過(guò)IDBTransaction.objectStore(name)方法,拿到 IDBObjectStore 對(duì)象,再通過(guò)表格對(duì)象的add()方法,向表格寫(xiě)入一條記錄。

寫(xiě)入操作是一個(gè)異步操作,通過(guò)監(jiān)聽(tīng)連接對(duì)象的success事件和error事件,了解是否寫(xiě)入成功。
4.讀取數(shù)據(jù)
讀取數(shù)據(jù)也是通過(guò)事務(wù)完成。

function read() {
   var transaction = db.transaction(['person']);
   var objectStore = transaction.objectStore('person');
   var request = objectStore.get(1);

   request.onerror = function(event) {
     console.log('事務(wù)失敗');
   };

   request.onsuccess = function( event) {
      if (request.result) {
        console.log('Name: ' + request.result.name);
        console.log('Age: ' + request.result.age);
        console.log('Email: ' + request.result.email);
      } else {
        console.log('未獲得數(shù)據(jù)記錄');
      }
   };
}

read();

上面代碼中,objectStore.get()方法用于讀取數(shù)據(jù),參數(shù)是主鍵的值。
5 遍歷數(shù)據(jù)
遍歷數(shù)據(jù)表格的所有記錄,要使用指針對(duì)象 IDBCursor

function readAll() {
  var objectStore = db.transaction('person').objectStore('person');

   objectStore.openCursor().onsuccess = function (event) {
     var cursor = event.target.result;

     if (cursor) {
       console.log('Id: ' + cursor.key);
       console.log('Name: ' + cursor.value.name);
       console.log('Age: ' + cursor.value.age);
       console.log('Email: ' + cursor.value.email);
       cursor.continue();
    } else {
      console.log('沒(méi)有更多數(shù)據(jù)了!');
    }
  };
}

readAll();

上面代碼中,新建指針對(duì)象的openCursor()方法是一個(gè)異步操作,所以要監(jiān)聽(tīng)success事件。
6 更新數(shù)據(jù)
更新數(shù)據(jù)要使用IDBObject.put()方法。

function update() {
  var request = db.transaction(['person'], 'readwrite')
    .objectStore('person')
    .put({ id: 1, name: '李四', age: 35, email: 'lisi@example.com' });

  request.onsuccess = function (event) {
    console.log('數(shù)據(jù)更新成功');
  };

  request.onerror = function (event) {
    console.log('數(shù)據(jù)更新失敗');
  }
}

update();

上面代碼中,put()方法自動(dòng)更新了主鍵為1的記錄。
7 刪除數(shù)據(jù)
IDBObjectStore.delete()方法用于刪除記錄。

function remove() {
  var request = db.transaction(['person'], 'readwrite')
    .objectStore('person')
    .delete(1);

  request.onsuccess = function (event) {
    console.log('數(shù)據(jù)刪除成功');
  };
}

remove();

8 使用索引
索引的意義在于,可以讓你搜索任意字段,也就是說(shuō)從任意字段拿到數(shù)據(jù)記錄。如果不建立索引,默認(rèn)只能搜索主鍵(即從主鍵取值)。

假定新建表格的時(shí)候,對(duì)name字段建立了索引。

objectStore.createIndex('name', 'name', { unique: false });

現(xiàn)在,就可以從name找到對(duì)應(yīng)的數(shù)據(jù)記錄了。

var transaction = db.transaction(['person'], 'readonly');
var store = transaction.objectStore('person');
var index = store.index('name');
var request = index.get('李四');

request.onsuccess = function (e) {
  var result = e.target.result;
  if (result) {
    // ...
  } else {
    // ...
  }
}
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書(shū)系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容