Backbone.offline 使用与技术文档

1. 安装指南

在开始使用 Backbone.offline 之前，您需要执行以下步骤：

• 确保您的项目中已经包含了 Backbone.js。
• 将 js/backbone.offline.js 文件添加到您的项目中。

2. 项目使用说明

Backbone.offline 是一个用于将数据存储在 localStorage 中并与服务器同步数据的库。它特别适用于以下场景：

• 让您的应用程序能够与 cache manifest 结合使用，实现离线工作。
• 在每次保存时避免重新引导初始数据。您可以在需要时刷新您的集合，并显著加快加载数据的速度。
• 创建一个独立运行的 HTML5 应用程序，该应用程序定期与服务器同步数据。

要开始使用 Backbone.offline，您需要在初始化时添加以下代码：

@storage = new Offline.Storage('dreams', this)

如果您的项目使用 AMD 风格，您可以使用 backbone-offline-requirejs-template。

现在，您的集合将保存并处理 localStorage 中的数据。第一个参数是存储的名称，第二个参数是集合的链接。此代码不会影响其他集合的行为。如果一个集合没有 @storage 属性，命令将委托给 Backbone.sync。

以下是修改后的集合示例：

class Dreams extends Backbone.Collection
  url: '/api/dreams'

  initialize: ->
      @storage = new Offline.Storage('dreams', this)
  # 其他代码...

为了成功使用 Backbone.offline，您的应用程序应遵循以下三个简单规则：

• 支持 server 的默认 REST API。
• 模型应该具有 updated_at 字段。
• 模型应该具有 id 主键。如果您使用 MongoDB，您应该将响应中的 _id 替换为 id。

3. 项目API使用文档

以下是 Backbone.offline 的一些关键方法和选项：

• Offline.Storage: 用于处理 localStorage 的类，基于 Backbone.localStorage 库。

  @storage = new Offline.Storage('dreams', this, keys: {tag_id: @tags})
  

  可选参数 keys 用于当您的集合与其他集合有关联时。在上面的示例中，本地 tag_id 将在发送数据到服务器时更改为 @tags 中的必要主键。

  选项 autoPush 允许在每次保存时向服务器发送请求，它就像数据缓存一样工作。

  @storage = new Offline.Storage('dreams', this, autoPush: true)
  

• Offline.Sync: 用于同步本地存储与服务器之间的数据。

  默认行为：当集合更改时，通过使用 fetch() 同步数据与服务器。如果您希望更频繁地与服务器同步数据，可以使用实例方法：

  • full()：完全重新加载集合。
  • incremental()：从服务器请求数据并与当前集合合并，然后将更改的数据发送到服务器。
  • pull()：从服务器接收数据并与当前集合合并。
  • push()：将脏数据发送到服务器，并使用原子操作创建、更新、销毁，确保存储数据的可靠性。

  如果您不希望在 fetch 时从服务器请求数据，可以使用 local: true 选项：dreams.fetch({local: true})

  示例：

  dreams = new Dreams() // 初始化集合
  dreams.fetch() // GET /api/dreams
  
  dreams.create(name: 'Visit Iceland') // 在 localStorage 中添加新的梦想
  dream = dreams.at(3)
  dreams.save(name: 'Diving with scuba') // 本地保存
  dreams.storage.sync.push() // POST /api/dreams 和 PUT /api/dreams/:id
  

4. 项目安装方式

Backbone.offline 的安装方式如下：

• 从 GitHub 克隆仓库：git clone [e-mail]:Ask11/backbone.offline.git 并切换到新分支 git checkout -b new-feature。
• 如果尚未安装 Bower，请使用 npm install -g bower 进行安装（您还需要安装 nodejs）。
• 运行 bower install 安装依赖项。
• 运行 cake watch 以自动编译 CoffeeScript 文件。
• 确保规格为绿色 open /spec/spec_runner.html 并开始开发。
• 您可以在 GitHub 上建议功能或报告错误。

以上就是 Backbone.offline 的安装和使用说明，希望对您有所帮助。