《BackboneJS框架的技巧及模式》(4)完结篇-阿里云开发者社区

开发者社区> 开发与运维> 正文

《BackboneJS框架的技巧及模式》(4)完结篇

简介: 八、PUT需要一个ID属性 这一条也经常会对那些Backbone.js新手造成困扰。要想在调用.save()的时候让模型发送一个HTTP PUT请求,你的模型需要有一个ID属性集。

八、PUT需要一个ID属性

这一条也经常会对那些Backbone.js新手造成困扰。要想在调用.save()的时候让模型发送一个HTTP PUT请求,你的模型需要有一个ID属性集。记得HTTP PUT谓词是设计用做更新的吧,所以发送一PUT请求,你的模型需要有一个ID。在理想情况,你的所有模型都有一名为ID的完美ID属性,但是你从端点接收到的JSON数据或许并不总是有完美命名的ID。

因此,如果你需要更新一个模型,在保存前确保模型上带有ID。Backbone.js从0.5版开始允许使用idAttribute来修改模型ID属性的名称,如果端点返回的不是名为id的ID属性名时。

如果使用的Backbone.js版本低于0.5,建议你修改模型或集合的parse函数,以便将期望的ID属性映射到属性ID。这里有一个快速上手的例子,说明了应怎样修改parse函数来做到这一点。我们假设你有一个cars的集合,它的ID属性名是carID。


[javascript] view plaincopyprint?
  1. parse: function(response) {  
  2.   
  3.     _.each(response.cars, function(car, i) {  
  4.         // map the returned ID of carID to the correct attribute ID  
  5.         response.cars[i].id = response.cars[i].carID;  
  6.     });  
  7.   
  8.     return response;  
  9. },  

九、在页面加载是插件模型数据


有时你会发现模型或集合需要在页面加载时进行初始化。许多关于Backbone.js模式的文章,例如Rico Sta Cruz的“Backbone模式”和Katz的“避免常见的Backbone.js陷阱”,讨论了这种模式。这种模式实现很容易,只需在页面中内联一段脚本,通过你选择的服务端语言,将单个模型属性或者JSON形式的数据呈现出来。例如,在Rails语言中,我采用下面的一种方法:


[javascript] view plaincopyprint?
  1. // a single attribute  
  2. var model = new Model({  
  3.     hello:   
  4. });  
  5. // or to have json  
  6. var model = new Model();  

应用此模式可以通过“立即”渲染页面,以改善你网站的搜索引擎排名,而且它也可通过限制应用初始化HTTP请求的方式,大幅缩短应用启动与运行所需的时间。


十、处理失败的模型属性验证

很多时候,你会想知道是哪个模型属性验证失败了。例如,如果你有一个极其复杂的表单字段,你或许想知道哪一个模型属性验证失败了,以便于你可以将该属性对应的输入字段进行高亮显示。不幸的是,警告视图到底是哪个模型属性验证失败并没有直接集成于Backbone.js,但是你可以用其他不同的模式去处理这个问题。

1、返回一个错误对象

一个通知视图是哪个模型属性验证失败的模式是,返回一个对象,其中包含某种标志,它详细的记录了验证失败的属性,就像下面这样:


[javascript] view plaincopyprint?
  1. // Inside your model  
  2. validate: function(attrs) {  
  3.     var errors = [];  
  4.   
  5.     if(attrs.a 
  6.         errors.push({  
  7.             'message''Form field a is messed up!',  
  8.             'class''a'  
  9.         });  
  10.     }  
  11.     if(attrs.b 
  12.         errors.push({  
  13.             'message''Form field b is messed up!',  
  14.             'class''b'  
  15.         });  
  16.     }  
  17.   
  18.     if(errors.length) {  
  19.         return errors;  
  20.     }  
  21. }  
  22. // Inside your view  
  23. this.model.on('invalid’, function(model, errors) {  
  24.     _.each(errors, function(error, i) {  
  25.         $(‘.’ + error.class).addClass('error');  
  26.         alert(error.message);  
  27.     });  
  28. });  

此模式的优点在于,你可以在一个地方处理所有无效的消息。缺点在于,如果你用不同的invalid属性处理无效属性,那么你的invalid方法里面可能会有非常庞大的switch语句或if语句。


2、广播自定义的Error事件

我的朋友Derick Bailey推荐了一个可替代的模式,就是为每个模型属性触发自定义的errors事件。它允许你的视图能够针对单独的属性绑定特定的error事件:


[javascript] view plaincopyprint?
  1. // Inside your model  
  2. validate: function(attrs) {  
  3.   
  4.     if(attrs.a 
  5.             this.trigger(‘invalid:a’, 'Form field a is messed up!'this);  
  6.     }  
  7.     if(attrs.b 
  8.             this.trigger(‘invalid:b’, 'Form field b is messed up!'this);  
  9.     }  
  10. }  
  11. // Inside your view  
  12. this.model.on('invalid:a’, function(error) {  
  13.         $(‘a’).addClass('error');  
  14.         alert(error);  
  15. });  
  16. this.model.on('invalid:b’, function(error) {  
  17.         $(‘b’).addClass('error');  
  18.         alert(error);  
  19. });  

此模式的优点在于,你的视图绑定的error类型是清晰的,并且对于每一种error属性,可以有特定的指令,它可以使得视图方面的代码很清晰,使之更易于维护。此模式的缺点在于,视图的代码可能会变得极为膨胀。


这两种模式都各有利弊,你应该考虑清楚哪个模式对你的应用案例是最优的。如果你按照同样的方式处理所有失败的验证,那么第一个方法可能是最好的;如果你对每个模型属性有特定的UI变化,那么后一种方法会更好。

十一、HTTP状态码200触发错误

如果终端的模型或集合收到了无效的JSON,尽管终端返回了HTTP状态码200,模型或集合还是会触发error事件。这种问题经常发生于开发阶段在本地模拟JSON数据造成的。那么,有个好方法是抛出经过 JSON 验证器验证了的模拟JSON数据文件。或者使用IDE的插件来及时捕获格式错误的JSON数据。

十二、创建通用的错误显示

这能够节省开发时间以及创建统一的模式来处理和可视化错误消息,而且它可以改善整个的用户体验。我之前开发的每一个Backbone.js应用中,我都会创建一个通用的警告视图:


[javascript] view plaincopyprint?
  1. var AlertView = Backbone.View.extend({  
  2.     set: function(typeOfError, message) {  
  3.         var alert = $(‘.in-page-alert’).length ? $(‘.in-page-alert’): $(‘.body-alert’);  
  4.         alert  
  5.             .removeClass(‘error success warning’)  
  6.             .addClass(typeOfError)  
  7.             .html(message)  
  8.             .fadeIn()  
  9.             .delay(5000)  
  10.             .fadeOut();  
  11.     }  
  12. });  

上面代码首先会检查视图代码中是否存在指定in-page-alert视图的DIV元素。如果没有,则接着查看通用的body-alert的DIV元素,它可以在布局中进行声明。这可以交付一致性的错误信息给用户,而且一旦你忘记指定in-page-alert视图的DIV元素,它会有一个有用的反馈。下面的模式简化了怎样在试图中处理错误信息:



[javascript] view plaincopyprint?
  1. var alert = new AlertView();  
  2.   
  3. this.model.on('error'function(model, error) {  
  4.     alert.set('TYPE-OF-ERROR', error);  
  5. });  

十三、单页面应用中更新页面标题


如果你正在开发一个单页面应用,切记要更新每个页面的标题。我写过一个简单的插件(Backbone.js Router Title Helper),它以简单、优雅的格式扩展了 backbone.js router 的功能。它通过一个 Map 对象来控制路由,键来代表路由函数的名字,值则映射到页面的标题。

[javascript] view plaincopyprint?
  1. Backbone.Router = Backbone.Router.extend({  
  2.   
  3.     initialize: function(options){  
  4.         var that = this;  
  5.   
  6.         this.on('route'function(router, route, params) {  
  7.   
  8.             if(that.titles) {  
  9.                 if(that.titles[router]) document.title = that.titles[router];  
  10.                 else if(that.titles.default) document.title = that.titles.default;  
  11.                 else throw 'Backbone.js Router Title Helper: No title found for route:' + router + ' and no default route specified.';  
  12.             }  
  13.         });  
  14.     }  
  15. });  

1、在单页应用中缓存对象


当谈论单页应用时,缓存对象的模式会经常用到!下面的例子简明扼要:


[javascript] view plaincopyprint?
  1. // Inside a router  
  2. initialize: function() {  
  3.   
  4.     this.cached = {  
  5.         view: undefined,  
  6.         model: undefined  
  7.     }  
  8. },  
  9.   
  10. index: function(parameter) {  
  11.     this.cached.model = this.cached.model || new Model({  
  12.         parameter: parameter  
  13.     });  
  14.     this.cached.view = this.cached.view || new View({  
  15.         model: this.cached.model  
  16.     });  
  17. }  

此模式可以加速你的应用程序,因为你不用重新初始化Backbone.js对象。然而,它会过多地消耗内存;所以,缓存的对象应该是在整个应用程序中使用的。如果以前你用过Backbone.js开发过应用,也许你会问你自己,“ 我要重取数据该怎么做?”你可以每次在如下路径中触发后重取数据:



[javascript] view plaincopyprint?
  1. // Inside a router  
  2. initialize: function() {  
  3.   
  4.     this.cached = {  
  5.         view: undefined,  
  6.         model: undefined  
  7.     }  
  8. },  
  9.   
  10. index: function(parameter) {  
  11.     this.cached.model = this.cached.model || new Model({  
  12.         parameter: parameter  
  13.     });  
  14.     this.cached.view = this.cached.view || new View({  
  15.         model: this.cached.model  
  16.     });  
  17.     this.cached.model.fetch();  
  18. }  

当应用程序从端点(比如收件箱)必须取回最新的数据,上面的模式就可以工作。当然,如果待取回的数据时依赖于应用程序的状态(假设这个状态是通过URL和参数来决定的),那么即使应用程序的状态为发生改变,也应该重新取回数据。更好的解决方案是只在应用程序的参数发生变化时重新取回数据:



[javascript] view plaincopyprint?
  1. // Inside a router  
  2. initialize: function() {  
  3.   
  4.     this.cached = {  
  5.         view: undefined,  
  6.         model: undefined  
  7.     }  
  8. },  
  9.   
  10. index: function(parameter) {  
  11.     this.cached.model = this.cached.model || new Model({  
  12.         parameter:parameter  
  13.     });  
  14.     this.cached.model.set('parameter', parameter);  
  15.     this.cached.view = this.cached.view || new View({  
  16.         model: this.cached.model  
  17.     });  
  18. }  
  19.   
  20. // Inside of the model  
  21. initialize: function() {  
  22.     this.on("change:parameter"this.fetchData, this);  
  23. }  

十四、JSDoc函数和Backbone.js类


我是文档注释和JSDoc的超级粉丝。我用JSDoc对所有的Backbone类添加了文档注释:


[javascript] view plaincopyprint?
  1. var Thing = Backbone.View.extend(/** @lends Thing.prototype */{  
  2.     /** @class Thing 
  3.      * @author Phillip Whisenhunt 
  4.      * @augments Backbone.View 
  5.      * @contructs Thing object */  
  6.     initialize() {},  
  7.   
  8.     /** Gets data by ID from the thing. If the thing doesn't have data based on the ID, an empty string is returned. 
  9.      * @param {String} id The id of get data for. 
  10.      * @return {String} The data. */  
  11.     getDataById: function(id) {}  
  12. });  

如果你使用上面的方法对Backbone类添加文档注释,那么你可以生成优美的文档,文档包含了所有的类和函数及参数。确保初始化函数应作为第一个声明的函数,它可以帮助我们生成JSDoc文档。如果你想看使用JSDoc的项目例子,这里有:
https://github.com/homeaway/calendar-widget


十五、测试驱动的开发实践

我认为如果你使用Backbone.js开发项目,那么你应遵循测试驱动开发TDD。我第一次用Jasmine.js创建模型和集合时遵循TDD进行单元测试,但失败了。一旦写下单元测试并且失败,我会对整个模型和集合进行重写。

通过这一点,我的所有Jasmine测试都通过了,而且我有信心我的模型及集合会和我期望的一样工作。自从我遵循TDD,我的视图层非常容易编写而且非常简单。当你开始用TDD时,你的开发速度当然会很慢;但是一但你的脑海里一直想着TDD,你的编程效率和质量会显著提高。

版权声明:本文首发在云栖社区,遵循云栖社区版权声明:本文内容由互联网用户自发贡献,版权归用户作者所有,云栖社区不为本文内容承担相关法律责任。云栖社区已升级为阿里云开发者社区。如果您发现本文中有涉嫌抄袭的内容,欢迎发送邮件至:developer2020@service.aliyun.com 进行举报,并提供相关证据,一经查实,阿里云开发者社区将协助删除涉嫌侵权内容。

分享:
开发与运维
使用钉钉扫一扫加入圈子
+ 订阅

集结各类场景实战经验,助你开发运维畅行无忧

其他文章