backbone简介_动力节点Java学院整理

简介

web 应用程序越来越关注于前端，使用客户端脚本与 ajax 进行交互。由于 javascript 应用程序越来越复杂，如果没有合适的工具和模式，那么 javascript 代码的高效编写、非重复性和可维护性方面会面临挑战。模型-视图-控制器 (mvc) 是一个常见模式，可用于服务器端开发以生成有组织以及易维护的代码。mvc 支持将数据（比如通常用于 ajax 交互的 javascript object notation (json) 对象）从表示层或从页面的文档对象模型 (document object model, dom) 中分离出来，也可适用于客户端开发。

backbone（也称为 backbone.js）是由 jeremy ashkenas 创建的一个轻量级库，可用于创建 mvc 类应用程序。backbone：

1. 强制依赖于 underscore.js，underscore.js 是一个实用型库
2. 非强制依赖于 jquery/zepto
3. 根据模型的变更自动更新应用程序的 html，有助于代码维护
4. 促进客户端模板使用，避免了在 javascript 中嵌入 html 代码

模型、视图、集合和路由器是 backbone 框架中的主要组件。在 backbone 中，模型会存储通过 restful json 接口从服务器检索到的数据。模型与视图密切关联，负责为特定 ui 组件渲染 html 并处理元素上触发的事件，这也是视图本身的一部分。

spi 应用程序：backbone.router 和 backbone.history

含有大量 ajax 交互的应用程序越来越像那些无页面刷新的应用程序。这些应用程序常常试图限制与单个页面的交互。该 spi 方法提高了效率和速度，并使整个应用程序变得更灵敏。状态概念代替了页面概念。散列 (hash) 片段被用于识别一个特定状态。散列片段 是 url 中散列标签 (#) 后的那部分，是该类应用程序的关键元素。清单 1 显示了一个 spi 应用程序使用两个不同的散列片段产生的两个不同状态。

清单 1. spi 或 ajax 应用程序中的两个不同状态

http://www.example.com/#/state1

http://www.example.com/#/state2

backbone 提供一个称为路由器（版本 0.5 前称之为控制器）的组件来路由客户端状态。路由器可以扩展 backbone.router 函数，且包含一个散列映射（routes 属性）将状态与活动关联起来。当应用程序达到相关状态时，会触发一个特定活动。清单2 展示了一个 backbone 路由器示例。

清单 2. backbone.router 示例：routers.js

app.routers.main = backbone.router.extend({
  
  // hash maps for routes
  routes : {
   "" : "index",
   "/teams" : "getteams",
   "/teams/:country" : "getteamscountry",
   "/teams/:country/:name : "getteam"
   "*error" : "fourofour"
  },
  
  index: function(){
    // homepage 
  },
  
  getteams: function() {
    // list all teams 
  },
  getteamscountry: function(country) {
    // get list of teams for specific country
  },
  getteam: function(country, name) {
    // get the teams for a specific country and with a specific name
  }, 
  fourofour: function(error) {
    // 404 page
  }
});

创建的每个状态可以为书签。当 url 碰到类似下面情况时，会调用这 5 个活动（index、getteams、getteamscountry、getteamcountry 和 fourofour）。

1. http://www.example.com 触发 index()
2. http://www.example.com/#/teams 触发 getteams()
3. http://www.example.com/#/teams/country1 触发 getteamscountry() 传递 country1 作为参数
4. http://www.example.com/#/teams/country1/team1 触发 getteamcountry() 传递 country1 和 team1 作为参数
5. http://www.example.com/#/something 触发 fourofour() 以作 * （星号）使用。

要启动 backbone，先实例化页面加载的路由器，并通过指令 backbone.history.start() 方法监视散列片段中的任何变更，如 清单 3 所示。

清单 3. 应用程序实例化（使用 jquery）

$(function(){
  var router = new app.routers.main();
  backbone.history.start({pushstate : true});
})

当实例化路由器时，会生成 backbone.history 对象；它将自动引用 backbone.history 函数。backbone.history 负责匹配路由和router 对象中定义的活动。start() 方法触发后，将创建 backbone.history 的 fragment 属性。它包含散列片段的值。该序列在根据状态次序管理浏览器历史方面十分有用。用户如果想要返回前一状态，单击浏览器的返回按钮。

在 清单 3 的示例中，通过一个启用 html5 特性 pushstate 的配置调用 start() 方法。对于那些支持 pushstate 的浏览器，backbone 将监视 popstate 事件以触发一个新状态。如果浏览器不能支持 html5 特性，那么 onhashchange 活动会被监视。如果浏览器不支持该事件，轮询技术将监视 url 散列片段的任何更改。

模型和集合

模型和集合是 backbone.js 的重要组件，模型将数据（通常是来自服务器的数据）存储在键值对中。要创建一个模型，需要扩展backbone.model，如 清单 4 所示。

清单 4. backbone.model 创建

app.models.team = backbone.model.extend({
  defaults : {
    // default attributes
  }
  // domain-specific methods go here
});

app.models.team 函数是一个新模型函数，但是必须创建一个实例才能在应用程序中使用特定模型，如 清单 5 所示。

清单 5. 模型实例化

var team1 = new app.models.team();

现在，变量 team1 有一个名为 cid 的字段名，这是一个客户端标识符，形式为 "c" 再加上一个数字（例如，c0、c1、c2）。模型是通过存储在散列映射中的属性来定义的。属性可以在实例化时进行设置，或者使用 set() 方法设置。属性值可通过 get() 方法检索。清单 6 显示了如何通过实例化或 get()/set() 方法设置和获取属性。

清单 6. 模型实例化和 get/set 方法

// "name" attribute is set into the model
var team1 = new app.models.team({
  name : "name1"
});
console.log(team1.get("name")); // prints "name1"

// "name" attribute is set with a new value
team1.set({
  name : "name2"
});
console.log(team1.get("name")); //prints "name2"

当使用 javascript 对象时，使用 set() 方法创建或者设置属性值的原因并不是显而易见的。其中一个原因是为了更新此值，如 清单 7 所示。

清单 7. 以错误的方法更新属性

team1.attributes.name = "name2";

为了避免 使用 清单 7 中的代码，使用 set() 是改变模型状态并触发其变更事件的唯一方法。使用 set() 提升封装原则。清单 8 展示了如何将一个事件处理程序绑到发生变更的事件中。该事件处理程序包含一个 alert，在调用 set() 方法时会被触发，如 清单 6 所示。但是，在使用 清单 7 中的代码时不触发 alert。

清单 8. 更改 app.models.team 模型中的事件处理程序

app.models.team = backbone.model.extend({
  initialize : function(){
    this.bind("change", this.changed);
  },
  changed : function(){
    alert("changed");
  }
});

backbone 的另一个优势是易于通过 ajax 交互与服务器进行通信。在模型上调用一个 save() 方法会通过 rest json api 异步将当前状态保存到服务器。清单 9 展示了此示例。

清单 9. 在模型对象上调用 save 方法

barca.save();

save() 函数将在后台委托给 backbone.sync，这是负责发出 restful 请求的组件，默认使用 jquery 函数 $.ajax()。由于调用了 rest 风格架构，每个 create、read、update 或 delete (crud) 活动均会与各种不同类型的 http 请求（post、get、put 和 delete）相关联。首先保存模型对象，使用一个 post 请求，创建一个标识符 id，其后，尝试发送对象到服务器，使用一个 put 请求。

当需要从服务器检索一个模型时，请求一个 read 活动并使用一个 ajax get 请求。这类请求使用 fetch() 方法。要确定导入模型数据或者从中取出模型数据的服务器的位置：

1. 如果模型属于一个 collection，那么集合对象的 url 属性将是该位置的基础，并且该模型 id（不是 cid）会被附加以构成完整的 url。
2. 如果模型不是在一个集合中，那么该模型的 urlroot 属性被用作该位置的基础

清单 10 显示了如何获取一个模型。

清单 10. 模型对象的 fetch() 方法

var teamnew = new app.models.team({
  urlroot : '/specialteams'
});
teamnew.save(); // returns model's id equal to '222'
teamnew.fetch(); // ajax request to '/specialteams/222'

validate() 方法被用于验证模型，如 清单 11 所示。需要重写 validate() 方法（在调用 set() 方法时触发）来包含模型的有效逻辑。传递给该函数的惟一参数是一个 javascript 对象，该对象包含了 set() 方法更新的属性，以便验证那些属性的条件。如果从 validate() 方法中没有返回任何内容，那么验证成功。如果返回一个错误消息，那么验证失败，将无法执行 set() 方法。

清单 11. 模型的验证方法

app.models.team = backbone.model.extend({
  validate : function(attributes){
    if (!!attributes && attributes.name === "teamx") {
      // error message returned if the value of the "name" 
      // attribute is equal to "teamx"
      return "error!";
    }
  }
}

一组模型被分组到到集合中，这个集合是 backbone.collection 的扩展函数。集合具有一个模型属性的特性，定义了组成该集合的模型类型。使用 add()/remove() 方法可以将一个模型添加和移动到集合中。清单 12 显示了如何创建和填充一个集合。

清单 12. backbone 集合

app.collections.teams = backbone.collection.extend({
  model : app.models.team
});
var teams = new app.collections.teams();

// add e model to the collection object "teams"
teams.add(team1);
teams.add(new app.models.team({
  name : "team b"
}));
teams.add(new app.models.team());
teams.remove(team1);

console.log(teams.length) // prints 2

创建的 teams 集合中包含一个含有两个模型的阵列，存储在模型属性中。尽管，在典型 ajax 应用程序中，会从服务器动态（不是人工）填充该集合。fetch() 方法可以帮助完成此项任务，如 清单 13 所示，并将数据存储到模型阵列中。

清单 13. fetch() 方法

teams.fetch();

backbone 中的集合拥有一个 url 属性，定义了使用 ajax get 请求从服务器取出 json 数据的位置，如 清单 14 所示。

清单 14. 集合的 url 属性和 fetch() 方法

teams.url = '/getteams';
teams.fetch(); //ajax get request to '/getteams'

fetch() 方法属于异步调用，因此，在等待服务器响应时，应用程序不会中止。在一些情况下，要操作来自服务器的原始数据，可以使用集合的 parse() 方法。正如 清单 15 所示。

清单 15. parse() 方法

app.collections.teams = backbone.collection.extend({
  model : app.models.team,
  parse : function(data) {
    // 'data' contains the raw json object
    console.log(data);
  }
});

集合提供的另一个有趣的方法是 reset()，它允许将多个模型设置到一个集合中。reset() 方法可以非常方便地将数据引导到集合中，比如页面加载，来避免用户等待异步调用返回。

视图和客户端模板

backbone 中的视图与典型 mvc 方法的视图不一样。backbone 视图可以扩展 backbone.view 函数并显示模型中存储的数据。一个视图提供一个由 el 属性定义的 html 元素。该属性可以是由 tagname、classname 和 id 属性相组合而构成的，或者是通过其本身的 el 值形成的。清单 16 显示了使用这不同方法组合 el 属性的两个不同视图。

清单 16. backbone 视图样例

// in the following view, el value is 'ul.team-element'
app.views.teams = backbone.view.extend({
  el : 'ul.team-list'
});
// in the following view, el value is 'div.team-element'
app.views.team = backbone.view.extend({
  classname : '.team-element',
  tagname : 'div'
});

如果 el、tagname、classname 和 id 属性为空，那么会默认将一个空的 div 分配给 el。

如上所述，一个视图必须与一个模型相关联。该模型属性也很有用，如 清单 17 所示。app.view.team 视图被绑定到一个app.models.team 模型实例。

清单 17. backbone 视图中的模型属性

// in the following view, el value is 'ul.team-element'
app.views.team = backbone.view.extend({
  ...
  model : new app.models.team
});

要渲染数据（这是视图的主要目的），重写 render() 方法和逻辑来显示 dom 元素（由 el 属性引用的）中的模型属性。清单 18 展示了一个 render 方法如何更新用户界面的样例。

清单 18. render() 方法

app.views.team = backbone.view.extend({
  classname : '.team-element',
  tagname : 'div',
  model : new app.models.team
  render : function() {
    // render the 'name' attribute of the model associated
    // inside the dom element referred by 'el'
    $(this.el).html("<span>" + this.model.get("name") + "</span>");
  }
});

backbone 也可以促进客户端模板的使用，这就使得我们没有必要在 javascript 中嵌入 html 代码，如 清单 18 所示。（使用模板，模板会封装视图中常见函数；只指定此函数一次即可。）backbone 在 underscore.js（一个必须的库）中提供一个模板引擎，尽管没有必要使用该模板引擎。清单 19 中的实例使用 underscore.js html 模板。

清单 19. html 含有模板

<script id="teamtemplate" type="text/template">
  <%= name %>
</script>

清单 20 显示了另一个使用 underscore.js html 模板的样例。

清单 20. 使用 _.template() 函数的视图

app.views.team = backbone.view.extend({
  classname : '.team-element',
  tagname : 'div',
  model : new app.models.team
  render : function() {
    // compile the template
    var compiledtemplate = _.template($('#teamtemplate').html());
    // model attributes loaded into the template. template is
    // appended to the dom element referred by the el attribute
    $(this.el).html(compiledtemplate(this.model.tojson()));
  }
});

backbone 中最有用且最有趣的一个功能是将 render() 方法绑定到模型的变更事件中，如 清单 21 所示。

清单 21. render() 方法绑定到模型变更事件

// in the following view, el value is 'div.team-element'
app.views.team = backbone.view.extend({
  model : new app.models.team,
  initialize : function() {
    this.model.bind("change", this.render, this);
  } 
})

上述代码将 render() 方法绑定到一个模型的变更事件中。当模型发生更改时，会自动触发 render() 方法，从而节省数行代码。从 backbone 0.5.2 开始，bind() 方法就开始接受使用第三个参数来定义回调函数的对象。（在上述示例中，当前视图是回调函数 render() 中的对象）。在 backbone 0.5.2 之前的版本中，必须使用 underscore.js 中的 bindall 函数，如 清单 22 所示。

清单 22. _.bindall() usage

// in the following view, el value is 'div.team-element'
app.views.team = backbone.view.extend({
  initialize : function() {
    _.bindall(this, "render");
    this.model.bind("change", this.render);
  } 
})

backbone 视图中，通过视图中的 dom 对象监听事件是比较容易的。对于实现这一点，events 属性很是方便的，如 清单 23 所示。

清单 23. 事件属性

app.views.team = backbone.view.extend({
  classname : '.team-element',
  tagname : 'div',
  events : {
    "click a.more" : "moreinfo"
  },
  moreinfo : function(e){
     // logic here
  }
})

events 属性的每个项均由两部分构成：

1. 左边部分指定事件类型和触发事件的选择器。
2. 右边部分定义了事件处理函数。

在 清单 23 中，当用户通过 div 中的类 more 以及类 team-element 点击链接时，会调用函数 moreinfo

结束语

mvc 模式可以为大型 javascript 应用程序提供所需的组织化代码。backbone 是一个 javascript mvc 框架，它属于轻量级框架，且易于学习掌握。模型、视图、集合和路由器从不同的层面划分了应用程序，并负责处理几种特定事件。处理 ajax 应用程序或者 spi 应用程序时，backbone 可能是最好的解决方案。