这篇文章主要介绍了 Backbone.js 框架中 Model 与 Collection 的使用实例, Collection 是 Model 的一个有序的集合, 需要的朋友可以参考下
Backbone 为复杂 Javascript 应用程序提供模型 (models)、集合(collections)、视图(views) 的结构。其中模型用于绑定键值数据和自定义事件;集合附有可枚举函数的丰富 API; 视图可以声明事件处理函数,并通过 RESTful JSON 接口连接到应用程序。
Model
关于 backbone,最基础的一个东西就是 model,这个东西就像是后端开发中的数据库映射那个 model 一样,也是数据对象的模型,并且应该是和后端的 model 有相同的属性(仅是需要通过前端来操作的属性)。
下面就从实例来一步一步的带大家来了解 backbone 的 model 到底是什么样的一个东西。
首先定义一个 html 的页面:
- <!DOCTYPE html>
- <html>
- <head>
- <title>
- the5fire-backbone-model
- </title>
- </head>
- <body>
- </body>
- <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.4.4/jquery.min.js">
- </script>
- <script src="http://ajax.cdnjs.com/ajax/libs/underscore.js/1.1.4/underscore-min.js">
- </script>
- <script src="http://ajax.cdnjs.com/ajax/libs/backbone.js/0.3.3/backbone-min.js">
- </script>
- <script>
- (function($) {
- /**
- *此处填充代码
- **/
- })(jQuery);
- </script>
- </html>
下面的代码需要填到这个 html 的 script 标签中的 function 中。
1、最简单的一个对象
- Man = Backbone.Model.extend({
- initialize: function(){
- alert('Hey, you create me!');
- }
- });
- var man = new Man;
这个就很简单了,在 helloworld 里面也有了一个 model 的展现,不定义了属性,这里是一个 初始化时的方法,或者称之为构造函数。
2、对象赋值的两种方法
第一种,直接定义,设置默认值。
- Man = Backbone.Model.extend({
- initialize: function(){
- alert('Hey, you create me!');
- },
- defaults: {
- name:'张三',
- age: '38'
- }
- });
- var man = new Man;
- alert(man.get('name'));
第二种,赋值时定义
- Man = Backbone.Model.extend({
- initialize: function() {
- alert('Hey, you create me!');
- }
- });
- man.set({
- name: 'the5fire',
- age: '10'
- });
- alert(man.get('name'));
取值的时候都是用 get。
3、对象中的方法
- Man = Backbone.Model.extend({
- initialize: function(){
- alert('Hey, you create me!');
- },
- defaults: {
- name:'张三',
- age: '38'
- },
- aboutMe: function(){
- return '我叫' + this.get('name') + ',今年' + this.get('age') + '岁';
- }
- });
- var man = new Man;
- alert(man.aboutMe());
4、监听对象中属性的变化
- Man = Backbone.Model.extend({
- initialize: function() {
- alert('Hey, you create me!');
- //初始化时绑定监听
- this.bind("change:name",
- function() {
- var name = this.get("name");
- alert("你改变了name属性为:" + name);
- });
- },
- defaults: {
- name: '张三',
- age: '38'
- },
- aboutMe: function() {
- return '我叫' + this.get('name') + ',今年' + this.get('age') + '岁';
- }
- });
- var man = new Man;
- man.set({
- name: 'the5fire'
- }) //触发绑定的change事件,alert。
5、为对象添加验证规则,以及错误提示
- Man = Backbone.Model.extend({
- initialize: function() {
- alert('Hey, you create me!');
- //初始化时绑定监听
- this.bind("change:name",
- function() {
- var name = this.get("name");
- alert("你改变了name属性为:" + name);
- });
- this.bind("error",
- function(model, error) {
- alert(error);
- });
- },
- defaults: {
- name: '张三',
- age: '38'
- },
- validate: function(attributes) {
- if (attributes.name == '') {
- return "name不能为空!";
- }
- },
- aboutMe: function() {
- return '我叫' + this.get('name') + ',今年' + this.get('age') + '岁';
- }
- });
- var man = new Man;
- man.set({
- name: ''
- }); //根据验证规则,弹出错误提示。
6、对象的获取和保存,需要服务器端支持才能测试。
首先需要为对象定义一个 url 属性,调用 save 方法时会 post 对象的所有属性到 server 端。
- Man = Backbone.Model.extend({
- url: '/save/',
- initialize: function() {
- alert('Hey, you create me!');
- //初始化时绑定监听
- this.bind("change:name",
- function() {
- var name = this.get("name");
- alert("你改变了name属性为:" + name);
- });
- this.bind("error",
- function(model, error) {
- alert(error);
- });
- },
- defaults: {
- name: '张三',
- age: '38'
- },
- validate: function(attributes) {
- if (attributes.name == '') {
- return "name不能为空!";
- }
- },
- aboutMe: function() {
- return '我叫' + this.get('name') + ',今年' + this.get('age') + '岁';
- }
- });
- var man = new Man;;
- man.set({
- name: 'the5fire'
- });
- man.save(); //会发送POST到模型对应的url,数据格式为json{"name":"the5fire","age":38}
- //然后接着就是从服务器端获取数据使用方法fetch([options])
- var man1 = new Man;
- //第一种情况,如果直接使用fetch方法,那么他会发送get请求到你model的url中,
- //你在服务器端可以通过判断是get还是post来进行对应的操作。
- man1.fetch();
- //第二种情况,在fetch中加入参数,如下:
- man1.fetch({
- url: '/getmans/'
- });
- //这样,就会发送get请求到/getmans/这个url中,
- //服务器返回的结果样式应该是对应的json格式数据,同save时POST过去的格式。
- //不过接受服务器端返回的数据方法是这样的:
- man1.fetch({
- url: '/getmans/',
- success: function(model, response) {
- alert('success');
- //model为获取到的数据
- alert(model.get('name'));
- },
- error: function() {
- //当返回格式不正确或者是非json数据时,会执行此方法
- alert('error');
- }
- });
注:上述代码仅仅均为可正常执行的代码,不过关于服务器端的实例在后面会有。
这里还要补充一点,就是关于服务器的异步操作都是通过 Backbone.sync 这个方法来完成的,调用这个方法的时候会自动的传递一个参数过去,根据参数向服务器端发送对应的请求。比如你 save,backbone 会判断你的这个对象是不是新的,如果是新创建的则参数为 create,如果是已存在的对象只是进行了改变,那么参数就为 update,如果你调用 fetch 方法,那参数就是 read,如果是 destory,那么参数就是 delete。也就是所谓的 CRUD ("create", "read", "update", or "delete"),而这四种参数对应的请求类型为 POST,GET,PUT,DELETE。你可以在服务器根据这个 request 类型,来做出相应的 CRUD 操作。
Note:
关于 url 和 urlRoot 的事,如果你设置了 url,那么你的 CRUD 都会发送对应请求到这个 url 上,但是这样又一个问题,就是 delete 请求,发送了请求,但是却没有发送任何数据,那么你在服务器端就不知道应该删除哪个对象(记录),所以这里又一个 urlRoot 的概念,你设置了 urlRoot 之后,你发送 PUT 和 DELETE 请求的时候,其请求的 url 地址就是:/baseurl/[model.id],这样你就可以在服务器端通过对 url 后面值的提取更新或者删除对应的对象(记录)。
Collection
collection 是 model 对象的一个有序的集合,概念理解起来十分简单,在通过几个例子来看一下,会觉得更简单。
1、关于 book 和 bookshelf 的例子
- Book = Backbone.Model.extend({
- defaults: { // 感谢网友蓝色动力指正改为defaults
- title: 'default'
- },
- initialize: function() {
- //alert('Hey, you create me!');
- }
- });
- BookShelf = Backbone.Collection.extend({
- model: Book
- });
- var book1 = new Book({
- title: 'book1'
- });
- var book2 = new Book({
- title: 'book2'
- });
- var book3 = new Book({
- title: 'book3'
- });
- //var bookShelf = new BookShelf([book1, book2, book3]); //注意这里面是数组,或者使用add
- var bookShelf = new BookShelf;
- bookShelf.add(book1);
- bookShelf.add(book2);
- bookShelf.add(book3);
- bookShelf.remove(book3);
- //基于underscore这个js库,还可以使用each的方法获取collection中的数据
- bookShelf.each(function(book) {
- alert(book.get('title'));
- });
很简单,不解释
2、使用 fetch 从服务器端获取数据
首先要在上面的的 Bookshelf 中定义 url,注意 collection 中并没有 urlRoot 这个属性。或者你直接在 fetch 方法中定义 url 的值,如下:
- bookShelf.fetch({
- url: '/getbooks/',
- success: function(collection, response) {
- collection.each(function(book) {
- alert(book.get('title'));
- });
- },
- error: function() {
- alert('error');
- }
- });
其中也定义了两个接受返回值的方法,具体含义我想很容易理解,返回正确格式的数据,就会调用 success 方法,错误格式的数据就会调用 error 方法,当然 error 方法也看添加和 success 方法一样的形参。
对应的 BookShelf 的返回格式如下:[{'title':'book1'},{'title':'book2'}.....]
3、reset 方法
这个方法的时候是要和上面的 fetch 进行配合的,collection 在 fetch 到数据之后,会调用 reset 方法,所以你需要在 collection 中定义 reset 方法或者是绑定 reset 方法。这里使用绑定演示:
- bookShelf.bind('reset',showAllBooks);
- showAllBooks = function(){
- bookShelf.each(function(book){
- //将book数据渲染到页面。
- });
- }
绑定的步骤要在 fetch 之前进行。
下面给出关于 collection 的完整代码,需要服务器端支持才行,服务器端的搭建在后面会写到。
- <!DOCTYPE html>
- <html>
- <head>
- <title>
- the5fire-backbone-collection
- </title>
- </head>
- <body>
- </body>
- <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.4.4/jquery.min.js">
- </script>
- <script src="http://ajax.cdnjs.com/ajax/libs/underscore.js/1.1.4/underscore-min.js">
- </script>
- <script src="http://ajax.cdnjs.com/ajax/libs/backbone.js/0.3.3/backbone-min.js">
- </script>
- <script>
- (function($) {
- //collection是一个简单的models的有序集合
- //1、一个简单的例子
- Book = Backbone.Model.extend({
- defaults: { // 感谢网友蓝色动力指正改为defaults
- title: 'default'
- },
- initialize: function() {
- //alert('Hey, you create me!');
- }
- });
- BookShelf = Backbone.Collection.extend({
- model: Book
- });
- var book1 = new Book({
- title: 'book1'
- });
- var book2 = new Book({
- title: 'book2'
- });
- var book3 = new Book({
- title: 'book3'
- });
- //var bookShelf = new BookShelf([book1, book2, book3]); //注意这里面是数组,或者使用add
- var bookShelf = new BookShelf;
- bookShelf.add(book1);
- bookShelf.add(book2);
- bookShelf.add(book3);
- bookShelf.remove(book3);
- /*
- for(var i=0; i<bookShelf.models.length; i++) {
- alert(bookShelf.models[i].get('title'));
- }
- */
- //基于underscore这个js库,还可以使用each的方法获取collection中的数据
- bookShelf.each(function(book) {
- alert(book.get('title'));
- });
- //2、使用fetch从服务器端获取数据,使用reset渲染
- bookShelf.bind('reset', showAllBooks);
- bookShelf.fetch({
- url: '/getbooks/',
- success: function(collection, response) {
- collection.each(function(book) {
- alert(book.get('title'));
- });
- },
- error: function() {
- alert('error');
- }
- });
- showAllBooks = function() {
- bookShelf.each(function(book) { //将book数据渲染到页面。
- });
- }
- //上述代码仅仅均为可正常执行的代码,不过关于服务器端的实例在后面会有。
- })(jQuery);
- </script>
- </html>
来源: