【51CTO譯文】在《從零開始構建HTML 5頁面》一文中,我們了解到HTML 5的一些新增特性,並透過實例打造了一個完整的HTML 5頁面。但HTML 5標準並不只局限於傳統的標記語言,它還擁有許多令人期待的API接口。借助這些接口,開發者可以創建更為豐富、更引人注目的應用程序。此前我們介紹過支援文件拖放上傳功能的HTML 5 File API,今天,就讓我們一同來認識HTML 5的Web SQL Database API,學習如何運用本地與會話存儲實現簡單的對象持久化。
對HTML 5而言,或許最有用的莫過於它新推出的「Web Storage」(Web存儲)API。若要存儲簡單的鍵值對(比如應用設置)或簡單對象(如應用狀態),本地與會話存儲足以勝任;然而一旦要處理繁瑣的關聯數據,它便有些力不從心了。而這,正是HTML 5「Web SQL Database」API接口的用武之地。
先提醒一聲:本文接下來的內容,需要讀者對JavaScript、面向對象編程(尤其是匿名函數內部的函數)以及SQL都有不錯的理解。
建立連接
要建立一個連接,我們執行以下程式碼:
- db = openDatabase("ToDo", "0.1", "A list of to do items.", 200000);
上述程式碼創建了一個數據庫對象db,名稱為ToDo,版本編號為0.1。db還帶有描述資訊與一個大致的容量值。用戶代理(user agent)可利用這段描述與用戶溝通,說明這個數據庫是用來做什麼的;而程式碼中提供的容量值,則能讓用戶代理為內容預留足夠的存儲空間。必要時,這個容量是可以調整的,因此不必事先假設允許用戶使用多少空間。
要檢測先前建立的連接是否成功,你可以檢查那個數據庫對象是否為null:
- if(!db)
- alert("Failed to connect to database.");
切不可想當然地以為連接已經成功建立,哪怕它過去對某位用戶一直成功。連接失敗的原因有很多:或許用戶代理出於安全考量拒絕了你的訪問,或許設備存儲空間有限。面對活躍且不斷演進的潛在用戶代理,對使用者的機器、軟件及其能力妄加設想,是極不明智的做法。比如說,當使用者使用的是手持設備時,他們可自由支配的數據可能只有寥寥幾兆字節。
執行查詢
要執行一個查詢,你可以使用database.transaction()函數。它接受單一參數,即負責實際執行查詢的那個函數。
該函數(通常是匿名的)具有一個事務類型的參數。
- db.transaction( function(tx) {
這個事務帶有一個名為executeSql的函數,它接受四個參數:表示查詢的字符串、插入到查詢中問號位置的字符串數據(很像Java的預先準備語句)、一個成功時執行的函數,以及一個失敗時執行的函數。
- tx.executeSql("SELECT COUNT(*) FROM ToDo", [], function(result){}, function(tx, error){});
查詢成功時
當查詢成功執行時,應用會跳轉至一個帶有兩個參數的回調:一個是transaction,另一個是它搜集到的results。對於實際上把數據呈現給用戶(例如顯示ToDo列表)而言,這堪稱完美。關於這一點,後面再細說。
查詢失敗時
當查詢未能執行時,便會觸發這個回調。由於你會把transaction對象作為函數的第一個參數傳入,因此即便出錯,你仍可繼續執行查詢。舉例來說,如果查詢是因為缺少表格而無法運行,那麼此刻正是創建表格並重新執行語句的最佳時機。而從函數的第二個參數,你能獲取有關該錯誤的資訊(包括錯誤描述)。
示例
假設我們想用上面的例子,查詢數據庫中的某個表格,若該表格不存在,就順手把它創建出來。
在這個示例中,我們調用帶有一個函數參數的db.transaction()。在該參數內部,我們調用tx.executeSql()。若這一步成功,我們不做任何處理(因此傳入null參數);否則,我們把該事務與執行失敗的函數一併傳入,並再次調用tx.executeSql(),這一次改用創建表格的查詢。
- db.transaction( function(tx) { tx.executeSql("SELECT COUNT(*) FROM ToDo",
[], null, function(tx, error) { tx.executeSql("CREATE TABLE ToDo (id REAL UNIQUE, label TEXT, timestamp REAL)",
[], null, null); } ); } );
這麼多層的內部方法嵌套起來,難免有些繁瑣,所以你或許會想把調用db.transaction()的邏輯抽到外部,封裝成一個函數。比如說,我們可以讓錯誤處理函數自成一個獨立單元,並將其命名為「createToDoTable()」。
插入數據
為讓程式碼更簡潔也更安全,Web SQL Database API允許你向transaction.executeSql()函數傳入字符串數據,用來表示SQL語句中的變量。我們用下面的程式碼來演示:
- db.transaction( function(tx) { tx.executeSql("INSERT INTO ToDo (label, timestamp) values(?, ?)",
[label, new Date().getTime()], null, null); } );
在這個示例中,第一個參數裡的兩個問號,會被後面數組中對應的項所替換:第一個是為該任務設定的標簽(或許是我們先前在程式碼中定義的一個變量),第二個則是函數調用時生成的時間戳。
執行該查詢,其結果類似於下面這句語句:
- INSERT INTO ToDo (label, timestamp) values ("Test", 1265925077487)
處理結果
成功執行的回調會收到一個結果對象,其中包含行集合。每一列代表一條結果,並附帶一組值,對應該特定結果在數據庫每一列中的取值。透過調用result.rows.item(i)可以訪問第i行;若想從某一行中取出某個值,你可以傳入一個數組格式的字符串指針,代表你要查詢的列。例如,想取得標簽(label)列,我們可以調用row['label']。
以下程式碼藉助結果對象,輸出一個查詢的結果:
- db.transaction( function(tx) { tx.executeSql("SELECT * FROM ToDo", [],
- function(tx, result) { for(var i = 0; i < result.rows.length; i++)
- { document.write('<b>' + result.rows.item(i)['label'] + '</b><br />'); } }, null); } );
結論
需要特別注意的是,若非萬不得已,請不要動用Web SQL Database。這倒不是因為它技術上有多麼高深,而是因為它會讓你的程式碼變得相當複雜。在大多數情況下,本地存儲或會話存儲就足以勝任,尤其是當你能保持對象狀態持久化的時候。
正如前面所說,透過這些HTML 5 Web SQL Database API接口,你能實現不少強大的功能。我相信,幾年之後,一定會涌现出一些非常優秀、建立在這些API之上的應用程序。