使用 Indexed Database API 開發的步驟為:
- 建立資料庫
- 建立 object store
- 在 transaction 中處理資料
要開啟 Indexed DB 會使用 window.indexedDB.open("DB", 1),資料庫如果存在就會打開資料庫,如果不存在就會建立新的資料庫,並可以處理 success、error和 upgradeneeded 的事件。
function createDatabase() { var openDb = window.indexedDB.open("DB", 1); openDb.addEventListener('error', errorHandler); openDb.addEventListener('success', function (event) { console.log('success'); db = event.target.result; console.log(db); }) openDb.addEventListener('upgradeneeded', function (event) { console.log('upgradeneeded'); }) }
發生錯誤時我們就直接把錯誤訊息顯示在 console 裡。
function errorHandler(event) { console.log(event.target.error.message) }
其中 upgradeneeded 不是每次都會發生,只有在兩個情況下會觸發,一個是建立資料庫的時候,第二個則是版本改變的時候,版本為 open 事件後面傳入的第二個參數,版號只能是整數而且只能往上增加不能減少。這個事件是我們用來建立 object store 的時候會觸發。
Object Store是在資料庫中,用來存儲資料的地方,每筆資料是用key-value的格式來儲存,會在 upgradeneeded 事件中管理 object store,這裡我們把上面的程式碼改成在建立資料庫的時候同時建立 object store。
function createObjectStore() { var openDb = window.indexedDB.open("DB", 1); openDb.addEventListener('error', errorHandler); openDb.addEventListener('success', function (event) { db = event.target.result; console.log(db); }) //在 upgradeneeded 事件中管理 object store openDb.addEventListener('upgradeneeded', function (event) { db = event.target.result; if (db.objectStoreNames.contains("employees")) { console.log("employees存在") } else { var store = db.createObjectStore("employees", { "keyPath": "employeeId", //主索引鍵 "autoIncrement": true }) store.createIndex("nameIndex", "name", { unique: false }); //要有 index 才能搜尋 store.createIndex("ageIndex", "age", { unique: false }); } }) }
其中 createIndex 不一定要做,但如果想要該欄位可以搜尋的話就必須要做。
如果第一步有建立資料庫,這樣我們這邊就會無法在建立一樣名字的資料庫,所以這邊先寫一段刪除資料庫的程式。
//刪除資料庫 function deleteDatabase() { var delDb = window.indexedDB.deleteDatabase("DB"); delDb.addEventListener('error', errorHandler); delDb.addEventListener('success', function (event) { console.log('資料庫刪除成功!!'); }) }
要觀察資料庫是否建立以及內容,可以從開發者工具找到 IndexedDB 查看內容,這個在不同瀏覽器的位置會不大一樣可以依據瀏覽器尋找。
如果我們要刪除已建立的 object store,要使用 deleteObjectStore,需注意要更動 object store 就必須要變更版號才會觸發 upgradeneeded 進而刪除指定的 object store。
function deleteObjectStore() { var openDb = window.indexedDB.open(“DB”, 2); //需要變更版號才能觸發 upgradeneeded 刪除 object store openDb.addEventListener('error', errorHandler); openDb.addEventListener('success', function (event) { db = event.target.result; console.log(db); }) //要在upgradeneeded事件中管理object store openDb.addEventListener('upgradeneeded', function (event) { db = event.target.result; db.deleteObjectStore("employees") console.log("objectstore刪除成功!!") }) }
接下來我們要將資料新增到 indexed db 裡,因為都需要透過 transaction 來修改資料,所以我們會先像這樣建立一個 transaction 物件,transaction 的模式包含 readonly、readwrite、versionchange,這邊因為我們要新增所以採用 readwrite。
var transaction = db.transaction(["employees"], "readwrite"); var store = trans.objectStore("employees");
接著我們再把資料寫入:
storeAdd=store.add({"name”:”Jason”,”age":30,"email”:”[email protected]"}); storeAdd.addEventListener("success",function(){ console.log(“新增成功!!") }) storeAdd.addEventListener("error",errorHandler);
要更新的話使用 put 並指定要修改的 primary key 就可以修改該筆資料:
store.put({employeeID:2, name: "Tom", email: "[email protected]", "age": 32 });
刪除的話用 delete 指定要刪除的 primary key 就好了。
store.delete(1);
再來讀取 indexed db 裡的資料,首先我們還是要開啟 db,只是這邊就使用 readonly 就好了。
var trans = db.transaction(["employees"], "readonly"); var store = trans.objectStore("employees");
接著透過 openCursor() 取得 IDBCursor 物件
var cursorRequest = store.openCursor();
接著抓取 success 事件將資料讀出來:
cursorRequest.addEventListener("success",function(event){ var result = event.target.result //讀不到資料離開此function if(!result) return console.log(result.value); //讀下一筆資料 result.continue(); })
以上是沒有篩選條件取出所有資料,若要加上篩選條件,則會使用 IDBKeyRange 物件,常用的方法有:
- only("鍵值")
- upperBound("最大值"[,boolean]), lowerBound("最小值"[,boolean]) //後面的 boolean 代表是否包含邊界值
- bound ("最小值", "最大值"[, boolean[, boolean])
舉例來說,這樣就會透過 key path 搜尋資料
var cursorRequest = store.openCursor(IDBKeyRange.only(2));
預設是搜尋 key path 的值,若要切換的話則使用以下方法切換到別的欄位
var nameIdx = store.index("nameIndex"); var cursorRequest = nameIdx.openCursor(IDBKeyRange.only(‘Jason’));
要搜尋特定範圍的範例如下:
var cursorRequest = ageIdx.openCursor(IDBKeyRange.upperBound(30,true))