本系列一路下來都在用最新的 Web 標準技術打造應用程式,而其中最親切的一點是:真正需要動手的東西幾乎只有 HTML、JavaScript 與 CSS 這三樣 Web 開發者的看家本領。剩下最關鍵的裝備,是一個能拿來跑測試的瀏覽器。本文絕大部分程式碼在最新的桌面瀏覽器上都跑得動,遇到有例外的情況我會特別點出來。當然,行動瀏覽器上的實測不能省,理想的作法是備好最新的 iPhone 與 Android SDK;本文的驗證環境是 iPhone SDK 3.1.3 與 Android SDK 2.1。
把資料存在使用者端這件事,Web 開發者已經折騰了很多年,而 HTTP Cookie 長期是那個被硬用的工具。人們把大量資料硬塞進規範只給的 4KB 空間裡,原因其實很單純:互動式應用程式本來就需要落地保存狀態,而把所有狀態都丟回伺服器,往往既沒效率、又不安全,甚至根本不合適。
這幾年下來,替代方案層出不窮。各家瀏覽器端出過自己的私有儲存 API;有人借用 Flash Player 的擴充儲存能力(再透過 JavaScript 包一層);Google 也曾推出 Gears 這類跨瀏覽器外掛,裡頭同樣帶著一套儲存 API。難免的,一堆 JavaScript 函式庫試圖把這些差異抹平——它們對外提供一致的介面,內部再去探測當前環境究竟有哪一種儲存機制可用(可能是某個瀏覽器私有 API,也可能是 Flash 之類的外掛)。
值得慶幸的是,HTML5 規範終於把本機儲存收進標準,而且被瀏覽器迅速且廣泛地實作。這大概是採用速度最快的 HTML5 特性之一:IE、Firefox、Opera、Safari、Chrome 的最新版本全都支援。對行動開發者更關鍵的是,以 WebKit 為核心的 iPhone 與 Android(2.0 以上)瀏覽器同樣支援,Mozilla 的 Fennec 等行動瀏覽器也在列。前提確認完,就來看這套 API 長什麼樣子。
localStorage 的設計非常樸素。依 HTML5 規範,它實作的是 DOM Storage 介面;之所以有兩個名字,是因為規範定義了兩個實作該介面的物件:localStorage 與 sessionStorage。差別在生命週期——sessionStorage 只在單一工作階段內保存資料,一旦沒有任何能存取它的腳本在跑,瀏覽器就可以把資料丟掉;而 localStorage 會跨越多個工作階段存活。兩者的 API 完全一致,所以以下只聚焦 localStorage。
Storage API 本質上就是一個名/值對集合。最常用的兩個方法是 getItem(name) 與 setItem(name, value),行為跟你預期的一模一樣:getItem 回傳名稱對應的值,找不到就回傳 null;setItem 則是新增一組名/值對,或覆寫既有值。要刪除用 removeItem(name),名稱不存在時它什麼也不做,不會丟錯。
如果想遍歷全部資料,規範提供了兩個互補的途徑:length 屬性給出目前存放的項目總數,而 key(index) 則依索引回傳對應的名稱。兩者搭配就能逐一走訪整個儲存空間。
靠這幾個方法能做的事不少,個人化設定、記錄使用者行為都算,對行動 Web 開發者來說這些已經是相當實際的用途。但還有一個更關鍵的場景:快取。有了 localStorage,把伺服器端的資料落地到使用者裝置上做本機快取變得輕而易舉,你不必再為了一次可能很慢的伺服器往返而乾等,同時也大幅降低對伺服器的請求量。接下來就用一個實作把這件事做出來。
範例延續系列第一篇的起點——那時我們用地理定位 API 取得使用者位置,再執行帶地區條件的 Twitter 搜尋。這次先把條件拿掉,做成最單純的 Twitter 搜尋,再回頭替它加上快取,效能提升會非常明顯。
清單 1 是最基礎的版本。
清單 1. 最陽春的 Twitter 搜尋
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width">
<title>Basic Twitter Search</title>
<script type="text/javascript">
function searchTwitter(){
var query = "https://search.twitter.com/search.json?callback=showResults&q=";
query += $("kwBox").value;
var script = document.createElement("script");
script.src = query;
document.getElementsByTagName("head")[0].appendChild(script);
}
// UI 相關程式碼為求簡潔暫省略
function showResults(response){
var tweets = response.results;
tweets.forEach(function(tweet){
tweet.linkUrl = "https://twitter.com/" + tweet.from_user
+ "/status/" + tweet.id;
});
makeResultsTable(tweets);
}
</script>
<!-- CSS 為求簡潔暫省略 -->
</head>
<body>
<div id="main">
<label for="kwBox">Search Twitter:</label>
<input type="text" id="kwBox"/>
<input type="button" value="Go!" onclick="searchTwitter()"/>
</div>
<div id="results">
</div>
</body>
</html>
這裡靠的是 Twitter 搜尋 API 對 JSONP 的支援。使用者按下送出時,程式動態插一個 script 標籤進頁面,並在查詢字串裡指定回呼函式名稱,等於完成了一次跨網域呼叫。回應回來後,名為 showResults 的回呼函式被觸發,我們替每則推文補上可點擊的連結網址,再組成一張簡單的表格呈現。
要加速,思路很直接:把搜尋結果落地保存,並和產生它的關鍵字掛勾,之後同一組關鍵字再送出時就先吃本機資料。
需要改動的只有回呼函式。原本它只負責顯示,現在改成先把資料存起來,再顯示。清單 2 是改寫後的版本。
清單 2. 搜尋並保存
function searchTwitter(){
var keyword = $("kwBox").value;
var query = "https://search.twitter.com/search.json?callback=processResults&q=";
query += keyword;
var script = document.createElement("script");
script.src = query;
document.getElementsByTagName("head")[0].appendChild(script);
}
function processResults(response){
var keyword = $("kwBox").value;
var tweets = response.results;
tweets.forEach(function(tweet){
saveTweet(keyword, tweet);
tweet.linkUrl = "https://twitter.com/" + tweet.from_user
+ "/status/" + tweet.id;
});
makeResultsTable();
addTweetsToResultsTable(tweets);
}
function saveTweet(keyword, tweet){
// 先確認瀏覽器是否真的支援 localStorage
if (!window.localStorage){
return;
}
if (!localStorage.getItem("tweet" + tweet.id)){
localStorage.setItem("tweet" + tweet.id, JSON.stringify(tweet));
}
var index = localStorage.getItem("index::" + keyword);
if (index){
index = JSON.parse(index);
} else {
index = [];
}
if (!index.contains(tweet.id)){
index.push(tweet.id);
localStorage.setItem("index::" + keyword, JSON.stringify(index));
}
}
searchTwitter 的骨架沒變,唯一調整是把回呼函式換成 processResults。之所以要換,是因為現在回應回來時除了顯示,還得順手保存。迴圈裡對每則推文呼叫 saveTweet,並把當初的關鍵字一起傳進去——這個關鍵字是後續把推文歸類、建立索引的依據。
saveTweet 一開場先做能力偵測,確認 window.localStorage 存在。雖然桌面與行動瀏覽器對它的支援已經很普遍,但用新特性時多這道防線永遠值得。不支援就直接 return:什麼都不會被保存,但程式也不會爆掉,應用程式只是少了快取這項加速效果而已。
接著檢查這則推文是否已存在,沒有才用 setItem 落地。然後取出對應關鍵字的索引物件——那其實就是一份與該關鍵字相關的推文 ID 清單。若這個 ID 還不在清單中,就補進去並回寫索引。
這裡有個細節值得留意:存與取都動用了 JSON.stringify 與 JSON.parse。JSON 物件(更精確地說是 window.JSON)同樣是 HTML5 規範的一部分,屬於永遠在场的原生物件;stringify 把任意 JavaScript 物件序列化成字串,parse 則反向還原。之所以非做不可,是因為 localStorage 只收字串。
要注意的是,原生 JSON 物件的普及程度不如 localStorage 本身。撰寫本文時,iPhone 3.1.3 上的 Mobile Safari 就還沒有它,而當時的 Android 瀏覽器已經支援。好在偵測與補救都很簡單:確認它不在,就動態載入一份額外的 JavaScript 檔即可。json.org 上能取得與原生實作等價的 JSON 物件。
想直接看看序列化後的字串長什麼樣,可以用瀏覽器內建的開發者工具檢視該站台寫入的內容。圖 1 就是用 Chrome Developer Tools 觀察到的、已快取在本機的推文。
圖 1. 快取在本機的推文
Chrome 與 Safari 都內建開發者工具,能檢視 localStorage 中的任何內容,並以純文字形式列出鍵/值對,對除錯這類應用程式相當有幫助。
清單 2 已經示範了用 getItem 讀資料。現在把邏輯反過來:使用者送出搜尋時,先查本機快取並立即渲染,再去拜託網路。社群媒體上的推文隨時在長,網路查詢不能省,但你可以只索取「還沒有出現在快取裡」的部分,讓請求本身變得更省。清單 3 是更新後的搜尋程式。
清單 3. 本機優先的搜尋流程
function searchTwitter(){
if ($("resultsTable")){
$("resultsTable").innerHTML = ""; // 清空舊結果
}
makeResultsTable();
var keyword = $("kwBox").value;
var maxId = loadLocal(keyword);
var query = "https://search.twitter.com/search.json?callback=processResults&q=";
query += keyword;
if (maxId){
query += "&since_id=" + maxId;
}
var script = document.createElement("script");
script.src = query;
document.getElementsByTagName("head")[0].appendChild(script);
}
function loadLocal(keyword){
if (!window.localStorage){
return;
}
var index = localStorage.getItem("index::" + keyword);
var tweets = [];
var i = 0;
var tweet = {};
if (index){
index = JSON.parse(index);
for (i=0; i<index.length; i++){
tweet = localStorage.getItem("tweet" + index[i]);
if (tweet){
tweet = JSON.parse(tweet);
tweets.push(tweet);
}
}
}
if (tweets.length < 1){
return 0;
}
tweets.sort(function(a,b){
return a.id > b.id;
});
addTweetsToResultsTable(tweets);
return tweets[0].id;
}
最該注意的是新的 loadLocal:它回傳一個整數,也就是快取中最新那則推文的 ID。searchTwitter 拿到這個 maxId 之後,就把它塞進 since_id 參數,等於告訴 Twitter API「只要比這個 ID 更新的推文」。這一步有機會實質削減回傳量。任何能減少伺服器往返的優化,對行動 Web 應用程式都值得做,因為它直接改善的是慢速網路下的使用者體驗。
仔細看 loadLocal:它沿用清單 2 建立的資料結構,先用 getItem 取出關鍵字對應的索引。取不到索引就代表沒有快取,沒東西可顯示,也無從優化查詢,於上回傳 0 作為訊號。取到索引就拿到 ID 清單,再用 getItem 逐一把每則推文從快取讀回來,排序後交給 addTweetsToResultsTable 呈現,最後回傳最新一則的 ID。
這裡有個設計上的取捨值得說明:本機資料載入後是直接呼叫更新 UI 的函式,等於在「存取資料」與「呈現資料」之間綁上了相依關係,兩邊都穿在同一個 processResults 上。若想要更鬆散的耦合,改用儲存事件會是更好的選擇。
接著把範例再往前推一步:顯示最可能有快取的前 10 個搜尋關鍵字。這大概也就等同於使用者最常查的字詞。清單 4 負責計算並輸出這份排行。
清單 4. 計算前 10 名搜尋
function displayStats(){
if (!window.localStorage){ return; }
var i = 0;
var key = "";
var index = [];
var cachedSearches = [];
for (i=0; i<localStorage.length; i++){
key = localStorage.key(i);
if (key.indexOf("index::") == 0){
index = JSON.parse(localStorage.getItem(key));
cachedSearches.push({keyword: key.slice(7), numResults: index.length});
}
}
cachedSearches.sort(function(a,b){
if (a.numResults == b.numResults){
if (a.keyword.toLowerCase() < b.keyword.toLowerCase()){
return -1;
} else if (a.keyword.toLowerCase() > b.keyword.toLowerCase()){
return 1;
}
return 0;
}
return b.numResults - a.numResults;
}).slice(0,10).forEach(function(search){
var li = document.createElement("li");
var txt = document.createTextNode(search.keyword + " : " + search.numResults);
li.appendChild(txt);
$("stats").appendChild(li);
});
}
這個函式把 localStorage 的 API 用到淋漓盡致:先取得項目總數,再逐一走訪。遇到索引鍵(以 index:: 開頭)就解析它,組出一個同時帶有關鍵字與推文數量的物件,收進 cachedSearches 陣列。接著排序——快取結果最多的排前面,數量相同時再用不分大小寫的字典序決定先後。最後取前 10 名,各自組出 HTML 並掛到一個有序列表上。
讓它在頁面初次載入時就跑一次,如清單 5。
清單 5. 初始化頁面
window.onload = function() {
displayStats();
document.body.setAttribute("onstorage", "handleOnStorage();");
}
第一行在頁面載入時呼叫清單 4 的函式,第二行才是有趣的地方:我們掛上 onstorage 事件處理器。每當 localStorage.setItem 執行完成,這個事件就會觸發,於是前 10 名排行得以自動重算。處理器如清單 6。
清單 6. Storage 事件處理器
function handleOnStorage() {
if (window.event && window.event.key.indexOf("index::") == 0){
$("stats").innerHTML = "";
displayStats();
}
}
onstorage 事件掛在 window 上,並自帶幾個實用屬性:key、oldValue、newValue;除此之外還有 url(觸發變更的頁面網址)與 source(含變更腳本的那個 window)。後兩者在使用者開了多個視窗、分頁,甚至用 iFrame 內嵌時才真正派上用場,而這些情境在行動應用裡並不常見。回到清單 6,你真正需要的就只有 key:用它判斷是不是索引被改動,若是就清空並重畫前 10 名。這個做法的好處是——其他函式完全不需要知道前 10 名列表的存在,因為這段邏輯完全自封閉。
前面提過,DOM Storage 整體而言是 HTML5 裡採用率相當高的一塊,但儲存事件是個例外,至少在桌面端如此。撰寫本文時,支援它的桌面瀏覽器只有 Safari 4+ 與 IE 8+,Firefox、Chrome、Opera 都還沒有。好消息是行動端情況明顯較好:當時的 iPhone 與 Android 瀏覽器都完整支援儲存事件,上面這段程式在它們身上都能正常運作。
對開發者來說,忽然在客戶端握有一大塊儲存空間,是一種相當直接的解放感。資深 Web 開發者尤其有感——很多過去想做卻找不到好方法的資料落地需求,這下終於有了標準答案。而對行動開發者而言更是振奮,因為它真正把「本機快取」這件事變成常態。除了明顯的效能收益之外,本機快取還是推動行動 Web 應用程式另一項關鍵能力——離線——的基礎。那正是系列下一篇要處理的主題。