本篇暫不考慮非同步、多執行緒與 SQL 注入等議題。WebDatabase 規範已宣告不再維護,原因之一是實作幾近同質化(幾乎都選擇了 SQLite)。撇開這些不談,本文聚焦於如何在 HTML5 中實現離線資料的 CRUD(新增、讀取、更新、刪除)基本用法,適合入門參考。
整個流程包括:打開資料庫、建立資料表、新增資料、更新資料、讀取資料與刪除資料。關鍵在於如何取得一個能執行 SQL 語句的上下文——建立資料表、刪除資料表、CRUD 等操作,差別僅在 SQL 語句的寫法。換個角度看,這就像一個「SqlHelper」,我們不妨稱它為 dataBaseOperator。
以下代碼定義了我們的 dataBaseOperator「類」:第 2 行定義打開資料庫連接的方法,第 3 到 5 行為類方法(效果類似 C# 中的靜態方法,可直接以類名呼叫),第 6 到 15 行定義 executeNonQuery 方法,意指查詢資料庫。而 executeReader 與 executeScalar 與 executeNonQuery 高度同質,均可返回記錄集。測試以下代碼時,請務必選擇支援 HTML5 的瀏覽器,例如 Google Chrome。
1 //TODO;SQL注入
2 function dataBaseOperator() {};
3 dataBaseOperator.openDatabase= function () {
4 return window.openDatabase("dataBaseUserStories","1.0","dataBase used for user stories",2 * 1024 * 1024);
5 }
6 dataBaseOperator.executeNonQuery= function (sql, parameters, callback) {
7 var db= this.openDatabase();
8 db.transaction(function (trans) {
9 trans.executeSql(sql, parameters,function (trans, result) {
10 callback(result);
11 },function (trans, error) {
12 throw error.message;
13 });
14 });
15 }
16 dataBaseOperator.executeReader= dataBaseOperator.executeNonQuery;
17 dataBaseOperator.executeScalar= dataBaseOperator.executeNonQuery;
有了這個「SqlHelper」,接著看業務邏輯層(Business Logic Layer)。業務處理類涵蓋建立資料表、刪除資料表、新增記錄、刪除記錄與讀取記錄。這裡沒有寫更新,因為「先刪後增」同樣可行,真要實作也不複雜:
1 function userStoryProvider() {
2 this.createUserStoryTable= function () {
3 dataBaseOperator.executeNonQuery("CREATE TABLE tbUserStories(id integer primary key autoincrement,role,ability,benefit,name,importance,estimate,notes)");
4 };
5 this.dropUserStoryTable= function () {
6 dataBaseOperator.executeNonQuery("DROP TABLE tbUserStories");
7 };
8 this.addUserStory= function (role, ability, benefit, name, importance, estimate, notes) {
9 dataBaseOperator.executeNonQuery("INSERT INTO tbUserStories(role,ability,benefit,name,importance,estimate,notes) SELECT ?,?,?,?,?,?,?",
10 [role, ability, benefit, name, importance, estimate, notes],function (result) {
11 //alert("rowsAffected:" + result.rowsAffected);
12 });
13 };
14 this.removeUserStory= function (id) {
15 dataBaseOperator.executeNonQuery("DELETE FROM tbUserStories WHERE id = ?", [id],function (result) {
16 //alert("rowsAffected:" + result.rowsAffected);
17 });
18 };
19 this.loadUserStories= function (callback) {
20 dataBaseOperator.executeReader("SELECT * FROM tbUserStories", [],function (result) {
21 callback(result);
22 });
23 //result.insertId,result.rowsAffected,result.rows
24 };
25 }
createUserStoryTable、dropUserStoryTable、addUserStory、removeUserStory 這四個方法高度同質,僅 SQL 語句不同。而 loadUserStories 之所以不同,是因為它把 SQLResultSetRowList 返回給呼叫者,這裡仍是簡單的「轉發」。頁面使用時需先建立 provider 實例,再呼叫其實例方法:
var _userStoryProvider= new userStoryProvider();
之後便能呼叫該實例的方法。以下僅舉一例:
function loadUserStory() {
try {
_userStoryProvider.loadUserStories(function (result) {
var _userStories= new Array();
for (var i= 0; i< result.rows.length; i++) {
var o= result.rows.item(i);
var _userStory= new userStory(o.id, o.name, o.role, o.ability, o.benefit, o.importance, o.estimate, o.notes);
_userStories.push(_userStory);
}
//...
}catch (error) {
alert("_userStoryProvider.loadUserStories:" + error);
}
}
取得 _userStories 陣列後,接下來是自動建立 HTML 還是綁定到 EXT,就看你如何發揮想像力了。userStory 是一個自訂的「Model」類:
1 function userStory(id, name, role, ability, benefit, importance, estimate, notes) {
2 this.id= id;
3 this.name= name;
4 this.role= role;
5 this.ability= ability;
6 this.benefit= benefit;
7 this.importance= importance;
8 this.estimate= estimate;
9 this.notes= notes;
10 };
最後貼出完整的應用代碼,由於業務相關部分各家不同,不看也罷:
var _userStoryProvider= new userStoryProvider();
$(document).ready(function () {
loadUserStory();
/* 添加用戶故事 */
$("#btnAdd").click(function () {
var item= { role: $("#role").val(), ability: $("#ability").val(), benefit: $("#benefit").val(), name: $("#Name").val(), importance: $("#Importance").val(), estimate: $("#Estimate").val(), notes: $("#Notes").val() };
try {
_userStoryProvider.addUserStory(item.role, item.ability, item.benefit, item.name, item.importance, item.estimate, item.notes);
loadUserStory();
}catch (error) {
alert("_userStoryProvider.addUserStory:" + error);
}
});
/* 其餘建立/刪除資料表與渲染邏輯略 */
});
最後複習幾個基本功課。首先是 WindowDatabase 介面,注意 openDatabase 方法;接著是 SQLTransaction 介面,重點在 executeSql 方法;然後是 SQLResultSetRowList 與 SQLResultSet 的定義。SQLResultSet 具備 insertId、rowsAffected 與 rows 三個唯讀屬性,而 SQLResultSetRowList 則提供 length 屬性與 item 取值方法。掌握這些介面,你就能在 HTML5 中靈活操作 Web SQL 離線資料庫了。