闲云博客

关注互联网科技,记录编程点滴

使用HTML5开发离线应用

| 0 comments

HTML5 是目前正在讨论的新一代 HTML 标准,它代表了现在 Web 领域的最新发展方向。在 HTML5 标准中,加入了新的多样的内容描述标签,直接支持表单验证、视频音频标签、网页元素的拖拽、离线存储和工作线程等功能。其中一个新特性就是对离线应用开发的支持。

在开发支持离线的 Web 应用程序时,开发者通常需要使用以下三个方面的功能:

离线资源缓存:需要一种方式来指明应用程序离线工作时所需的资源文件。这样,浏览器才能在在线状态时,把这些文件缓存到本地。此后,当用户离线访问应用程序时,这些资源文件会自动加载,从而让用户正常使用。HTML5 中,通过 cache manifest 文件指明需要缓存的资源,并支持自动和手动两种缓存更新方式。
在线状态检测:开发者需要知道浏览器是否在线,这样才能够针对在线或离线的状态,做出对应的处理。在 HTML5 中,提供了两种检测当前网络是否在线的方式。
本地数据存储:离线时,需要能够把数据存储到本地,以便在线时同步到服务器上。为了满足不同的存储需求,HTML5 提供了 DOM Storage(又叫Web Storage或者本地存储) 和 IndexedDB 两种存储机制。前者提供了易用的 key/value 对存储方式,而后者提供了类似数据库的存储功能而且方便保存和读取JavaScript对象。
 

尽管 HTML5 还处于草稿状态,但是各大主流浏览器都已经实现了其中的很多功能。Chrome、Firefox、Safari 和 Opera 的最新版本都对 HTML5 离线功能提供了完整的支持。IE8 也支持了其中的在线状态检测和 DOM Storage 功能。下面将具体介绍 HTML5 离线功能中的离线资源缓存、在线状态检测、DOM Storage、Web SQL Database 和 IndexedDB,最后通过一个简单的 Web 程序说明使用 HTML5 开发离线应用的方法。

离线资源缓存

为了能够让用户在离线状态下继续访问 Web 应用,开发者需要提供一个 cache manifest 文件。这个文件中列出了所有需要在离线状态下使用的资源,浏览器会把这些资源缓存到本地。本节先通过一个例子展示 cache manifest 文件的用途,然后详细描述其书写方法,最后说明缓存的更新方式。

cache manifest 示例

我们通过 W3C 提供的示例来说明。Clock Web 应用由三个文件“clock.html”、“clock.css”和“clock.js”组成。

清单 1. Clock 应用代码

<!-- clock.html -->
 <!DOCTYPE HTML> 
 <html> 
 <head> 
  <title>Clock</title> 
  <script src="clock.js"></script> 
  <link rel="stylesheet" href="clock.css"> 
 </head> 
 <body> 
  <p>The time is: <output id="clock"></output></p> 
 </body> 
 </html>
/* clock.css */
output { font: 2em sans-serif; }
/* clock.js */
setTimeout(function () { 
   document.getElementById('clock').value = new Date(); 
}, 1000);

当用户在离线状态下访问“clock.html”时,页面将无法展现。为了支持离线访问,开发者必须添加 cache manifest 文件,指明需要缓存的资源。这个例子中的 cache manifest 文件为“clock.manifest”,它声明了 3 个需要缓存的资源文件“clock.html”、“clock.css”和“clock.js”。

清单 2. clock.manifest 代码

CACHE MANIFEST 
clock.html 
clock.css 
clock.js

添加了 cache manifest 文件后,还需要修改“clock.html”,把 <html> 标签的 manifest 属性设置为“clock.manifest”。修改后的“clock.html”代码如下。

清单 3. 设置 manifest 后的 clock.html 代码

<!-- clock.html -->
 <!DOCTYPE HTML> 
 <html manifest="clock.manifest"> 
 <head> 
  <title>Clock</title> 
  <script src="clock.js"></script> 
  <link rel="stylesheet" href="clock.css"> 
 </head> 
 <body> 
  <p>The time is: <output id="clock"></output></p> 
 </body> 
 </html>

 

修改后,当用户在线访问“clock.html”时,浏览器会缓存“clock.html”、“clock.css”和“clock.js”文件;而当用户离线访问时,这个 Web 应用也可以正常使用了。

cache manifest 格式

下面说明书写 cache manifest 文件需要遵循的格式。

首行必须是 CACHE MANIFEST

其后,每一行列出一个需要缓存的资源文件名。

可根据需要列出在线访问的白名单。白名单中的所有资源不会被缓存,在使用时将直接在线访问。声明白名单使用 NETWORK:标识符。

如果在白名单后还要补充需要缓存的资源,可以使用 CACHE:标识符。

如果要声明某 URI 不能访问时的替补 URI,可以使用 FALLBACK:标识符。其后的每一行包含两个 URI,当第一个 URI 不可访问时,浏览器将尝试使用第二个 URI。

注释要另起一行,以 # 号开头。

 

清单 4 的代码中给出了 cache manifest 中各类标识符的使用示例。

清单 4. cache manifest 示例代码

CACHE MANIFEST 
# 上一行是必须书写的。

images/sound-icon.png 
images/background.png 

NETWORK: 
comm.cgi

# 下面是另一些需要缓存的资源,在这个示例中只有一个 css 文件。
CACHE: 
style/default.css

FALLBACK: 
/files/projects /projects

更新缓存

应用程序可以等待浏览器自动更新缓存,也可以使用 Javascript 接口手动触发更新。

自动更新

浏览器除了在第一次访问 Web 应用时缓存资源外,只会在 cache manifest 文件本身发生变化时更新缓存。而 cache manifest 中的资源文件发生变化并不会触发更新。

手动更新

开发者也可以使用 window.applicationCache 的接口更新缓存。方法是检测 window.applicationCache.status 的值,如果是 UPDATEREADY,那么可以调用 window.applicationCache.update() 更新缓存。示范代码如下。

清单 5 手动更新缓存

if (window.applicationCache.status == window.applicationCache.UPDATEREADY){
  window.applicationCache.update(); 
}

在线状态检测

如果 Web 应用程序仅仅是一些静态页面的组合,那么通过 cache manifest 缓存资源文件以后,就可以支持离线访问了。但是随着互联网的发展,特别是 Web2.0 概念流行以来,用户的提交的数据渐渐成为互联网的主流。那么在开发支持离线的 Web 应用时,就不能仅仅满足于静态页面的展现,还必需考虑如何让用户在离线状态下也可以操作数据。离线状态时,把数据存储在本地;在线以后,再把数据同步到服务器上。为了做到这一点,开发者首先必须知道浏览器是否在线。HTML5 提供了两种检测是否在线的方式:navigator.online 和 online/offline 事件。

navigator.onLine

navigator.onLine 属性表示当前是否在线。如果为 true, 表示在线;如果为 false, 表示离线。当网络状态发生变化时,navigator.onLine 的值也随之变化。开发者可以通过读取它的值获取网络状态。

online/offline 事件

当开发离线应用时,通过 navigator.onLine 获取网络状态通常是不够的。开发者还需要在网络状态发生变化时立刻得到通知,因此 HTML5 还提供了 online/offline 事件。当在线 / 离线状态切换时,online/offline 事件将触发在 body 元素上,并且沿着 document.body、document 和 window 的顺序冒泡。因此,开发者可以通过监听它们的 online/offline 事件来获悉网络状态。

本地存储

DOM Storage

在开发支持离线功能的 Web 应用时,开发者需要在本地存储数据。当前浏览器支持的 cookie 虽然也可以用来存储数据,但是 cookie 长度非常小(通常几 k),而且功能有限。因此,HTML5 中新引入了 DOM Storage 机制,用于存储 key/value 对,它的设计目标是提供大规模、安全且易用的存储功能。

它是目前得到支持最广泛的HTML5本地存储规范:IE 8+、FF 3.5+、Safari 4+、Chrome 4+、Opera 10.5+,以及iPhone 2+和Android 2+都已经支持DOM Storage,要判断你的浏览器是否支持DOM Storage,可以使用下面这个函数:

function supports_html5_storage() {  
    try {  
        return 'localStorage' in window && window['localStorage'] !== null;  
    } catch (e) {  
        return false;  
    }  
}

DOM Storage 分类

DOM Storage 分为两类:sessionStorage 和 localStorage。除了以下区别外,这两类存储对象的功能是完全一致的。

sessionStorage 用于存储与当前浏览器窗口关联的数据。窗口关闭后,sessionStorage 中存储的数据将无法使用。
localStorage 用于长期存储数据。窗口关闭后,localStorage 中的数据仍然可以被访问。所有浏览器窗口可以共享 localStorage 的数据。

DOM Storage 接口

每一个 Storage 对象都可以存储一系列 key/value 对,Storage 接口定义为:

interface Storage { 
 readonly attribute unsigned long length; 
 getter DOMString key(in unsigned long index); 
 getter any getItem(in DOMString key); 
 setter creator void setItem(in DOMString key, in any data); 
 deleter void removeItem(in DOMString key); 
 void clear(); 
};

其中最常用的接口是 getItem 和 setItem。getItem 用于获取指定 key 的 value,而 setItem 用于设置指定 key 的 value。

Storage 事件

通过捕获storage事件可以跟踪存储区的改动, 任何时候调用setItem(), removeItem()或者clear()方法时,如果 真的发生了数据改动,都会在window对象上触发storage事件。(只要支持localStorage对象就一定支持 storage事件)

if (window.addEventListener) { 
   window.addEventListener('storage', handle_storage, false); 
} 
else { 
   window.attachEvent('onstorage', handle_storage); 
}

handle_storage()回调函数被调用时,会传入一个StorageEvent对象作为参数,IE下面的事件对象存储在 window.event上:

function handle_storage(e) { 
    if (!e) { e = window.event; } 
}

StorageEvent 对象的属性:

属性 类型 描述
key 字符串 加入,修改或者删除的键名
oldValue 任意 之前的数据(如果是被覆盖的情况)或者null(如果是有新数据项加入的情况)
newValue 任意 新数据或者null(如果是数据项被删除的情况)
url 字符串 调用这个触发数据区变动的函数所在的页面地址

storage 事件是无法撤销存储区的改动的。在handle_storage()回调方法中,没有办法停止正在发生的对存储区 的改动。

DOM Storage 示例

这里给出一个使用了 sessionStorage 的例子,localStorage 的用法与它相同。首先使用 SetItem 添加了一个名为“userName”的项,它的值是“developerworks”。然后,调用 getItem 得到“userName”的值,并且弹出提示框显示它。最后,调用 removeItem 删除“userName”。

清单 6 DOM Storage 示例代码

<!DOCTYPE HTML> 
<html> 
<body> 
<script> 
// 在 sessionStorage 中定义'userName'变量
sessionStorage.setItem('userName', 'developerworks');       
// 访问'userName'变量
alert("Your user is: " + sessionStorage.getItem('userName')); 
// 最后删除'userName'
sessionStorage.removeItem('userName');                       
</script> 
</body> 
</html>

 

Web SQL Database

Web SQL Database是一个已经废弃的规范,但是鉴于很多浏览器都已经实现了Web SQL Database,并且它还具有一些HTML5 Storage所不具有的特性,所以还是值得了解一下的。

它提供了基本的关系数据库功能,支持页面上的复杂的、交互式的数据存储。它既可以用来存储用户产生的数据,也可以作为从服务器获取数据的本地高速缓存。例如可以把电子邮件、日程等数据存储到数据库中。Web SQL Database 支持数据库事务的概念,从而保证了即使多个浏览器窗口操作同一数据,也不会产生冲突。

Web SQL Database 基本用法

创建和打开数据库

使用数据库的第一步是创建并打开数据库,API 是 openDatabase。当数据库已经存在时,openDatabase 仅仅打开数据库;如果这个数据库不存在,那么就创建一个空数据库并且打开它。openDatabase 的定义是:

Database openDatabase(in DOMString name, in DOMString version, 
in DOMString displayName, in unsigned long estimatedSize, 
in optional DatabaseCallback creationCallback);

name:数据库名。

version:数据库版本。

displayName:显示名称。

estimatedSize:数据库预估长度(以字节为单位)。

creationCallback:回调函数。

执行事务处理

在打开数据库以后,就可以使用事务 API transaction。每一个事务作为操作数据库的原子操作,不会被打断,从而避免了数据冲突。transaction 的定义是:

void transaction(in SQLTransactionCallback callback, 
in optional SQLTransactionErrorCallback errorCallback, 
in optional SQLVoidCallback successCallback);

callback:事务回调函数,其中可以执行 SQL 语句。

errorCallback:出错回调函数。

successCallback:执行成功回调函数。

 

执行 SQL 语句

在事务的回调函数 callback 中,可以执行 SQL 语句,API 是 executeSQL。executeSQL 的定义是:

void executeSql(in DOMString sqlStatement, 
in optional ObjectArray arguments, in optional SQLStatementCallback callback, 
in optional SQLStatementErrorCallback errorCallback);

sqlStatement:SQL 语句。

arguments:SQL 语句需要的参数。

callback:回调函数。

errorCallback:出错回调函数。

Web SQL Database 示例

下面通过一个例子说明 Web SQL Database 的基本用法。它首先调用 openDatabase 创建了名为“fooDB”的数据库。然后使用 transaction 执行两条 SQL 语句。第一条 SQL 语句创建了名为“foo”的表,第二条 SQL 语句向表中插入一条记录。

清单 7 Web SQL Database 示例代码

var db = openDatabase('fooDB', '1.0', 'fooDB', 2 * 1024); 
db.transaction(function (tx) { 
 tx.executeSql('CREATE TABLE IF NOT EXISTS foo (id unique, text)');  
 tx.executeSql('INSERT INTO foo (id, text) VALUES (1, "foobar")'); 
});

 

IndexedDB

IndexedDB是在浏览器中保存结构化数据的一种数据库。为了替代目前已经被废弃的Web SQL Database API。

IndexedDB的思想是创建一套API,方便保存和读取JavaScript对象,同时还支持查询及搜索。

IndexedDB是HTML5-WebStorage的重要一环,是一种轻量级NOSQL数据库,W3C为IndexedDB定义了很多接口,其中Database对象被定义为IDBDataBase。而得到IDBDataBase用的是工厂方法,即从IDBFactory中取得。浏览器对象中,实现了IDBFactory的只有indexedDB这个实例。IndexedDB中,几乎所有的操作都是采用了command->request->result的方式。比如查询一条记录,返回一个request,在request的result中得到查询结果。又比如打开数据库,返回一个request,在request的result中得到返回的数据库引用。

IndexedDB的对象名在不同浏览器内核中是不同的。IndexedDB在IE10中叫 msIndexedDB, 在Firefox中叫mozIndexedDB, 在Chrome中叫 webkitIndexedDB。

    var indexedDB = window.indexedDB || window.msIndexedDB || window.mozIndexedDB || webkitIndexedDB;

打开IndexedDB

IndexedDB大的特色是使用对象保存数据,而不是使用表来保存数据。一个 IndexedDB数据库,就是一组位于相同命名空间下的对象的集合。

使用IndexedDB前首先要打开它,即把要打开的数据库名传给indexDB.open()。

  • 如果传入的数据库已经存在,就会发送一个打开它的请求;

  • 如果传入的数据库还不存在,就会发送一个创建并打开它的请求;

  • 总之,调用indexedDB.open()会返回一个IDBRequest对象,在这个对象上可以添加onerror和onsuccess事 件处理程序。

var request, database; 
request = indexedDB.open("admin"); 
request.onerror = function(event) {  
    alert("打开数据库错误:" + event.target.errorcode); 
}; 
request.onsuccess = function(event) {  
    database = event.target.result; 
};

数据库版本号

默认情况下,IndexedDB数据库是没有版本号的。好一开始就调用setVersion()方法为数据库指定一个版本号 (传入一个表示版本号的字符串)。

if (database.version != "1.0") {
  request = database.setVersion("1.0");
  request.onerror = function(event) {
    alert("设置版本号时发生错误:" + event.target.errorCode);
  };
  request.onsuccess = function() {
    alert("数据库初始化完成,数据库名:" + database.name + ", 版本:" + database.version);
  };
 } else {
  alert("数据库已经初始化过了。数据库名称:" + database.name + ",版本号:" + database.version);
 }

初始化object store

建立完数据库连接以后,就要创建对象存储空间(object store)。

假设我们要保存用户记录,user对象格式可能类似于:

var user = {
  username: "007",
  firstName: "James",
  lastName: "Bond",
  password: "foo"
 };

创建对象存储空间时,必须指定一个全局唯一键(主键),这里我们可以用”username”。下面是为了保存用户记录而 创建对象存储空间的示例:

var store = database.createObjectStore("users", {keyPath: "username"});

keyPath属性,就是空间中要保存的对象的一个属性,这个属性将作为存储空间的主键来使用。

添加数据

获得了object store的引用之后,就可以使用add()或put()方法向其中添加数据。这两个方法都接收一个参数,即要保存的对象,然后这个对象就会被保存到存储空间中。

这两个方法的区别在于,如果空间中已经包含了键值相同的对象:add()会返回错误,而put()则会重写原有对象。

比如,我们可以用下面的方法来初始化对象存储空间,把返回的请求对象保存在一个变量中,然后再指定onerror或onsuccess事件处理程序,来验证请求是否成功完成:

var request, requests[];
for (var index = 0; index < users.length; index++) {  
  request = store.add(users[index]);
  request.onerror = function() {  // 错误处理
  };
  request.onsuccess = function() {  // 成功
  };
  requests.push(request);
}

使用事务

在数据库对象上调用transaction()方法就可以创建事务。任何时候,想要读取或修改数据,都要通过事务来组织所有的操作。

在IndexedDB中,事务会自动提交或回滚。所以无需手动commit或者rollback。

事务分为三种

IDBTransaction.READ_ONLY 只读

IDBTransaction.READ_WRITE 可读可写

IDBTransaction.VERSION_CHANGE 版本升级

我们用的最多的是前两种。如果不设置事务级别,则默认为READ_ONLY。

 

下面的代码保证只加载users存储空间中的数据,以便通过事务进行访问:

    var transaction = db.transaction("users");

如果要访问多个对象存储空间,可以传入字符串数组:

    var transaction = db.transaction(["users", "anotherStore"]);

上面的两个事务都是以只读的方式访问数据。要修改访问方式,必须在创建事务时传入第二个参数。

E10+和Firefox4+实现的叫做IDBTransaction, 但在Chrome中则叫webkitIDBTransaction, 所以使用下面的代码可以统一接口:

var IDBTransaction = window.IDBTransaction || window.webkitIDBTransaction;

有了这行代码就可以比较方便地为transaction()指定第二个参数:

var transaction = db.transaction("users", IDBTransaction.READ_WRITE);

事务本身也有事件处理程序:onerror和oncomplete。这两个事件可以提供事务级的状态信息。

transaction.onerror = function(event) {
  // 整个事务都被取消了
};
transaction.oncomplete = fucntion(event) {
  // 事务成功完成
};

访问存储空间

拿到事务以后,使用objectStore()方法并传入存储空间的名称,就可以访问特定的存储空间。然后就可以:

  • 使用add()和put()方法添加数据;

  • 使用get()可以取得值;

  • 使用delete()可以删除对象;

  • 使用clear()可以删除所有对象;

get()和delete()方法都接收一个对象键作为参数。所有的这5个方法都会返回一个新的请求对象。例如:

var request = db.transaction("users").objectStore("users").get("007");
request.onerror = function(event) {
  alert("获取对象失败!");
};
request.onsuccess = function(event) {
  var result = event.target.result;
  alert(result.firestName);
};

使用游标查询

使用事务可以直接通过已知的键来检索单个对象,在需要检索多个对象的情况下,需要在事务内部创建游标。

游标就是指向结果集的一个指针,游标指针首先会指向结果集中的第一项,在接到查找下一项的指令时,才会指向下一项。

在对象存储空间上调用openCursor()方法可以创建游标。openCursor()方法返回的也是一个请求对象,也需要为该对象指定onsuccess和onerror事件处理函数。

var store = db.transaction("users").objectStore("users"),
    request = store.openCursor();

request.onsuccess = function(event) {
  // 处理成功
};
request.onerror = function(event) {
  // 处理失败
};

在onsuccess事件处理程序执行时,可以通过event.target.result取得存储空间中的下一个对象。在结果集中有下一项时,result是一个IDBCursor的实例;如果没有下一项,result为null。

IDBCursor实例具有以下几个属性:

  • key: 对象的键;

  • value:实际的对象;

  • direction:数值,表示游标走动的方向。

    • 默认是IDBCursor.NEXT(0), 表示下一项。

    • IDBCursor.NEXT_TO_DUPLICATE(1), 表示下一个不重复的项;

    • IDBCursor.PREV(2)表示前一项;

    • IDBCursor.PREV_NO_DUPLICATE表示前一个不重复的项。

  • primaryKey:游标使用的键,有可能是对象键,也有可能是索引键。

要检索某一个结果信息,可以像下面这样:

request.onsuccess = function(event) {
  var cursor = event.target.result;
  if (cursor) {
    console.log("Key: " + cursor.key + ", Value: " + JSON.stringify(cursor.value));
  }
};

因为result.value是一个对象,所以显示前要先转成JSON字符串。

使用游标更新记录

调用update()方法可以使用指定的对象更新当前游标的value:

request.onsuccess = function(event) {
  var cursor = event.target.result, value, updateRequest;
  if (cursor) {
    if (cursor.key == "foo") {
      value = cursor.value;  // 取得当前值
      value.password = "magic";  // 更新密码

      updateRequest = cursor.udpate(value); // 请求保存更新
      updateRequest.onsuccess = function() {
        // 处理成功
      };
      updateRequest.onerror = function() {
        // 处理失败
      };
    }
  }
};

使用游标删除记录

调用delete()方法可以删除相应的记录:

request.onsuccess = function(event) {
  var cursor = event.target.result, value, deleteRequest;
  if (cursor) {  // 检查一下
    if (cursor.key == "foo") {
      deleteRequest = cursor.delete(); // 请求删除当前项
      deleteRequest.onsuccess = function() {
        // 处理成功
      };
      deleteRequest.onerror = function() {
        // 处理失败
      };
    }
  }
};

注意:如果当前的事务没有修改对象存储空间的权限,update()和delete()会抛出错误。

移动游标

默认情况下每个游标只发起一次请求;要想发起另一次请求,必须调用下面的一个方法:

  • continue(key): 移动到结果集的下一项。参数key是可选的,不指定这个参数,游标移动到下一项;指定这个参数的话,游标会移动到指定键的位置。
  • advance(count): 向前移动count指定的项数。

下面的例子遍历了对象存储空间中的所有项:

request.onsuccess = function(event) {
  var cursor = event.target.result;
  if (cursor) {  // 检查一下
    console.log("key: " + cursor.key + ", Value: " + JSON.stringify(cursor.value));
    cursor.continue();  // 移动到下一项
  } else {
    console.log("Done!");
  }
};

调用continue()会触发另一次请求,进而再次调用onsuccess处理程序。如果没有更多项可以遍历时,event.target.result的值为null。

键范围

通过游标查找数据的方式比较有限,键范围(key range)为使用游标增添了一些灵活性。

键范围由IDBKeyRange的实例表示。

 
支持标准IDBKeyRange的浏览器有IE10+和Firefox4+, Chrome中的名字叫webkitIDBKeyRange。

考虑到不同浏览器中的差异,也是要声明一个本地的类型:

var IDBKeyRange = window.IDBKeyRange || window.webkitIDBKeyRange;

第一种键范围方式是使用only()方法,传入想要取得对象的键:

var onlyRange = IDBKeyRange.only("007");

这个范围保证只取得键值为”007″的对象。使用这个范围创建的游标和直接访问存储空间并调用get(“007”)差不多。

 

第二种定义键范围的方法是指定结果集的下界lowerBound()方法。下界表示游标开始的位置。

 

下面代码的键范围可以保证游标从键为”007″的对象开始,然后继续前移,直到最后一个对象:

// 从键为“007”的对象开始,然后可以移动到最后
var lowerRange = IDBKeyRange.lowerBound("007");

如果想要忽略键为”007″的对象本身,从它的下一个对象开始,可以传入第二个参数true:

// 从键为“007”的下一个对象开始,然后可以移动到最后      
var lowerRange = IDBKeyRange.lowerBound("007", true);

第三种定义键范围的方法是指定结果集的上界upperBound()方法,也就是指定游标不能超过哪个键。

// 从头开始,到取得键为"ace"的对象为止      
var upperRange = IDBKeyRange.upperBound("ace");

如果不想包含键为指定值的对象,同样传入第二个参数true:

// 从头开始,到取得键为"ace"的上一个对象为止      
var upperRange = IDBKeyRange.upperBound("ace", true);

使用bound()方法可以同时指定上下界。

这个方法可以接收四个参数:表示下界的键,表示上界的键,可选的表示是否跳过下界的布尔值和可选的表示是否跳过上界的布尔值。

var upperRange = IDBKeyRange.bound("007", "ace");
var upperRange = IDBKeyRange.bound("007", "ace", true);
var upperRange = IDBKeyRange.bound("007", "ace", true, true);
var upperRange = IDBKeyRange.bound("007", "ace", false, true);

使用KeyRange的openCursor()方法

定义好了key range之后,就可以把它传给openCursor()方法,就能得到一个符合相应约束条件的游标。

var store = db.transaction("users").objectStore("users"),
  range = IDBKeyRange.bound("007", "ace"),
  request = store.openCursor(range);

request.onsuccess = function(event) {
  var cursor = event.target.result;
  if (cursor) {
    console.log("Key: " + cursor.key + ", Value: " + JSON.stringify(cursor.value));
    cursor.continue(); // 移动到下一项
  } else {
    console.log("Done!");
  }
};

设定游标方向

openCursor()可以接收两个参数,一个是刚才的IDBKeyRange实例,第二个是表示方向的数值常量,也就是前面讲到的IDBCursor中的常量,有4种:

IDBCursor.NEXT 顺序循环
IDBCursor.NEXT_NO_DUPLICATE 顺序循环不重复
IDBCursor.PREV 倒序循环
IDBCursor.PREV_NO_DUPLICATE 倒序循环不重复

正常情况下,游标都是从存储空间的第一项开始,调用continue()或advance()前进到最后一项。游标的默认方向值是IDBCursor.NEXT。

也可以创建一个游标,从最后一个对象开始,逐个迭代,直到第一个对象:

var store = db.transaction("users").objectStore("users"),
  request = store.openCursor(null, IDBCursor.PREV);

离线应用示例

最后,通过一个例子来说明使用 HTML5 开发离线应用的基本方法。这个例子会用到前面提到的离线资源缓存、在线状态检测和 DOM Storage 等功能。假设我们开发一个便签管理的 Web 应用程序,用户可以在其中添加和删除便签。它支持离线功能,允许用户在离线状态下添加、删除便签,并且当在线以后能够同步到服务器上。

应用程序页面

这个程序的界面很简单,如图 1 所示。用户点击“New Note”按钮可以在弹出框中创建新的便签,双击某便签就表示删除它。

图 1. 应用程序页面

这个页面的源文件是 index.html,它的代码如清单 8 所示。

清单 8 页面 HTML 代码

<html manifest="notes.manifest"> 
<head> 
<script type="text/javascript" src="server.js"></script> 
<script type="text/javascript" src="data.js"></script> 
<script type="text/javascript" src="UI.js"></script> 
<title>Note List</title> 
</head> 

<body onload = "SyncWithServer()"> 
<input type="button" value="New Note" onclick="newNote()"> 
<ul id="list"></ul> 
</body> 
</html>

在 body 中声明了一个按钮和一个无序列表。当按下“New Note”按钮时,newNote 函数将被调用,它用来添加一条新的便签。而无序列表初始为空,它是用来显示便签的列表。

 
cache manifest 文件

定义 cache manifest 文件,声明需要缓存的资源。在这个例子中,需要缓存“index.html”、“server.js”、“data.js”和“UI.js”等 4 个文件。除了前面列出的“index.html”外,“server.js”、“data.js”和“UI.js”分别包含服务器相关、数据存储和用户界面代码。cache manifest 文件定义如下。

清单 9 cache manifest 文件

CACHE MANIFEST 
index.html 
server.js 
data.js 
UI.js

 
用户界面代码

用户界面代码定义在 UI.js 中。

清单 10 用户界面代码 UI.js

function newNote() 
{ 
   var title = window.prompt("New Note:"); 
   if (title) 
   { 
       add(title); 
   } 
} 

function add(title) 
{ 
   // 在界面中添加
   addUIItem(title); 
   // 在数据中添加
   addDataItem(title); 
} 

function remove(title) 
{ 
   // 从界面中删除
   removeUIItem(title); 
   // 从数据中删除
   removeDataItem(title); 
} 

function addUIItem(title) 
{ 
   var item = document.createElement("li"); 
   item.setAttribute("ondblclick", "remove('"+title+"')"); 
   item.innerHTML=title; 

   var list = document.getElementById("list"); 
   list.appendChild(item);    
}  

function removeUIItem(title) 
{ 
   var list = document.getElementById("list"); 
   for (var i = 0; i < list.children.length; i++) { 
       if(list.children[i].innerHTML == title) 
       { 
           list.removeChild(list.children[i]); 
       } 
   } 
}

UI.js 中的代码包含添加便签和删除便签的界面操作。

添加便签

用户点击“New Note”按钮,newNote 函数被调用。

newNote 函数会弹出对话框,用户输入新便签内容。newNote 调用 add 函数。

add 函数分别调用 addUIItem 和 addDataItem 添加页面元素和数据。addDataItem 代码将在后面列出。

addUIItem 函数在页面列表中添加一项。并指明 ondblclick 事件的处理函数是 remove,使得双击操作可以删除便签。

删除便签

用户双击某便签时,调用 remove 函数。

remove 函数分别调用 removeUIItem 和 removeDataItem 删除页面元素和数据。removeDataItem 将在后面列出。

removeUIItem 函数删除页面列表中的相应项。

 

数据存储代码

数据存储代码定义在 data.js 中。

清单 11 数据存储代码 data.js

var storage = window['localStorage']; 

 function addDataItem(title) 
 { 
    if (navigator.onLine) // 在线状态
    { 
        addServerItem(title); 
    } 
    else // 离线状态
    { 
        var str = storage.getItem("toAdd"); 
        if(str == null) 
        { 
            str = title; 
        } 
        else
        { 
            str = str + "," + title; 
        } 
        storage.setItem("toAdd", str); 
    } 
 } 

 function removeDataItem(title) 
 { 
    if (navigator.onLine) // 在线状态
    { 
        removeServerItem(title); 
    } 
    else // 离线状态
    { 
        var str = storage.getItem("toRemove"); 
        if(str == null) 
        { 
            str = title; 
        } 
        else
        { 
            str = str + "," + title; 
        } 
        storage.setItem("toRemove", str); 
    } 
 } 

 function SyncWithServer() 
 { 
    // 如果当前是离线状态,不需要做任何处理
    if (navigator.onLine == false)return; 

    var i = 0; 
    // 和服务器同步添加操作
    var str = storage.getItem("toAdd"); 
    if(str != null) 
    { 
        var addItems = str.split(","); 
        for(i = 0; i<addItems.length; i++) 
        { 
            addDataItem(addItems[i]); 
        } 
        storage.removeItem("toAdd"); 
    } 

    // 和服务器同步删除操作
    str = storage.getItem("toRemove"); 
    if(str != null) 
    { 
        var removeItems = str.split(","); 
        for(i = 0; i<removeItems.length; i++) 
        { 
            removeDataItem(removeItems[i]); 
        } 
        storage.removeItem("toRemove"); 
    } 

    // 删除界面中的所有便签   
    var list = document.getElementById("list"); 
    while(list.lastChild != list.firstElementChild) 
        list.removeChild(list.lastChild); 
    if(list.firstElementChild) 
        list.removeChild(list.firstElementChild);        

    // 从服务器获取全部便签,并显示在界面中
    var allItems = getServerItems(); 
    if(allItems != "") 
    { 
        var items = allItems.split(","); 
        for(i = 0; i<items.length; i++) 
        { 
            addUIItem(items[i]); 
        } 
    } 
 }

window.addEventListener("online", SyncWithServer,false);

data.js 中的代码包含添加便签、删除便签和与服务器同步等数据操作。其中用到了 navigator.onLine 属性、online 事件、DOM Storage 等 HTML5 新功能。

添加便签:addDataItem

通过 navigator.onLine 判断是否在线。

如果在线,那么调用 addServerItem 直接把数据存储到服务器上。addServerItem 将在后面列出。

如果离线,那么把数据添加到 localStorage 的“toAdd”项中。

 

删除便签:removeDataItem

通过 navigator.onLine 判断是否在线。

如果在线,那么调用 removeServerItem 直接在服务器上删除数据。removeServerItem 将在后面列出。

如果离线,那么把数据添加到 localStorage 的“toRemove”项中。

 

数据同步:SyncWithServer

在 data.js 的最后一行,注册了 window 的 online 事件处理函数 SyncWithServer。当 online 事件发生时,SyncWithServer 将被调用。其功能如下。

如果 navigator.onLine 表示当前离线,则不做任何操作。

把 localStorage 中“toAdd”项的所有数据添加到服务器上,并删除“toAdd”项。

把 localStorage 中“toRemove”项的所有数据从服务器中删除,并删除“toRemove”项。

 

删除当前页面列表中的所有便签。

调用 getServerItems 从服务器获取所有便签,并添加在页面列表中。getServerItems 将在后面列出。
 
服务器相关代码

服务器相关代码定义在 server.js 中。

清单 12 服务器相关代码 server.js

function addServerItem(title) 
{ 
   // 在服务器中添加一项
} 

function removeServerItem(title) 
{ 
   // 在服务器中删除一项
} 

function getServerItems() 
{ 
   // 返回服务器中存储的便签列表
}

由于这部分代码与服务器有关,这里只说明各个函数的功能,具体实现可以根据不同服务器编写代码。

在服务器中添加一项:addServerItem

在服务器中删除一项:removeServerItem

返回服务器中存储的便签列表:getServerItems

 

原创文章,转载请注明: 转载自闲云博客

本文链接地址: 使用HTML5开发离线应用

Author: Jian Yun

Hi,我是闲云,感谢您阅读我的博客。我是一个微软ASP.NET方面的开发者,写写博客分享下互联网科技方面感兴趣的事和记录自己程序开发中的点点滴滴。 ------“立志难也,不在胜人,在自胜”

发表评论

Required fields are marked *.