在談論 HTML5 本地存儲時,我們曾經提到過 Web SQL Database 這項技術其實早已被官方放棄。因此,如今 HTML5 真正可用的本地存儲方案,主要落在兩大陣營:一是 Web Storage(包含 Local Storage 與 Session Storage),二是 IndexedDB。
Web Storage 以簡單的字串鍵值對來保存資料,輕巧又靈活;但一旦面對大量結構化資料,它就顯得力不從心。IndexedDB 正是為了解決這個痛點而生——它是一套能在用戶端保存海量結構化資料,並透過索引進行高效檢索的 API。
IndexedDB 的大部分操作,並不像我們習慣的那種「呼叫方法、直接拿到回傳值」的同步模式,而是採用「請求—響應」的設計。以打開資料庫為例:
var request=window.indexedDB.open('testDB');
這行程式碼並不會直接回傳一個資料庫物件(DB)的參照,你拿到的是一個 IDBOpenDBRequest 物件,而我們真正想要的 DB 物件,其實藏在它的 result 屬性裡。

這次請求的響應結果,就是一個 IDBDatabase 物件,也就是我們平時所說的 IndexedDB 物件。

除了 result 之外,IDBOpenDBRequest 介面還定義了幾個關鍵屬性:
所謂「異步」,指的是這行指令執行完畢後,你並不能立刻透過 request.result 取得 IndexedDB 物件。這點和 AJAX 很類似——語句執行完畢,並不代表物件已經到手,所以我們通常都在它的回呼函式裡處理後續邏輯。
前面已經示範了如何打開一個 IndexedDB 資料庫,只要呼叫 indexedDB.open 方法,就能建立或開啟一個 IndexedDB。來看一段完整的處理流程:
function openDB (name) { var request=window.indexedDB.open(name); request.onerror=function(e){ console.log('OPen Error!'); }; request.onsuccess=function(e){ myDB.db=e.target.result; }; } var myDB={ name:'test', version:1, db:null }; openDB(myDB.name);
程式碼中定義了一個 myDB 物件,並在建立 request 的成功回呼裡,把取得的 DB 物件賦值給 myDB 的 db 屬性,之後便能透過 myDB.db 來操作這個新建的 IndexedDB 了。
我們注意到,除了 onerror 與 onsuccess,IDBOpenDBRequest 還有一個類似回呼的參照——onupgradeneeded。當你請求打開的資料庫版本號,與已存在的資料庫版本號不一致時,它就會被觸發。
indexedDB.open() 方法還有一個可選的第二參數,也就是資料庫版本號。資料庫建立時預設版本號為 1,當我們傳入的版本號與當前版本號不同時,onupgradeneeded 便會啟動。當然,你不能試圖打開比當前版本更低的版本,否則觸發的就是 onerror 了。改寫一下前面的範例:
function openDB (name,version) { var version=version || 1; var request=window.indexedDB.open(name,version); request.onerror=function(e){ console.log(e.currentTarget.error.message); }; request.onsuccess=function(e){ myDB.db=e.target.result; }; request.onupgradeneeded=function(e){ console.log('DB version changed to '+version); }; } var myDB={ name:'test', version:3, db:null }; openDB(myDB.name,myDB.version);
由於先前已經建立過版本 1 的資料庫,當我們以版本 3 打開時,主控台便會輸出:DB version changed to 3。
要關閉資料庫,直接呼叫資料庫物件的 close 方法即可:
function closeDB(db){ db.close(); }
刪除資料庫則使用 indexedDB 物件的 deleteDatabase 方法:
function deleteDB(name){ indexedDB.deleteDatabase(name); }
簡單呼叫如下:
var myDB={ name:'test', version:3, db:null }; openDB(myDB.name,myDB.version); setTimeout(function(){ closeDB(myDB.db); deleteDB(myDB.name); },500);
由於異步 API 的特性,我們無法保證在 closeDB 呼叫前就已經拿到 db 物件(實際上取得 db 物件比執行一行語句慢得多),因此這裡用 setTimeout 稍微延遲了一下。值得一提的是,每個 IndexedDB 實例都有 onclose 回呼參照,可用於資料庫關閉時的處理,有興趣的朋友不妨試試,原理其實很簡單。
有了資料庫,我們自然希望能建立一個「表」來保存資料。但在 IndexedDB 裡並沒有「表」的概念,取而代之的是 objectStore。一個資料庫可以包含多個 objectStore,而 objectStore 是一種靈活的資料結構,能存放多種類型的資料。也就是說,一個 objectStore 相當於一張表,裡面儲存的每一筆資料都與某個鍵相關聯。
我們可以用每筆記錄中指定的某個欄位作為鍵值(keyPath),也可以用自動產生的遞增數字作為鍵值(keyGenerator),當然也可以完全不指定。鍵的類型不同,objectStore 能儲存的資料結構也有差異:
鍵類型/儲存資料:不使用鍵時,可存任意值,但每次新增資料都必須指定鍵參數;使用 keyPath 時,存的是 JavaScript 物件,且物件必須有一個屬性作為鍵值;使用 keyGenerator 時,可存任意值;兩者皆使用時存的是 JavaScript 物件,若物件中含有 keyPath 指定的屬性則不產生新鍵,若沒有則自動產生遞增鍵值並填入 keyPath 指定的屬性。
在對新資料庫做任何操作之前,都必須先開啟一個事務,並在事務中指定它要橫跨哪些 object store。
事務共有三種模式:
var transaction=db.transaction(['students','teacher']); //開啟一個事務,橫跨 students 與 teacher 兩個 object store var objectStore=transaction.objectStore('students'); //取得 students object store
呼叫資料庫實例的 createObjectStore 方法即可建立 object store,這個方法有兩個參數:store 名稱與鍵類型;接著呼叫 store 的 add 方法來新增資料。具備了上述知識,我們就能開始往 object store 裡寫入資料了。
keyPath 方式
由於對新資料的操作都必須在 transaction 中進行,而 transaction 又要求指定 object store,所以我們只能在建立資料庫時就初始化好 object store,以供後續使用——這正是 onupgradeneeded 的重要作用之一。修改一下先前的程式碼:
function openDB (name,version) { var version=version || 1; var request=window.indexedDB.open(name,version); request.onerror=function(e){ console.log(e.currentTarget.error.message); }; request.onsuccess=function(e){ myDB.db=e.target.result; }; request.onupgradeneeded=function(e){ var db=e.target.result; if(!db.objectStoreNames.contains('students')){ db.createObjectStore('students',{keyPath:"id"}); } console.log('DB version changed to '+version); }; }
如此一來,建立資料庫時我們就為它加入了一個名為 students 的 object store。準備一些資料以便新增:
var students=[{ id:1001, name:"Byron", age:24 },{ id:1002, name:"Frank", age:30 },{ id:1003, name:"Aaron", age:26 }];
function addData(db,storeName){ var transaction=db.transaction(storeName,'readwrite'); var store=transaction.objectStore(storeName); for(var i=0;i<students.length;i++){ store.add(students[i]); } } openDB(myDB.name,myDB.version); setTimeout(function(){ addData(myDB.db,'students'); },1000);
這樣我們就在 students 這個 object store 裡加入了三筆記錄,並以 id 作為鍵。打開 Chrome 主控台看看效果:

keyGenerator 方式
function openDB (name,version) { var version=version || 1; var request=window.indexedDB.open(name,version); request.onerror=function(e){ console.log(e.currentTarget.error.message); }; request.onsuccess=function(e){ myDB.db=e.target.result; }; request.onupgradeneeded=function(e){ var db=e.target.result; if(!db.objectStoreNames.contains('students')){ db.createObjectStore('students',{autoIncrement: true}); } console.log('DB version changed to '+version); }; }

至於剩下的兩種鍵設定方式,就留給有興趣的朋友自行摸索了。
可以呼叫 object store 的 get 方法,透過鍵來取得資料,以下以 keyPath 作為鍵為例:
function getDataByKey(db,storeName,value){ var transaction=db.transaction(storeName,'readwrite'); var store=transaction.objectStore(storeName); var request=store.get(value); request.onsuccess=function(e){ var student=e.target.result; console.log(student.name); }; }
可以呼叫 object store 的 put 方法來更新資料,它會自動替換鍵值相同的記錄以達到更新目的;若沒有相同鍵值則視為新增。以下同樣以 keyPath 作為鍵為例:
function updateDataByKey(db,storeName,value){ var transaction=db.transaction(storeName,'readwrite'); var store=transaction.objectStore(storeName); var request=store.get(value); request.onsuccess=function(e){ var student=e.target.result; student.age=35; store.put(student); }; }
呼叫 object store 的 delete 方法,可依鍵值刪除記錄:
function deleteDataByKey(db,storeName,value){ var transaction=db.transaction(storeName,'readwrite'); var store=transaction.objectStore(storeName); store.delete(value); }
呼叫 object store 的 clear 方法則可清空整個 object store:
function clearObjectStore(db,storeName){ var transaction=db.transaction(storeName,'readwrite'); var store=transaction.objectStore(storeName); store.clear(); }
若要刪除整個 object store,可呼叫資料庫實例的 deleteObjectStore 方法,而這就必須在 onupgradeneeded 裡面執行了:
if(db.objectStoreNames.contains('students')){ db.deleteObjectStore('students'); }
以上就是 IndexedDB 的基本用法。或許有不少朋友看過之後會覺得有點雞肋——跟我們自己定義個物件來用似乎沒什麼兩樣,只不過是能把資料存在本地罷了。這是因為我們還沒談到 IndexedDB 之所以冠上「indexed」之名的殺手鐧——索引。它才是讓 IndexedDB 真正大顯身手的核心,下一篇我們就來好好看看這個利器。