前言: 個人也翻譯過一遍，可是基礎(chǔ)知識不夠，所以理解的沒有很清楚 // Backbone.js 0.9.2// (c) 2010-2012 Jeremy Ashkenas, DocumentCloud Inc. // Backbone may be freely distributed under the MIT license. // For all details and documentation: // http://backbonejs.org (function () {// 創(chuàng)建一個全局對象, 在瀏覽器中表示為window對象, 在Node.js中表示global對象 var root = this;// 保存"Backbone"變量被覆蓋之前的值 // 如果出現(xiàn)命名沖突或考慮到規(guī)范, 可通過Backbone.noConflict()方法恢復(fù)該變量被Backbone占用之前的值, 并返回Backbone對象以便重新命名 var previousBackbone = root.Backbone;// 將Array.prototype中的slice和splice方法緩存到局部變量以供調(diào)用 var slice = Array.prototype.slice; var splice = Array.prototype.splice;var Backbone; if (typeof exports !== 'undefined') { Backbone = exports; } else { Backbone = root.Backbone = {}; }// 定義Backbone版本 Backbone.VERSION = '0.9.2';// 在服務(wù)器環(huán)境下自動導(dǎo)入Underscore, 在Backbone中部分方法依賴或繼承自Underscore var _ = root._; if (!_ && (typeof require !== 'undefined')) _ = require('underscore');// 定義第三方庫為統(tǒng)一的變量"$", 用于在視圖(View), 事件處理和與服務(wù)器數(shù)據(jù)同步(sync)時調(diào)用庫中的方法 // 支持的庫包括jQuery, Zepto等, 它們語法相同, 但Zepto更適用移動開發(fā), 它主要針對Webkit內(nèi)核瀏覽器 // 也可以通過自定義一個與jQuery語法相似的自定義庫, 供Backbone使用(有時我們可能需要一個比jQuery, Zepto更輕巧的自定義版本) // 這里定義的"$"是局部變量, 因此不會影響在Backbone框架之外第三方庫的正常使用 var $ = root.jQuery || root.Zepto || root.ender;// 手動設(shè)置第三方庫 // 如果在導(dǎo)入了Backbone之前并沒有導(dǎo)入第三方庫, 可以通過setDomLibrary方法設(shè)置"$"局部變量 // setDomLibrary方法也常用于在Backbone中動態(tài)導(dǎo)入自定義庫 Backbone.setDomLibrary = function (lib) { $ = lib; }; // 放棄以"Backbone"命名框架, 并返回Backbone對象, 一般用于避免命名沖突或規(guī)范命名方式 // 例如: // var bk = Backbone.noConflict(); // 取消"Backbone"命名, 并將Backbone對象存放于bk變量中 // console.log(Backbone); // 該變量已經(jīng)無法再訪問Backbone對象, 而恢復(fù)為Backbone定義前的值 // var MyBackbone = bk; // 而bk存儲了Backbone對象, 我們將它重命名為MyBackbone Backbone.noConflict = function () { root.Backbone = previousBackbone; return this; }; // 對于不支持REST方式的瀏覽器, 可以設(shè)置Backbone.emulateHTTP = true // 與服務(wù)器請求將以POST方式發(fā)送, 并在數(shù)據(jù)中加入_method參數(shù)標(biāo)識操作名稱, 同時也將發(fā)送X-HTTP-Method-Override頭信息 Backbone.emulateHTTP = false;// 對于不支持application/json編碼的瀏覽器, 可以設(shè)置Backbone.emulateJSON = true; // 將請求類型設(shè)置為application/x-www-form-urlencoded, 并將數(shù)據(jù)放置在model參數(shù)中實現(xiàn)兼容 Backbone.emulateJSON = false;// Backbone.Events 自定義事件相關(guān) // -----------------// eventSplitter指定處理多個事件時, 事件名稱的解析規(guī)則 var eventSplitter = /\s+/;// 自定義事件管理器 // 通過在對象中綁定Events相關(guān)方法, 允許向?qū)ο筇砑? 刪除和觸發(fā)自定義事件 var Events = Backbone.Events = {// 將自定義事件(events)和回調(diào)函數(shù)(callback)綁定到當(dāng)前對象 // 回調(diào)函數(shù)中的上下文對象為指定的context, 如果沒有設(shè)置context則上下文對象默認(rèn)為當(dāng)前綁定事件的對象 // 該方法類似與DOM Level2中的addEventListener方法 // events允許指定多個事件名稱, 通過空白字符進(jìn)行分隔(如空格, 制表符等) // 當(dāng)事件名稱為"all"時, 在調(diào)用trigger方法觸發(fā)任何事件時, 均會調(diào)用"all"事件中綁定的所有回調(diào)函數(shù) on: function (events, callback, context) { // 定義一些函數(shù)中使用到的局部變量 var calls, event, node, tail, list; // 必須設(shè)置callback回調(diào)函數(shù) if (!callback) return this; // 通過eventSplitter對事件名稱進(jìn)行解析, 使用split將多個事件名拆分為一個數(shù)組 // 一般使用空白字符指定多個事件名稱 events = events.split(eventSplitter); // calls記錄了當(dāng)前對象中已綁定的事件與回調(diào)函數(shù)列表 calls = this._callbacks || (this._callbacks = {});// 循環(huán)事件名列表, 從頭至尾依次將事件名存放至event變量 while (event = events.shift()) { // 獲取已經(jīng)綁定event事件的回調(diào)函數(shù) // list存儲單個事件名中綁定的callback回調(diào)函數(shù)列表 // 函數(shù)列表并沒有通過數(shù)組方式存儲, 而是通過多個對象的next屬性進(jìn)行依次關(guān)聯(lián) /** 數(shù)據(jù)格式如: * { * tail: {Object}, * next: { * callback: {Function}, * context: {Object}, * next: { * callback: {Function}, * context: {Object}, * next: {Object} * } * } * } */ // 列表每一層next對象存儲了一次回調(diào)事件相關(guān)信息(函數(shù)體, 上下文和下一次回調(diào)事件) // 事件列表最頂層存儲了一個tail對象, 它存儲了最后一次綁定回調(diào)事件的標(biāo)識(與最后一次回調(diào)事件的next指向同一個對象) // 通過tail標(biāo)識, 可以在遍歷回調(diào)列表時得知已經(jīng)到達(dá)最后一個回調(diào)函數(shù) list = calls[event]; // node變量用于記錄本次回調(diào)函數(shù)的相關(guān)信息 // tail只存儲最后一次綁定回調(diào)函數(shù)的標(biāo)識 // 因此如果之前已經(jīng)綁定過回調(diào)函數(shù), 則將之前的tail指定給node作為一個對象使用, 然后創(chuàng)建一個新的對象標(biāo)識給tail // 這里之所以要將本次回調(diào)事件添加到上一次回調(diào)的tail對象, 是為了讓回調(diào)函數(shù)列表的對象層次關(guān)系按照綁定順序排列(最新綁定的事件將被放到最底層) node = list ? list.tail : {}; node.next = tail = {}; // 記錄本次回調(diào)的函數(shù)體及上下文信息 node.context = context; node.callback = callback; // 重新組裝當(dāng)前事件的回調(diào)列表, 列表中已經(jīng)加入了本次回調(diào)事件 calls[event] = { tail: tail, next: list ? list.next : node }; } // 返回當(dāng)前對象, 方便進(jìn)行方法鏈調(diào)用 return this; }, // 移除對象中已綁定的事件或回調(diào)函數(shù), 可以通過events, callback和context對需要刪除的事件或回調(diào)函數(shù)進(jìn)行過濾 // - 如果context為空, 則移除所有的callback指定的函數(shù) // - 如果callback為空, 則移除事件中所有的回調(diào)函數(shù) // - 如果events為空, 但指定了callback或context, 則移除callback或context指定的回調(diào)函數(shù)(不區(qū)分事件名稱) // - 如果沒有傳遞任何參數(shù), 則移除對象中綁定的所有事件和回調(diào)函數(shù) off: function (events, callback, context) { var event, calls, node, tail, cb, ctx;// No events, or removing *all* events. // 當(dāng)前對象沒有綁定任何事件 if (!(calls = this._callbacks)) return; // 如果沒有指定任何參數(shù), 則移除所有事件和回調(diào)函數(shù)(刪除_callbacks屬性) if (!(events || callback || context)) { delete this._callbacks; return this; }// 解析需要移除的事件列表 // - 如果指定了events, 則按照eventSplitter對事件名進(jìn)行解析 // - 如果沒有指定events, 則解析已綁定所有事件的名稱列表 events = events ? events.split(eventSplitter) : _.keys(calls);// 循環(huán)事件名列表 while (event = events.shift()) { // 將當(dāng)前事件對象從列表中移除, 并緩存到node變量中 node = calls[event]; delete calls[event]; // 如果不存在當(dāng)前事件對象(或沒有指定移除過濾條件, 則認(rèn)為將移除當(dāng)前事件及所有回調(diào)函數(shù)), 則終止此次操作(事件對象在上一步已經(jīng)移除) if (!node || !(callback || context)) continue; // Create a new list, omitting the indicated callbacks. // 根據(jù)回調(diào)函數(shù)或上下文過濾條件, 組裝一個新的事件對象并重新綁定 tail = node.tail; // 遍歷事件中的所有回調(diào)對象 while ((node = node.next) !== tail) { cb = node.callback; ctx = node.context; // 根據(jù)參數(shù)中的回調(diào)函數(shù)和上下文, 對回調(diào)函數(shù)進(jìn)行過濾, 將不符合過濾條件的回調(diào)函數(shù)重新綁定到事件中(因為事件中的所有回調(diào)函數(shù)在上面已經(jīng)被移除) if ((callback && cb !== callback) || (context && ctx !== context)) { this.on(event, cb, ctx); } } }return this; }, // 觸發(fā)已經(jīng)定義的一個或多個事件, 依次執(zhí)行綁定的回調(diào)函數(shù)列表 trigger: function (events) { var event, node, calls, tail, args, all, rest; // 當(dāng)前對象沒有綁定任何事件 if (!(calls = this._callbacks)) return this; // 獲取回調(diào)函數(shù)列表中綁定的"all"事件列表 all = calls.all; // 將需要觸發(fā)的事件名稱, 按照eventSplitter規(guī)則解析為一個數(shù)組 events = events.split(eventSplitter); // 將trigger從第2個之后的參數(shù), 記錄到rest變量, 將依次傳遞給回調(diào)函數(shù) rest = slice.call(arguments, 1);// 循環(huán)需要觸發(fā)的事件列表 while (event = events.shift()) { // 此處的node變量記錄了當(dāng)前事件的所有回調(diào)函數(shù)列表 if (node = calls[event]) { // tail變量記錄最后一次綁定事件的對象標(biāo)識 tail = node.tail; // node變量的值, 按照事件的綁定順序, 被依次賦值為綁定的單個回調(diào)事件對象 // 最后一次綁定的事件next屬性, 與tail引用同一個對象, 以此作為是否到達(dá)列表末尾的判斷依據(jù) while ((node = node.next) !== tail) { // 執(zhí)行所有綁定的事件, 并將調(diào)用trigger時的參數(shù)傳遞給回調(diào)函數(shù) node.callback.apply(node.context || this, rest); } } // 變量all記錄了綁定時的"all"事件, 即在調(diào)用任何事件時, "all"事件中的回調(diào)函數(shù)均會被執(zhí)行 // - "all"事件中的回調(diào)函數(shù)無論綁定順序如何, 都會在當(dāng)前事件的回調(diào)函數(shù)列表全部執(zhí)行完畢后再依次執(zhí)行 // - "all"事件應(yīng)該在觸發(fā)普通事件時被自動調(diào)用, 如果強制觸發(fā)"all"事件, 事件中的回調(diào)函數(shù)將被執(zhí)行兩次 if (node = all) { tail = node.tail; // 與調(diào)用普通事件的回調(diào)函數(shù)不同之處在于, all事件會將當(dāng)前調(diào)用的事件名作為第一個參數(shù)傳遞給回調(diào)函數(shù) args = [event].concat(rest); // 遍歷并執(zhí)行"all"事件中的回調(diào)函數(shù)列表 while ((node = node.next) !== tail) { node.callback.apply(node.context || this, args); } } }return this; } };// 綁定事件與釋放事件的別名, 也為了同時兼容Backbone以前的版本 Events.bind = Events.on; Events.unbind = Events.off;// Backbone.Model 數(shù)據(jù)對象模型 // --------------// Model是Backbone中所有數(shù)據(jù)對象模型的基類, 用于創(chuàng)建一個數(shù)據(jù)模型 // @param {Object} attributes 指定創(chuàng)建模型時的初始化數(shù)據(jù) // @param {Object} options /** * @format options * { * parse: {Boolean}, * collection: {Collection} * } */ var Model = Backbone.Model = function (attributes, options) { // defaults變量用于存儲模型的默認(rèn)數(shù)據(jù) var defaults; // 如果沒有指定attributes參數(shù), 則設(shè)置attributes為空對象 attributes || (attributes = {}); // 設(shè)置attributes默認(rèn)數(shù)據(jù)的解析方法, 例如默認(rèn)數(shù)據(jù)是從服務(wù)器獲取(或原始數(shù)據(jù)是XML格式), 為了兼容set方法所需的數(shù)據(jù)格式, 可使用parse方法進(jìn)行解析 if (options && options.parse) attributes = this.parse(attributes); if (defaults = getValue(this, 'defaults')) { // 如果Model在定義時設(shè)置了defaults默認(rèn)數(shù)據(jù), 則初始化數(shù)據(jù)使用defaults與attributes參數(shù)合并后的數(shù)據(jù)(attributes中的數(shù)據(jù)會覆蓋defaults中的同名數(shù)據(jù)) attributes = _.extend({}, defaults, attributes); } // 顯式指定模型所屬的Collection對象(在調(diào)用Collection的add, push等將模型添加到集合中的方法時, 會自動設(shè)置模型所屬的Collection對象) if (options && options.collection) this.collection = options.collection; // attributes屬性存儲了當(dāng)前模型的JSON對象化數(shù)據(jù), 創(chuàng)建模型時默認(rèn)為空 this.attributes = {}; // 定義_escapedAttributes緩存對象, 它將緩存通過escape方法處理過的數(shù)據(jù) this._escapedAttributes = {}; // 為每一個模型配置一個唯一標(biāo)識 this.cid = _.uniqueId('c'); // 定義一系列用于記錄數(shù)據(jù)狀態(tài)的對象, 具體含義請參考對象定義時的注釋 this.changed = {}; this._silent = {}; this._pending = {}; // 創(chuàng)建實例時設(shè)置初始化數(shù)據(jù), 首次設(shè)置使用silent參數(shù), 不會觸發(fā)change事件 this.set(attributes, { silent: true }); // 上面已經(jīng)設(shè)置了初始化數(shù)據(jù), changed, _silent, _pending對象的狀態(tài)可能已經(jīng)發(fā)生變化, 這里重新進(jìn)行初始化 this.changed = {}; this._silent = {}; this._pending = {}; // _previousAttributes變量存儲模型數(shù)據(jù)的一個副本 // 用于在change事件中獲取模型數(shù)據(jù)被改變之前的狀態(tài), 可通過previous或previousAttributes方法獲取上一個狀態(tài)的數(shù)據(jù) this._previousAttributes = _.clone(this.attributes); // 調(diào)用initialize初始化方法 this.initialize.apply(this, arguments); }; // 使用extend方法為Model原型定義一系列屬性和方法 _.extend(Model.prototype, Events, {// changed屬性記錄了每次調(diào)用set方法時, 被改變數(shù)據(jù)的key集合 changed: null,// // 當(dāng)指定silent屬性時, 不會觸發(fā)change事件, 被改變的數(shù)據(jù)會記錄下來, 直到下一次觸發(fā)change事件 // _silent屬性用來記錄使用silent時的被改變的數(shù)據(jù) _silent: null,_pending: null,// 每個模型的唯一標(biāo)識屬性(默認(rèn)為"id", 通過修改idAttribute可自定義id屬性名) // 如果在設(shè)置數(shù)據(jù)時包含了id屬性, 則id將會覆蓋模型的id // id用于在Collection集合中查找和標(biāo)識模型, 與后臺接口通信時也會以id作為一條記錄的標(biāo)識 idAttribute: 'id',// 模型初始化方法, 在模型被構(gòu)造結(jié)束后自動調(diào)用 initialize: function () {}, // 返回當(dāng)前模型中數(shù)據(jù)的一個副本(JSON對象格式) toJSON: function (options) { return _.clone(this.attributes); }, // 根據(jù)attr屬性名, 獲取模型中的數(shù)據(jù)值 get: function (attr) { return this.attributes[attr]; }, // 根據(jù)attr屬性名, 獲取模型中的數(shù)據(jù)值, 數(shù)據(jù)值包含的HTML特殊字符將被轉(zhuǎn)換為HTML實體, 包含 & < > " ' \ // 通過 _.escape方法實現(xiàn) escape: function (attr) { var html; // 從_escapedAttributes緩存對象中查找數(shù)據(jù), 如果數(shù)據(jù)已經(jīng)被緩存則直接返回 if (html = this._escapedAttributes[attr]) return html; // _escapedAttributes緩存對象中沒有找到數(shù)據(jù) // 則先從模型中獲取數(shù)據(jù) var val = this.get(attr); // 將數(shù)據(jù)中的HTML使用 _.escape方法轉(zhuǎn)換為實體, 并緩存到_escapedAttributes對象, 便于下次直接獲取 return this._escapedAttributes[attr] = _.escape(val == null ? '' : '' + val); }, // 檢查模型中是否存在某個屬性, 當(dāng)該屬性的值被轉(zhuǎn)換為Boolean類型后值為false, 則認(rèn)為不存在 // 如果值為false, null, undefined, 0, NaN, 或空字符串時, 均會被轉(zhuǎn)換為false has: function (attr) { return this.get(attr) != null; }, // 設(shè)置模型中的數(shù)據(jù), 如果key值不存在, 則作為新的屬性添加到模型, 如果key值已經(jīng)存在, 則修改為新的值 set: function (key, value, options) { // attrs變量中記錄需要設(shè)置的數(shù)據(jù)對象 var attrs, attr, val;// 參數(shù)形式允許key-value對象形式, 或通過key, value兩個參數(shù)進(jìn)行單獨設(shè)置 // 如果key是一個對象, 則認(rèn)定為使用對象形式設(shè)置, 第二個參數(shù)將被視為options參數(shù) if (_.isObject(key) || key == null) { attrs = key; options = value; } else { // 通過key, value兩個參數(shù)單獨設(shè)置, 將數(shù)據(jù)放到attrs對象中方便統(tǒng)一處理 attrs = {}; attrs[key] = value; }// options配置項必須是一個對象, 如果沒有設(shè)置options則默認(rèn)值為一個空對象 options || (options = {}); // 沒有設(shè)置參數(shù)時不執(zhí)行任何動作 if (!attrs) return this; // 如果被設(shè)置的數(shù)據(jù)對象屬于Model類的一個實例, 則將Model對象的attributes數(shù)據(jù)對象賦給attrs // 一般在復(fù)制一個Model對象的數(shù)據(jù)到另一個Model對象時, 會執(zhí)行該動作 if (attrs instanceof Model) attrs = attrs.attributes; // 如果options配置對象中設(shè)置了unset屬性, 則將attrs數(shù)據(jù)對象中的所有屬性重置為undefined // 一般在復(fù)制一個Model對象的數(shù)據(jù)到另一個Model對象時, 但僅僅需要復(fù)制Model中的數(shù)據(jù)而不需要復(fù)制值時執(zhí)行該操作 if (options.unset) for (attr in attrs) attrs[attr] = void 0;// 對當(dāng)前數(shù)據(jù)進(jìn)行驗證, 如果驗證未通過則停止執(zhí)行 if (!this._validate(attrs, options)) return false;// 如果設(shè)置的id屬性名被包含在數(shù)據(jù)集合中, 則將id覆蓋到模型的id屬性 // 這是為了確保在自定義id屬性名后, 訪問模型的id屬性時, 也能正確訪問到id if (this.idAttribute in attrs) this.id = attrs[this.idAttribute];var changes = options.changes = {}; // now記錄當(dāng)前模型中的數(shù)據(jù)對象 var now = this.attributes; // escaped記錄當(dāng)前模型中通過escape緩存過的數(shù)據(jù) var escaped = this._escapedAttributes; // prev記錄模型中數(shù)據(jù)被改變之前的值 var prev = this._previousAttributes || {};// 遍歷需要設(shè)置的數(shù)據(jù)對象 for (attr in attrs) { // attr存儲當(dāng)前屬性名稱, val存儲當(dāng)前屬性的值 val = attrs[attr];// 如果當(dāng)前數(shù)據(jù)在模型中不存在, 或已經(jīng)發(fā)生變化, 或在options中指定了unset屬性刪除, 則刪除該數(shù)據(jù)被換存在_escapedAttributes中的數(shù)據(jù) if (!_.isEqual(now[attr], val) || (options.unset && _.has(now, attr))) { // 僅刪除通過escape緩存過的數(shù)據(jù), 這是為了保證緩存中的數(shù)據(jù)與模型中的真實數(shù)據(jù)保持同步 delete escaped[attr]; // 如果指定了silent屬性, 則此次set方法調(diào)用不會觸發(fā)change事件, 因此將被改變的數(shù)據(jù)記錄到_silent屬性中, 便于下一次觸發(fā)change事件時, 通知事件監(jiān)聽函數(shù)此數(shù)據(jù)已經(jīng)改變 // 如果沒有指定silent屬性, 則直接設(shè)置changes屬性中當(dāng)前數(shù)據(jù)為已改變狀態(tài) (options.silent ? this._silent : changes)[attr] = true; }// 如果在options中設(shè)置了unset, 則從模型中刪除該數(shù)據(jù)(包括key) // 如果沒有指定unset屬性, 則認(rèn)為將新增或修改數(shù)據(jù), 向模型的數(shù)據(jù)對象中加入新的數(shù)據(jù) options.unset ? delete now[attr] : now[attr] = val;// 如果模型中的數(shù)據(jù)與新的數(shù)據(jù)不一致, 則表示該數(shù)據(jù)已發(fā)生變化 if (!_.isEqual(prev[attr], val) || (_.has(now, attr) != _.has(prev, attr))) { // 在changed屬性中記錄當(dāng)前屬性已經(jīng)發(fā)生變化的狀態(tài) this.changed[attr] = val; if (!options.silent) this._pending[attr] = true; } else { // 如果數(shù)據(jù)沒有發(fā)生變化, 則從changed屬性中移除已變化狀態(tài) delete this.changed[attr]; delete this._pending[attr]; } }// 調(diào)用change方法, 將觸發(fā)change事件綁定的函數(shù) if (!options.silent) this.change(options); return this; }, // 從當(dāng)前模型中刪除指定的數(shù)據(jù)(屬性也將被同時刪除) unset: function (attr, options) { (options || (options = {})).unset = true; // 通過options.unset配置項告知set方法進(jìn)行刪除操作 return this.set(attr, null, options); }, // 清除當(dāng)前模型中的所有數(shù)據(jù)和屬性 clear: function (options) { (options || (options = {})).unset = true; // 克隆一個當(dāng)前模型的屬性副本, 并通過options.unset配置項告知set方法執(zhí)行刪除操作 return this.set(_.clone(this.attributes), options); }, // 從服務(wù)器獲取默認(rèn)的模型數(shù)據(jù), 獲取數(shù)據(jù)后使用set方法將數(shù)據(jù)填充到模型, 因此如果獲取到的數(shù)據(jù)與當(dāng)前模型中的數(shù)據(jù)不一致, 將會觸發(fā)change事件 fetch: function (options) { // 確保options是一個新的對象, 隨后將改變options中的屬性 options = options ? _.clone(options) : {}; var model = this; // 在options中可以指定獲取數(shù)據(jù)成功后的自定義回調(diào)函數(shù) var success = options.success; // 當(dāng)獲取數(shù)據(jù)成功后填充數(shù)據(jù)并調(diào)用自定義成功回調(diào)函數(shù) options.success = function (resp, status, xhr) { // 通過parse方法將服務(wù)器返回的數(shù)據(jù)進(jìn)行轉(zhuǎn)換 // 通過set方法將轉(zhuǎn)換后的數(shù)據(jù)填充到模型中, 因此可能會觸發(fā)change事件(當(dāng)數(shù)據(jù)發(fā)生變化時) // 如果填充數(shù)據(jù)時驗證失敗, 則不會調(diào)用自定義success回調(diào)函數(shù) if (!model.set(model.parse(resp, xhr), options)) return false; // 調(diào)用自定義的success回調(diào)函數(shù) if (success) success(model, resp); }; // 請求發(fā)生錯誤時通過wrapError處理error事件 options.error = Backbone.wrapError(options.error, model, options); // 調(diào)用sync方法從服務(wù)器獲取數(shù)據(jù) return (this.sync || Backbone.sync).call(this, 'read', this, options); }, // 保存模型中的數(shù)據(jù)到服務(wù)器 save: function (key, value, options) { // attrs存儲需要保存到服務(wù)器的數(shù)據(jù)對象 var attrs, current;// 支持設(shè)置單個屬性的方式 key: value // 支持對象形式的批量設(shè)置方式 {key: value} if (_.isObject(key) || key == null) { // 如果key是一個對象, 則認(rèn)為是通過對象方式設(shè)置 // 此時第二個參數(shù)被認(rèn)為是options attrs = key; options = value; } else { // 如果是通過key: value形式設(shè)置單個屬性, 則直接設(shè)置attrs attrs = {}; attrs[key] = value; } // 配置對象必須是一個新的對象 options = options ? _.clone(options) : {};// 如果在options中設(shè)置了wait選項, 則被改變的數(shù)據(jù)將會被提前驗證, 且服務(wù)器沒有響應(yīng)新數(shù)據(jù)(或響應(yīng)失敗)時, 本地數(shù)據(jù)會被還原為修改前的狀態(tài) // 如果沒有設(shè)置wait選項, 則無論服務(wù)器是否設(shè)置成功, 本地數(shù)據(jù)均會被修改為最新狀態(tài) if (options.wait) { // 對需要保存的數(shù)據(jù)提前進(jìn)行驗證 if (!this._validate(attrs, options)) return false; // 記錄當(dāng)前模型中的數(shù)據(jù), 用于在將數(shù)據(jù)發(fā)送到服務(wù)器后, 將數(shù)據(jù)進(jìn)行還原 // 如果服務(wù)器響應(yīng)失敗或沒有返回數(shù)據(jù), 則可以保持修改前的狀態(tài) current = _.clone(this.attributes); }// silentOptions在options對象中加入了silent(不對數(shù)據(jù)進(jìn)行驗證) // 當(dāng)使用wait參數(shù)時使用silentOptions配置項, 因為在上面已經(jīng)對數(shù)據(jù)進(jìn)行過驗證 // 如果沒有設(shè)置wait參數(shù), 則仍然使用原始的options配置項 var silentOptions = _.extend({}, options, { silent: true }); // 將修改過最新的數(shù)據(jù)保存到模型中, 便于在sync方法中獲取模型數(shù)據(jù)保存到服務(wù)器 if (attrs && !this.set(attrs, options.wait ? silentOptions : options)) { return false; }var model = this; // 在options中可以指定保存數(shù)據(jù)成功后的自定義回調(diào)函數(shù) var success = options.success; // 服務(wù)器響應(yīng)成功后執(zhí)行success options.success = function (resp, status, xhr) { // 獲取服務(wù)器響應(yīng)最新狀態(tài)的數(shù)據(jù) var serverAttrs = model.parse(resp, xhr); // 如果使用了wait參數(shù), 則優(yōu)先將修改后的數(shù)據(jù)狀態(tài)直接設(shè)置到模型 if (options.wait) { delete options.wait; serverAttrs = _.extend(attrs || {}, serverAttrs); } // 將最新的數(shù)據(jù)狀態(tài)設(shè)置到模型中 // 如果調(diào)用set方法時驗證失敗, 則不會調(diào)用自定義的success回調(diào)函數(shù) if (!model.set(serverAttrs, options)) return false; if (success) { // 調(diào)用響應(yīng)成功后自定義的success回調(diào)函數(shù) success(model, resp); } else { // 如果沒有指定自定義回調(diào), 則默認(rèn)觸發(fā)sync事件 model.trigger('sync', model, resp, options); } }; // 請求發(fā)生錯誤時通過wrapError處理error事件 options.error = Backbone.wrapError(options.error, model, options); // 將模型中的數(shù)據(jù)保存到服務(wù)器 // 如果當(dāng)前模型是一個新建的模型(沒有id), 則使用create方法(新增), 否則認(rèn)為是update方法(修改) var method = this.isNew() ? 'create' : 'update'; var xhr = (this.sync || Backbone.sync).call(this, method, this, options); // 如果設(shè)置了options.wait, 則將數(shù)據(jù)還原為修改前的狀態(tài) // 此時保存的請求還沒有得到響應(yīng), 因此如果響應(yīng)失敗, 模型中將保持修改前的狀態(tài), 如果服務(wù)器響應(yīng)成功, 則會在success中設(shè)置模型中的數(shù)據(jù)為最新狀態(tài) if (options.wait) this.set(current, silentOptions); return xhr; }, // 刪除模型, 模型將同時從所屬的Collection集合中被刪除 // 如果模型是在客戶端新建的, 則直接從客戶端刪除 // 如果模型數(shù)據(jù)同時存在服務(wù)器, 則同時會刪除服務(wù)器端的數(shù)據(jù) destroy: function (options) { // 配置項必須是一個新的對象 options = options ? _.clone(options) : {}; var model = this; // 在options中可以指定刪除數(shù)據(jù)成功后的自定義回調(diào)函數(shù) var success = options.success; // 刪除數(shù)據(jù)成功調(diào)用, 觸發(fā)destroy事件, 如果模型存在于Collection集合中, 集合將監(jiān)聽destroy事件并在觸發(fā)時從集合中移除該模型 // 刪除模型時, 模型中的數(shù)據(jù)并沒有被清空, 但模型已經(jīng)從集合中移除, 因此當(dāng)沒有任何地方引用該模型時, 會被自動從內(nèi)存中釋放 // 建議在刪除模型時, 將模型對象的引用變量設(shè)置為null var triggerDestroy = function () { model.trigger('destroy', model, model.collection, options); }; // 如果該模型是一個客戶端新建的模型, 則直接調(diào)用triggerDestroy從集合中將模型移除 if (this.isNew()) { triggerDestroy(); return false; }// 當(dāng)從服務(wù)器刪除數(shù)據(jù)成功時 options.success = function (resp) { // 如果在options對象中配置wait項, 則表示本地內(nèi)存中的模型數(shù)據(jù), 會在服務(wù)器數(shù)據(jù)被刪除成功后再刪除 // 如果服務(wù)器響應(yīng)失敗, 則本地數(shù)據(jù)不會被刪除 if (options.wait) triggerDestroy(); if (success) { // 調(diào)用自定義的成功回調(diào)函數(shù) success(model, resp); } else { // 如果沒有自定義回調(diào), 則默認(rèn)觸發(fā)sync事件 model.trigger('sync', model, resp, options); } }; // 請求發(fā)生錯誤時通過wrapError處理error事件 options.error = Backbone.wrapError(options.error, model, options); // 通過sync方法發(fā)送刪除數(shù)據(jù)的請求 var xhr = (this.sync || Backbone.sync).call(this, 'delete', this, options); // 如果沒有在options對象中配置wait項, 則會先刪除本地數(shù)據(jù), 再發(fā)送請求刪除服務(wù)器數(shù)據(jù) // 此時無論服務(wù)器刪除是否成功, 本地模型數(shù)據(jù)已被刪除 if (!options.wait) triggerDestroy(); return xhr; }, // 獲取模型在服務(wù)器接口中對應(yīng)的url, 在調(diào)用save, fetch, destroy等與服務(wù)器交互的方法時, 將使用該方法獲取url // 生成的url類似于"PATHINFO"模式, 服務(wù)器對模型的操作只有一個url, 對于修改和刪除操作會在url后追加模型id便于標(biāo)識 // 如果在模型中定義了urlRoot, 服務(wù)器接口應(yīng)為[urlRoot/id]形式 // 如果模型所屬的Collection集合定義了url方法或?qū)傩? 則使用集合中的url形式: [collection.url/id] // 在訪問服務(wù)器url時會在url后面追加上模型的id, 便于服務(wù)器標(biāo)識一條記錄, 因此模型中的id需要與服務(wù)器記錄對應(yīng) // 如果無法獲取模型或集合的url, 將調(diào)用urlError方法拋出一個異常 // 如果服務(wù)器接口并沒有按照"PATHINFO"方式進(jìn)行組織, 可以通過重載url方法實現(xiàn)與服務(wù)器的無縫交互 url: function () { // 定義服務(wù)器對應(yīng)的url路徑 var base = getValue(this, 'urlRoot') || getValue(this.collection, 'url') || urlError(); // 如果當(dāng)前模型是客戶端新建的模型, 則不存在id屬性, 服務(wù)器url直接使用base if (this.isNew()) return base; // 如果當(dāng)前模型具有id屬性, 可能是調(diào)用了save或destroy方法, 將在base后面追加模型的id // 下面將判斷base最后一個字符是否是"/", 生成的url格式為[base/id] return base + (base.charAt(base.length - 1) == '/' ? '' : '/') + encodeURIComponent(this.id); }, // parse方法用于解析從服務(wù)器獲取的數(shù)據(jù), 返回一個能夠被set方法解析的模型數(shù)據(jù) // 一般parse方法會根據(jù)服務(wù)器返回的數(shù)據(jù)進(jìn)行重載, 以便構(gòu)建與服務(wù)器的無縫連接 // 當(dāng)服務(wù)器返回的數(shù)據(jù)結(jié)構(gòu)與set方法所需的數(shù)據(jù)結(jié)構(gòu)不一致(例如服務(wù)器返回XML格式數(shù)據(jù)時), 可使用parse方法進(jìn)行轉(zhuǎn)換 parse: function (resp, xhr) { return resp; }, // 創(chuàng)建一個新的模型, 它具有和當(dāng)前模型相同的數(shù)據(jù) clone: function () { return new this.constructor(this.attributes); }, // 檢查當(dāng)前模型是否是客戶端創(chuàng)建的新模型 // 檢查方式是根據(jù)模型是否存在id標(biāo)識, 客戶端創(chuàng)建的新模型沒有id標(biāo)識 // 因此服務(wù)器響應(yīng)的模型數(shù)據(jù)中必須包含id標(biāo)識, 標(biāo)識的屬性名默認(rèn)為"id", 也可以通過修改idAttribute屬性自定義標(biāo)識 isNew: function () { return this.id == null; }, // 數(shù)據(jù)被更新時觸發(fā)change事件綁定的函數(shù) // 當(dāng)set方法被調(diào)用, 會自動調(diào)用change方法, 如果在set方法被調(diào)用時指定了silent配置, 則需要手動調(diào)用change方法 change: function (options) { // options必須是一個對象 options || (options = {}); // this._changing相關(guān)的邏輯有些問題 // this._changing在方法最后被設(shè)置為false, 因此方法上面changing變量的值始終為false(第一次為undefined) // 作者的初衷應(yīng)該是想用該變量標(biāo)示change方法是否執(zhí)行完畢, 對于瀏覽器端單線程的腳本來說沒有意義, 因為該方法被執(zhí)行時會阻塞其它腳本 // changing獲取上一次執(zhí)行的狀態(tài), 如果上一次腳本沒有執(zhí)行完畢, 則值為true var changing = this._changing; // 開始執(zhí)行標(biāo)識, 執(zhí)行過程中值始終為true, 執(zhí)行完畢后this._changing被修改為false this._changing = true;// 將非本次改變的數(shù)據(jù)狀態(tài)添加到_pending對象中 for (var attr in this._silent) this._pending[attr] = true;// changes對象包含了當(dāng)前數(shù)據(jù)上一次執(zhí)行change事件至今, 已被改變的所有數(shù)據(jù) // 如果之前使用silent未觸發(fā)change事件, 則本次會被放到changes對象中 var changes = _.extend({}, options.changes, this._silent); // 重置_silent對象 this._silent = {}; // 遍歷changes對象, 分別針對每一個屬性觸發(fā)單獨的change事件 for (var attr in changes) { // 將Model對象, 屬性值, 配置項作為參數(shù)以此傳遞給事件的監(jiān)聽函數(shù) this.trigger('change:' + attr, this, this.get(attr), options); }// 如果方法處于執(zhí)行中, 則停止執(zhí)行 if (changing) return this;// 觸發(fā)change事件, 任意數(shù)據(jù)被改變后, 都會依次觸發(fā)"change:屬性"事件和"change"事件 while (!_.isEmpty(this._pending)) { this._pending = {}; // 觸發(fā)change事件, 并將Model實例和配置項作為參數(shù)傳遞給監(jiān)聽函數(shù) this.trigger('change', this, options); // 遍歷changed對象中的數(shù)據(jù), 并依次將已改變數(shù)據(jù)的狀態(tài)從changed中移除 // 在此之后如果調(diào)用hasChanged檢查數(shù)據(jù)狀態(tài), 將得到false(未改變) for (var attr in this.changed) { if (this._pending[attr] || this._silent[attr]) continue; // 移除changed中數(shù)據(jù)的狀態(tài) delete this.changed[attr]; } // change事件執(zhí)行完畢, _previousAttributes屬性將記錄當(dāng)前模型最新的數(shù)據(jù)副本 // 因此如果需要獲取數(shù)據(jù)的上一個狀態(tài), 一般只通過在觸發(fā)的change事件中通過previous或previousAttributes方法獲取 this._previousAttributes = _.clone(this.attributes); }// 執(zhí)行完畢標(biāo)識 this._changing = false; return this; }, // 檢查某個數(shù)據(jù)是否在上一次執(zhí)行change事件后被改變過 /** * 一般在change事件中配合previous或previousAttributes方法使用, 如: * if(model.hasChanged('attr')) { * var attrPrev = model.previous('attr'); * } */ hasChanged: function (attr) { if (!arguments.length) return !_.isEmpty(this.changed); return _.has(this.changed, attr); }, // 獲取當(dāng)前模型中的數(shù)據(jù)與上一次數(shù)據(jù)中已經(jīng)發(fā)生變化的數(shù)據(jù)集合 // (一般在使用silent屬性時沒有調(diào)用change方法, 因此數(shù)據(jù)會被臨時抱存在changed屬性中, 上一次的數(shù)據(jù)可通過previousAttributes方法獲取) // 如果傳遞了diff集合, 將使用上一次模型數(shù)據(jù)與diff集合中的數(shù)據(jù)進(jìn)行比較, 返回不一致的數(shù)據(jù)集合 // 如果比較結(jié)果中沒有差異, 則返回false changedAttributes: function (diff) { // 如果沒有指定diff, 將返回當(dāng)前模型較上一次狀態(tài)已改變的數(shù)據(jù)集合, 這些數(shù)據(jù)已經(jīng)被存在changed屬性中, 因此返回changed集合的一個副本 if (!diff) return this.hasChanged() ? _.clone(this.changed) : false; // 指定了需要進(jìn)行比較的diff集合, 將返回上一次的數(shù)據(jù)與diff集合的比較結(jié)果 // old變量存儲了上一個狀態(tài)的模型數(shù)據(jù) var val, changed = false, old = this._previousAttributes; // 遍歷diff集合, 并將每一項與上一個狀態(tài)的集合進(jìn)行比較 for (var attr in diff) { // 將比較結(jié)果不一致的數(shù)據(jù)臨時存儲到changed變量 if (_.isEqual(old[attr], (val = diff[attr]))) continue; (changed || (changed = {}))[attr] = val; } // 返回比較結(jié)果 return changed; }, // 在模型觸發(fā)的change事件中, 獲取某個屬性被改變前上一個狀態(tài)的數(shù)據(jù), 一般用于進(jìn)行數(shù)據(jù)比較或回滾 // 該方法一般在change事件中調(diào)用, change事件被觸發(fā)后, _previousAttributes屬性存放最新的數(shù)據(jù) previous: function (attr) { // attr指定需要獲取上一個狀態(tài)的屬性名稱 if (!arguments.length || !this._previousAttributes) return null; return this._previousAttributes[attr]; }, // 在模型觸發(fā)change事件中, 獲取所有屬性上一個狀態(tài)的數(shù)據(jù)集合 // 該方法類似于previous()方法, 一般在change事件中調(diào)用, 用于數(shù)據(jù)比較或回滾 previousAttributes: function () { // 將上一個狀態(tài)的數(shù)據(jù)對象克隆為一個新對象并返回 return _.clone(this._previousAttributes); }, // Check if the model is currently in a valid state. It's only possible to // get into an *invalid* state if you're using silent changes. // 驗證當(dāng)前模型中的數(shù)據(jù)是否能通過validate方法驗證, 調(diào)用前請確保定義了validate方法 isValid: function () { return !this.validate(this.attributes); }, // 數(shù)據(jù)驗證方法, 在調(diào)用set, save, add等數(shù)據(jù)更新方法時, 被自動執(zhí)行 // 驗證失敗會觸發(fā)模型對象的"error"事件, 如果在options中指定了error處理函數(shù), 則只會執(zhí)行options.error函數(shù) // @param {Object} attrs 數(shù)據(jù)模型的attributes屬性, 存儲模型的對象化數(shù)據(jù) // @param {Object} options 配置項 // @return {Boolean} 驗證通過返回true, 不通過返回false _validate: function (attrs, options) { // 如果在調(diào)用set, save, add等數(shù)據(jù)更新方法時設(shè)置了options.silent屬性, 則忽略驗證 // 如果Model中沒有添加validate方法, 則忽略驗證 if (options.silent || !this.validate) return true; // 獲取對象中所有的屬性值, 并放入validate方法中進(jìn)行驗證 // validate方法包含2個參數(shù), 分別為模型中的數(shù)據(jù)集合與配置對象, 如果驗證通過則不返回任何數(shù)據(jù)(默認(rèn)為undefined), 驗證失敗則返回帶有錯誤信息數(shù)據(jù) attrs = _.extend({}, this.attributes, attrs); var error = this.validate(attrs, options); // 驗證通過 if (!error) return true; // 驗證未通過 // 如果配置對象中設(shè)置了error錯誤處理方法, 則調(diào)用該方法并將錯誤數(shù)據(jù)和配置對象傳遞給該方法 if (options && options.error) { options.error(this, error, options); } else { // 如果對模型綁定了error事件監(jiān)聽, 則觸發(fā)綁定事件 this.trigger('error', this, error, options); } // 返回驗證未通過標(biāo)識 return false; } });// Backbone.Collection 數(shù)據(jù)模型集合相關(guān) // -------------------// Collection集合存儲一系列相同類的數(shù)據(jù)模型, 并提供相關(guān)方法對模型進(jìn)行操作 var Collection = Backbone.Collection = function (models, options) { // 配置對象 options || (options = {}); // 在配置參數(shù)中設(shè)置集合的模型類 if (options.model) this.model = options.model; // 如果設(shè)置了comparator屬性, 則集合中的數(shù)據(jù)將按照comparator方法中的排序算法進(jìn)行排序(在add方法中會自動調(diào)用) if (options.comparator) this.comparator = options.comparator; // 實例化時重置集合的內(nèi)部狀態(tài)(第一次調(diào)用時可理解為定義狀態(tài)) this._reset(); // 調(diào)用自定義初始化方法, 如果需要一般會重載initialize方法 this.initialize.apply(this, arguments); // 如果指定了models數(shù)據(jù), 則調(diào)用reset方法將數(shù)據(jù)添加到集合中 // 首次調(diào)用時設(shè)置了silent參數(shù), 因此不會觸發(fā)"reset"事件 if (models) this.reset(models, { silent: true, parse: options.parse }); }; // 通過extend方法定義集合類原型方法 _.extend(Collection.prototype, Events, {// 定義集合的模型類, 模型類必須是一個Backbone.Model的子類 // 在使用集合相關(guān)方法(如add, create等)時, 允許傳入數(shù)據(jù)對象, 集合方法會根據(jù)定義的模型類自動創(chuàng)建對應(yīng)的實例 // 集合中存儲的數(shù)據(jù)模型應(yīng)該都是同一個模型類的實例 model: Model,// 初始化方法, 該方法在集合實例被創(chuàng)建后自動調(diào)用 // 一般會在定義集合類時重載該方法 initialize: function () {}, // 返回一個數(shù)組, 包含了集合中每個模型的數(shù)據(jù)對象 toJSON: function (options) { // 通過Undersocre的map方法將集合中每一個模型的toJSON結(jié)果組成一個數(shù)組, 并返回 return this.map(function (model) { // 依次調(diào)用每個模型對象的toJSON方法, 該方法默認(rèn)將返回模型的數(shù)據(jù)對象(復(fù)制的副本) // 如果需要返回字符串等其它形式, 可以重載toJSON方法 return model.toJSON(options); }); }, // 向集合中添加一個或多個模型對象 // 默認(rèn)會觸發(fā)"add"事件, 如果在options中設(shè)置了silent屬性, 可以關(guān)閉此次事件觸發(fā) // 傳入的models可以是一個或一系列的模型對象(Model類的實例), 如果在集合中設(shè)置了model屬性, 則允許直接傳入數(shù)據(jù)對象(如 {name: 'test'}), 將自動將數(shù)據(jù)對象實例化為model指向的模型對象 add: function (models, options) { // 局部變量定義 var i, index, length, model, cid, id, cids = {}, ids = {}, dups = []; options || (options = {}); // models必須是一個數(shù)組, 如果只傳入了一個模型, 則將其轉(zhuǎn)換為數(shù)組 models = _.isArray(models) ? models.slice() : [models];// 遍歷需要添加的模型列表, 遍歷過程中, 將執(zhí)行以下操作: // - 將數(shù)據(jù)對象轉(zhuǎn)化模型對象 // - 建立模型與集合之間的引用 // - 記錄無效和重復(fù)的模型, 并在后面進(jìn)行過濾 for (i = 0, length = models.length; i < length; i++) { // 將數(shù)據(jù)對象轉(zhuǎn)換為模型對象, 簡歷模型與集合的引用, 并存儲到model(同時models中對應(yīng)的模型已經(jīng)被替換為模型對象) if (!(model = models[i] = this._prepareModel(models[i], options))) { throw new Error("Can't add an invalid model to a collection"); } // 當(dāng)前模型的cid和id cid = model.cid; id = model.id; // dups數(shù)組中記錄了無效或重復(fù)的模型索引(models數(shù)組中的索引), 并在下一步進(jìn)行過濾刪除 // 如果cids, ids變量中已經(jīng)存在了該模型的索引, 則認(rèn)為是同一個模型在傳入的models數(shù)組中聲明了多次 // 如果_byCid, _byId對象中已經(jīng)存在了該模型的索引, 則認(rèn)為同一個模型在當(dāng)前集合中已經(jīng)存在 // 對于上述兩種情況, 將模型的索引記錄到dups進(jìn)行過濾刪除 if (cids[cid] || this._byCid[cid] || ((id != null) && (ids[id] || this._byId[id]))) { dups.push(i); continue; } // 將models中已經(jīng)遍歷過的模型記錄下來, 用于在下一次循環(huán)時進(jìn)行重復(fù)檢查 cids[cid] = ids[id] = model; }// 從models中刪除無效或重復(fù)的模型, 保留目前集合中真正需要添加的模型列表 i = dups.length; while (i--) { models.splice(dups[i], 1); }// 遍歷需要添加的模型, 監(jiān)聽模型事件并記錄_byCid, _byId列表, 用于在調(diào)用get和getByCid方法時作為索引 for (i = 0, length = models.length; i < length; i++) { // 監(jiān)聽模型中的所有事件, 并執(zhí)行_onModelEvent方法 // _onModelEvent方法中會對模型拋出的add, remove, destroy和change事件進(jìn)行處理, 以便模型與集合中的狀態(tài)保持同步 (model = models[i]).on('all', this._onModelEvent, this); // 將模型根據(jù)cid記錄到_byCid對象, 便于根據(jù)cid進(jìn)行查找 this._byCid[model.cid] = model; // 將模型根據(jù)id記錄到_byId對象, 便于根據(jù)id進(jìn)行查找 if (model.id != null) this._byId[model.id] = model; }// 改變集合的length屬性, length屬性記錄了當(dāng)前集合中模型的數(shù)量 this.length += length; // 設(shè)置新模型列表插入到集合中的位置, 如果在options中設(shè)置了at參數(shù), 則在集合的at位置插入 // 默認(rèn)將插入到集合的末尾 // 如果設(shè)置了comparator自定義排序方法, 則設(shè)置at后還將按照comparator中的方法進(jìn)行排序, 因此最終的順序可能并非在at指定的位置 index = options.at != null ? options.at : this.models.length; splice.apply(this.models, [index, 0].concat(models)); // 如果設(shè)置了comparator方法, 則將數(shù)據(jù)按照comparator中的算法進(jìn)行排序 // 自動排序使用silent屬性阻止觸發(fā)reset事件 if (this.comparator) this.sort({ silent: true }); // 依次對每個模型對象觸發(fā)"add"事件, 如果設(shè)置了silent屬性, 則阻止事件觸發(fā) if (options.silent) return this; // 遍歷新增加的模型列表 for (i = 0, length = this.models.length; i < length; i++) { if (!cids[(model = this.models[i]).cid]) continue; options.index = i; // 觸發(fā)模型的"add"事件, 因為集合監(jiān)聽了模型的"all"事件, 因此在_onModelEvent方法中, 集合也將觸發(fā)"add"事件 // 詳細(xì)信息可參考Collection.prototype._onModelEvent方法 model.trigger('add', model, this, options); } return this; }, // 從集合中移除模型對象(支持移除多個模型) // 傳入的models可以是需要移除的模型對象, 或模型的cid和模型的id // 移除模型并不會調(diào)用模型的destroy方法 // 如果沒有設(shè)置options.silent參數(shù), 將觸發(fā)模型的remove事件, 同時將觸發(fā)集合的remove事件(集合通過_onModelEvent方法監(jiān)聽了模型的所有事件) remove: function (models, options) { var i, l, index, model; // options默認(rèn)為空對象 options || (options = {}); // models必須是數(shù)組類型, 當(dāng)只移除一個模型時, 將其放入一個數(shù)組 models = _.isArray(models) ? models.slice() : [models]; // 遍歷需要移除的模型列表 for (i = 0, l = models.length; i < l; i++) { // 所傳入的models列表中可以是需要移除的模型對象, 或模型的cid和模型的id // (在getByCid和get方法中, 可通過cid, id來獲取模型, 如果傳入的是一個模型對象, 則返回模型本身) model = this.getByCid(models[i]) || this.get(models[i]); // 沒有獲取到模型 if (!model) continue; // 從_byId列表中移除模型的id引用 delete this._byId[model.id]; // 從_byCid列表中移除模型的cid引用 delete this._byCid[model.cid]; // indexOf是Underscore對象中的方法, 這里通過indexOf方法獲取模型在集合中首次出現(xiàn)的位置 index = this.indexOf(model); // 從集合列表中移除該模型 this.models.splice(index, 1); // 重置當(dāng)前集合的length屬性(記錄集合中模型的數(shù)量) this.length--; // 如果沒有設(shè)置silent屬性, 則觸發(fā)模型的remove事件 if (!options.silent) { // 將當(dāng)前模型在集合中的位置添加到options對象并傳遞給remove監(jiān)聽事件, 以便在事件函數(shù)中可以使用 options.index = index; model.trigger('remove', model, this, options); } // 解除模型與集合的關(guān)系, 包括集合中對模型的引用和事件監(jiān)聽 this._removeReference(model); } return this; }, // 向集合的末尾添加模型對象 // 如果集合類中定義了comparator排序方法, 則通過push方法添加的模型將按照comparator定義的算法進(jìn)行排序, 因此模型順序可能會被改變 push: function (model, options) { // 通過_prepareModel方法將model實例化為模型對象, 這句代碼是多余的, 因為在下面調(diào)用的add方法中還會通過_prepareModel獲取一次模型 model = this._prepareModel(model, options); // 調(diào)用add方法將模型添加到集合中(默認(rèn)添加到集合末尾) this.add(model, options); return model; }, // 移除集合中最后一個模型對象 pop: function (options) { // 獲取集合中最后一個模型 var model = this.at(this.length - 1); // 通過remove方法移除該模型 this.remove(model, options); return model; }, // 向集合的第一個位置插入模型 // 如果集合類中定義了comparator排序方法, 則通過unshift方法添加的模型將按照comparator定義的算法進(jìn)行排序, 因此模型順序可能會被改變 unshift: function (model, options) { // 通過_prepareModel方法將model實例化為模型對象 model = this._prepareModel(model, options); // 調(diào)用add方法將模型插入到集合的第一個位置(設(shè)置at為0) // 如果定義了comparator排序方法, 集合的順序?qū)⒈恢嘏?/span> this.add(model, _.extend({ at: 0 }, options)); return model; }, // 移除并返回集合中的第一個模型對象 shift: function (options) { // 獲得集合中的第一個模型 var model = this.at(0); // 從集合中刪除該模型 this.remove(model, options); // 返回模型對象 return model; }, // 根據(jù)id從集合中查找模型并返回 get: function (id) { if (id == null) return void 0; return this._byId[id.id != null ? id.id : id]; }, // 根據(jù)cid從集合中查找模型并返回 getByCid: function (cid) { return cid && this._byCid[cid.cid || cid]; }, // 根據(jù)索引(下標(biāo), 從0開始)從集合中查找模型并返回 at: function (index) { return this.models[index]; }, // 對集合中的模型根據(jù)值進(jìn)行篩選 // attrs是一個篩選對象, 如 {name: 'Jack'}, 將返回集合中所有name為"Jack"的模型(數(shù)組) where: function (attrs) { // attrs不能為空值 if (_.isEmpty(attrs)) return []; // 通過filter方法對集合中的模型進(jìn)行篩選 // filter方法是Underscore中的方法, 用于將遍歷集合中的元素, 并將能通過處理器驗證(返回值為true)的元素作為數(shù)組返回 return this.filter(function (model) { // 遍歷attrs對象中的驗證規(guī)則 for (var key in attrs) { // 將attrs中的驗證規(guī)則與集合中的模型進(jìn)行匹配 if (attrs[key] !== model.get(key)) return false; } return true; }); }, // 對集合中的模型按照comparator屬性指定的方法進(jìn)行排序 // 如果沒有在options中設(shè)置silent參數(shù), 則排序后將觸發(fā)reset事件 sort: function (options) { // options默認(rèn)是一個對象 options || (options = {}); // 調(diào)用sort方法必須指定了comparator屬性(排序算法方法), 否則將拋出一個錯誤 if (!this.comparator) throw new Error('Cannot sort a set without a comparator'); // boundComparator存儲了綁定當(dāng)前集合上下文對象的comparator排序算法方法 var boundComparator = _.bind(this.comparator, this); if (this.comparator.length == 1) { this.models = this.sortBy(boundComparator); } else { // 調(diào)用Array.prototype.sort通過comparator算法對數(shù)據(jù)進(jìn)行自定義排序 this.models.sort(boundComparator); } // 如果沒有指定silent參數(shù), 則觸發(fā)reset事件 if (!options.silent) this.trigger('reset', this, options); return this; }, // 將集合中所有模型的attr屬性值存放到一個數(shù)組并返回 pluck: function (attr) { // map是Underscore中的方法, 用于遍歷一個集合, 并將所有處理器的返回值作為一個數(shù)組返回 return _.map(this.models, function (model) { // 返回當(dāng)前模型的attr屬性值 return model.get(attr); }); }, // 替換集合中的所有模型數(shù)據(jù)(models) // 該操作將刪除集合中當(dāng)前的所有數(shù)據(jù)和狀態(tài), 并重新將數(shù)據(jù)設(shè)置為models // models應(yīng)該是一個數(shù)組, 可以包含一系列Model模型對象, 或原始對象(將在add方法中自動創(chuàng)建為模型對象) reset: function (models, options) { // models是進(jìn)行替換的模型(或數(shù)據(jù))數(shù)組 models || (models = []); // options默認(rèn)是一個空對象 options || (options = {}); // 遍歷當(dāng)前集合中的模型, 依次刪除并解除它們與集合的引用關(guān)系 for (var i = 0, l = this.models.length; i < l; i++) { this._removeReference(this.models[i]); } // 刪除集合數(shù)據(jù)并重置狀態(tài) this._reset(); // 通過add方法將新的模型數(shù)據(jù)添加到集合 // 這里通過exnted方法將配置項覆蓋到一個新的對象, 該對象默認(rèn)silent為true, 因此不會觸發(fā)"add"事件 // 如果在調(diào)用reset方法時沒有設(shè)置silent屬性則會觸發(fā)reset事件, 如果設(shè)置為true則不會觸發(fā)任何事件, 如果設(shè)置為false, 將依次觸發(fā)"add"和"reset"事件 this.add(models, _.extend({ silent: true }, options)); // 如果在調(diào)用reset方法時沒有設(shè)置silent屬性, 則觸發(fā)reset事件 if (!options.silent) this.trigger('reset', this, options); return this; }, // 從服務(wù)器獲取集合的初始化數(shù)據(jù) // 如果在options中設(shè)置參數(shù)add=true, 則獲取到的數(shù)據(jù)會被追加到集合中, 否則將以服務(wù)器返回的數(shù)據(jù)替換集合中的當(dāng)前數(shù)據(jù) fetch: function (options) { // 復(fù)制options對象, 因為options對象在后面會被修改用于臨時存儲數(shù)據(jù) options = options ? _.clone(options) : {}; if (options.parse === undefined) options.parse = true; // collection記錄當(dāng)前集合對象, 用于在success回調(diào)函數(shù)中使用 var collection = this; // 自定義回調(diào)函數(shù), 數(shù)據(jù)請求成功后并添加完成后, 會調(diào)用自定義success函數(shù) var success = options.success; // 當(dāng)從服務(wù)器請求數(shù)據(jù)成功時執(zhí)行options.success, 該函數(shù)中將解析并添加數(shù)據(jù) options.success = function (resp, status, xhr) { // 通過parse方法對服務(wù)器返回的數(shù)據(jù)進(jìn)行解析, 如果需要自定義數(shù)據(jù)結(jié)構(gòu), 可以重載parse方法 // 如果在options中設(shè)置add=true, 則調(diào)用add方法將數(shù)據(jù)添加到集合, 否則將通過reset方法將集合中的數(shù)據(jù)替換為服務(wù)器的返回數(shù)據(jù) collection[options.add ? 'add' : 'reset'](collection.parse(resp, xhr), options); // 如果設(shè)置了自定義成功回調(diào), 則執(zhí)行 if (success) success(collection, resp); }; // 當(dāng)服務(wù)器返回狀態(tài)錯誤時, 通過wrapError方法處理錯誤事件 options.error = Backbone.wrapError(options.error, collection, options); // 調(diào)用Backbone.sync方法發(fā)送請求從服務(wù)器獲取數(shù)據(jù) // 如果需要的數(shù)據(jù)并不是從服務(wù)器獲取, 或獲取方式不使用AJAX, 可以重載Backbone.sync方法 return (this.sync || Backbone.sync).call(this, 'read', this, options); }, // 向集合中添加并創(chuàng)建一個模型, 同時將該模型保存到服務(wù)器 // 如果是通過數(shù)據(jù)對象來創(chuàng)建模型, 需要在集合中聲明model屬性對應(yīng)的模型類 // 如果在options中聲明了wait屬性, 則會在服務(wù)器創(chuàng)建成功后再將模型添加到集合, 否則先將模型添加到集合, 再保存到服務(wù)器(無論保存是否成功) create: function (model, options) { var coll = this; // 定義options對象 options = options ? _.clone(options) : {}; // 通過_prepareModel獲取模型類的實例 model = this._prepareModel(model, options); // 模型創(chuàng)建失敗 if (!model) return false; // 如果沒有聲明wait屬性, 則通過add方法將模型添加到集合中 if (!options.wait) coll.add(model, options); // success存儲保存到服務(wù)器成功之后的自定義回調(diào)函數(shù)(通過options.success聲明) var success = options.success; // 監(jiān)聽模型數(shù)據(jù)保存成功后的回調(diào)函數(shù) options.success = function (nextModel, resp, xhr) { // 如果聲明了wait屬性, 則在只有在服務(wù)器保存成功后才會將模型添加到集合中 if (options.wait) coll.add(nextModel, options); // 如果聲明了自定義成功回調(diào), 則執(zhí)行自定義函數(shù), 否則將默認(rèn)觸發(fā)模型的sync事件 if (success) { success(nextModel, resp); } else { nextModel.trigger('sync', model, resp, options); } }; // 調(diào)用模型的save方法, 將模型數(shù)據(jù)保存到服務(wù)器 model.save(null, options); return model; }, // 數(shù)據(jù)解析方法, 用于將服務(wù)器數(shù)據(jù)解析為模型和集合可用的結(jié)構(gòu)化數(shù)據(jù) // 默認(rèn)將返回resp本身, 這需要與服務(wù)器定義Backbone支持的數(shù)據(jù)格式, 如果需要自定義數(shù)據(jù)格式, 可以重載parse方法 parse: function (resp, xhr) { return resp; }, // chain用于構(gòu)建集合數(shù)據(jù)的鏈?zhǔn)讲僮? 它將集合中的數(shù)據(jù)轉(zhuǎn)換為一個Underscore對象, 并使用Underscore的chain方法轉(zhuǎn)換為鏈?zhǔn)浇Y(jié)構(gòu) // 關(guān)于chain方法的轉(zhuǎn)換方式, 可參考Underscore中chain方法的注釋 chain: function () { return _(this.models).chain(); }, // 刪除所有集合元素并重置集合中的數(shù)據(jù)狀態(tài) _reset: function (options) { // 刪除集合元素 this.length = 0; this.models = []; // 重置集合狀態(tài) this._byId = {}; this._byCid = {}; }, // 將模型添加到集合中之前的一些準(zhǔn)備工作 // 包括將數(shù)據(jù)實例化為一個模型對象, 和將集合引用到模型的collection屬性 _prepareModel: function (model, options) { options || (options = {}); // 檢查model是否是一個模型對象(即Model類的實例) if (!(model instanceof Model)) { // 傳入的model是模型數(shù)據(jù)對象, 而并非模型對象 // 將數(shù)據(jù)作為參數(shù)傳遞給Model, 以創(chuàng)建一個新的模型對象 var attrs = model; // 設(shè)置模型引用的集合 options.collection = this; // 將數(shù)據(jù)轉(zhuǎn)化為模型 model = new this.model(attrs, options); // 對模型中的數(shù)據(jù)進(jìn)行驗證 if (!model._validate(model.attributes, options)) model = false; } else if (!model.collection) { // 如果傳入的是一個模型對象但沒有建立與集合的引用, 則設(shè)置模型的collection屬性為當(dāng)前集合 model.collection = this; } return model; }, // 解綁某個模型與集合的關(guān)系, 包括對集合的引用和事件監(jiān)聽 // 一般在調(diào)用remove方法刪除模型或調(diào)用reset方法重置狀態(tài)時自動調(diào)用 _removeReference: function (model) { // 如果模型引用了當(dāng)前集合, 則移除該引用(必須確保所有對模型的引用已經(jīng)解除, 否則模型可能無法從內(nèi)存中釋放) if (this == model.collection) { delete model.collection; } // 取消集合中監(jiān)聽的所有模型事件 model.off('all', this._onModelEvent, this); }, // 在向集合中添加模型時被自動調(diào)用 // 用于監(jiān)聽集合中模型的事件, 當(dāng)模型在觸發(fā)事件(add, remove, destroy, change事件)時集合進(jìn)行相關(guān)處理 _onModelEvent: function (event, model, collection, options) { // 添加和移除模型的事件, 必須確保模型所屬的集合為當(dāng)前集合對象 if ((event == 'add' || event == 'remove') && collection != this) return; // 模型觸發(fā)銷毀事件時, 從集合中移除 if (event == 'destroy') { this.remove(model, options); } // 當(dāng)模型的id被修改時, 集合修改_byId中存儲對模型的引用, 保持與模型id的同步, 便于使用get()方法獲取模型對象 if (model && event === 'change:' + model.idAttribute) { // 獲取模型在改變之前的id, 并根據(jù)此id從集合的_byId列表中移除 delete this._byId[model.previous(model.idAttribute)]; // 以模型新的id作為key, 在_byId列表中存放對模型的引用 this._byId[model.id] = model; } // 在集合中觸發(fā)模型對應(yīng)的事件, 無論模型觸發(fā)任何事件, 集合都會觸發(fā)對應(yīng)的事件 // (例如當(dāng)模型被添加到集合中時, 會觸發(fā)模型的"add"事件, 同時也會在此方法中觸發(fā)集合的"add"事件) // 這對于監(jiān)聽并處理集合中模型狀態(tài)的變化非常有效 // 在監(jiān)聽的集合事件中, 觸發(fā)對應(yīng)事件的模型會被作為參數(shù)傳遞給集合的監(jiān)聽函數(shù) this.trigger.apply(this, arguments); } });// 定義Underscore中的集合操作的相關(guān)方法 // 將Underscore中一系列集合操作方法復(fù)制到Collection集合類的原型對象中 // 這樣就可以直接通過集合對象調(diào)用Underscore相關(guān)的集合方法 // 這些方法在調(diào)用時所操作的集合數(shù)據(jù)是當(dāng)前Collection對象的models數(shù)據(jù) var methods = ['forEach', 'each', 'map', 'reduce', 'reduceRight', 'find', 'detect', 'filter', 'select', 'reject', 'every', 'all', 'some', 'any', 'include', 'contains', 'invoke', 'max', 'min', 'sortBy', 'sortedIndex', 'toArray', 'size', 'first', 'initial', 'rest', 'last', 'without', 'indexOf', 'shuffle', 'lastIndexOf', 'isEmpty', 'groupBy'];// 遍歷已經(jīng)定義的方法列表 _.each(methods, function (method) { // 將方法復(fù)制到Collection集合類的原型對象 Collection.prototype[method] = function () { // 調(diào)用時直接使用Underscore的方法, 上下文對象保持為Underscore對象 // 需要注意的是這里傳遞給Underscore方法的集合參數(shù)是 this.models, 因此在使用這些方法時, 所操作的集合對象是當(dāng)前Collection對象的models數(shù)據(jù) return _[method].apply(_, [this.models].concat(_.toArray(arguments))); }; }); // Backbone.Router URL路由器 // -------------------// 通過繼承Backbone.Router類實現(xiàn)自定義的路由器 // 路由器允許定義路由規(guī)則, 通過URL片段進(jìn)行導(dǎo)航, 并將每一個規(guī)則對應(yīng)到一個方法, 當(dāng)URL匹配某個規(guī)則時會自動執(zhí)行該方法 // 路由器通過URL進(jìn)行導(dǎo)航, 導(dǎo)航方式分為pushState, Hash, 和監(jiān)聽方式(詳細(xì)可參考Backbone.History類) // 在創(chuàng)建Router實例時, 通過options.routes來設(shè)置某個路由規(guī)則對應(yīng)的監(jiān)聽方法 // options.routes中的路由規(guī)則按照 {規(guī)則名稱: 方法名稱}進(jìn)行組織, 每一個路由規(guī)則所對應(yīng)的方法, 都必須是在Router實例中的已經(jīng)聲明的方法 // options.routes定義的路由規(guī)則按照先后順序進(jìn)行匹配, 如果當(dāng)前URL能被多個規(guī)則匹配, 則只會執(zhí)行第一個匹配的事件方法 var Router = Backbone.Router = function (options) { // options默認(rèn)是一個空對象 options || (options = {}); // 如果在options中設(shè)置了routes對象(路由規(guī)則), 則賦給當(dāng)前實例的routes屬性 // routes屬性記錄了路由規(guī)則與事件方法的綁定關(guān)系, 當(dāng)URL與某一個規(guī)則匹配時, 會自動調(diào)用關(guān)聯(lián)的事件方法 if (options.routes) this.routes = options.routes; // 解析和綁定路由規(guī)則 this._bindRoutes(); // 調(diào)用自定義的初始化方法 this.initialize.apply(this, arguments); }; // 定義用于將字符串形式的路由規(guī)則, 轉(zhuǎn)換為可執(zhí)行的正則表達(dá)式規(guī)則時的查找條件 // (字符串形式的路由規(guī)則, 通過\w+進(jìn)行匹配, 因此只支持字母數(shù)字和下劃線組成的字符串) // 匹配一個URL片段中(以/"斜線"為分隔)的動態(tài)路由規(guī)則 // 如: (topic/:id) 匹配 (topic/1228), 監(jiān)聽事件function(id) { // id為1228 } var namedParam = /:\w+/g; // 匹配整個URL片段中的動態(tài)路由規(guī)則 // 如: (topic*id) 匹配 (url#/topic1228), 監(jiān)聽事件function(id) { // id為1228 } var splatParam = /\*\w+/g; // 匹配URL片段中的特殊字符, 并在字符前加上轉(zhuǎn)義符, 防止特殊字符在被轉(zhuǎn)換為正則表達(dá)式后變成元字符 // 如: (abc)^[,.] 將被轉(zhuǎn)換為 \(abc\)\^\[\,\.\] var escapeRegExp = /[-[\]{}()+?.,\\^$|#\s]/g;// 向Router類的原型對象中擴展屬性和方法 _.extend(Router.prototype, Events, {// 自定義初始化方法, 在路由器Router實例化后被自動調(diào)用 initialize: function () {}, // 將一個路由規(guī)則綁定給一個監(jiān)聽事件, 當(dāng)URL片段匹配該規(guī)則時, 會自動調(diào)用觸發(fā)該事件 route: function (route, name, callback) { // 創(chuàng)建history實例, Backbone.history是一個單例對象, 只在第一次創(chuàng)建路由器對象時被實例化 Backbone.history || (Backbone.history = new History); // 檢查route規(guī)則名稱是否為一個字符串(當(dāng)手動調(diào)用route方法創(chuàng)建路由規(guī)則時, 允許傳遞一個正則表達(dá)式或字符串作為規(guī)則) // 在構(gòu)造Router實例時傳入options.routes中的規(guī)則, 都應(yīng)該是一個字符串(因為在_bindRoutes方法中將routes配置中的key作為路由規(guī)則) // 如果傳入的是字符串類型的路由規(guī)則, 通過_routeToRegExp方法將其轉(zhuǎn)換為一個正則表達(dá)式, 用于匹配URL片段 if (!_.isRegExp(route)) route = this._routeToRegExp(route); // 如果沒有設(shè)置callback(事件方法), 則根據(jù)name從當(dāng)前Router實例中獲取與name同名的方法 // 這是因為在手動調(diào)用route方法時可能不會傳遞callback方法, 但必須傳遞name事件名稱, 并在Router實例中已經(jīng)定義了該方法 if (!callback) callback = this[name]; // 調(diào)用history實例的route方法, 該方法會將轉(zhuǎn)換后的正則表達(dá)式規(guī)則, 和監(jiān)聽事件方法綁定到history.handlers列表中, 以便history進(jìn)行路由和控制 // 當(dāng)history實例匹配到對應(yīng)的路由規(guī)則而調(diào)用該事件時, 會將URL片段作為字符串(即fragment參數(shù))傳遞給該事件方法 // 這里并沒有直接將監(jiān)聽事件傳遞給history的route方法, 而是使用bind方法封裝了另一個函數(shù), 該函數(shù)的執(zhí)行上下文為當(dāng)前Router對象 Backbone.history.route(route, _.bind(function (fragment) { // 調(diào)用_extractParameters方法獲取匹配到的規(guī)則中的參數(shù) var args = this._extractParameters(route, fragment); // 調(diào)用callback路由監(jiān)聽事件, 并將參數(shù)傳遞給監(jiān)聽事件 callback && callback.apply(this, args); // 觸發(fā)route:name事件, name為調(diào)用route時傳遞的事件名稱 // 如果對當(dāng)前Router實例使用on方法綁定了route:name事件, 則會收到該事件的觸發(fā)通知 this.trigger.apply(this, ['route:' + name].concat(args)); // 觸發(fā)history實例中綁定的route事件, 當(dāng)路由器匹配到任何規(guī)則時, 均會觸發(fā)該事件 Backbone.history.trigger('route', this, name, args); /** * 事件綁定如: * var router = new MyRouter(); * router.on('route:routename', function(param) { * // 綁定到Router實例中某個規(guī)則的事件, 當(dāng)匹配到該規(guī)則時觸發(fā) * }); * Backbone.history.on('route', function(router, name, args) { * // 綁定到history實例中的事件, 當(dāng)匹配到任何規(guī)則時觸發(fā) * }); * Backbone.history.start(); */ }, this)); return this; }, // 通過調(diào)用history.navigate方法, 手動設(shè)置跳轉(zhuǎn)到URL navigate: function (fragment, options) { // 代理到history實例的navigate方法 Backbone.history.navigate(fragment, options); }, // 解析當(dāng)前實例定義的路由(this.routes)規(guī)則, 并調(diào)用route方法將每一個規(guī)則綁定到對應(yīng)的方法 _bindRoutes: function () { // 如果在創(chuàng)建對象時沒有設(shè)置routes規(guī)則, 則不進(jìn)行解析和綁定 if (!this.routes) return; // routes變量以二維數(shù)組的形式存儲倒序排列的路由規(guī)則 // 如[['', 'homepage'], ['controller:name', 'toController']] var routes = []; // 遍歷routes配置 for (var route in this.routes) { // 將路由規(guī)則放入一個新的數(shù)組, 按照[規(guī)則名稱, 綁定方法]組織 // 將該數(shù)組通過unshift方法放置到routes頂部, 實現(xiàn)倒序排列 // 這里將routes中的規(guī)則倒序排列, 在后面調(diào)用route方法時會再次調(diào)用unshift將順序倒過來, 以保證最終的順序是按照routes配置中定義的順序來執(zhí)行的 // 倒換兩次順序后, 會重新恢復(fù)最初調(diào)用前的順序, 之所以這樣做, 是因為用戶可以手動調(diào)用route方法動態(tài)添加路由規(guī)則, 而手動添加的路由規(guī)則會被添加到列表的第一個, 因此要在route方法中使用unshift來插入規(guī)則 // 而構(gòu)造Router實例時自動添加的規(guī)則, 為了保持定義順序, 因此在此處將定義的規(guī)則倒序排列 routes.unshift([route, this.routes[route]]); } // 循環(huán)完畢, 此時routes中存儲了倒序排列的路由規(guī)則// 循環(huán)路由規(guī)則, 并依次調(diào)用route方法, 將規(guī)則名稱綁定到具體的事件函數(shù) for (var i = 0, l = routes.length; i < l; i++) { // 調(diào)用route方法, 并分別傳遞(規(guī)則名稱, 事件函數(shù)名, 事件函數(shù)對象) this.route(routes[i][0], routes[i][1], this[routes[i][1]]); } }, // 將字符串形式的路由規(guī)則轉(zhuǎn)換為正則表達(dá)式對象 // (在route方法中檢查到字符串類型的路由規(guī)則后, 會自動調(diào)用該方法進(jìn)行轉(zhuǎn)換) _routeToRegExp: function (route) { // 為字符串中特殊字符添加轉(zhuǎn)義符, 防止特殊字符在被轉(zhuǎn)換為正則表達(dá)式后變成元字符(這些特殊字符包括-[\]{}()+?.,\\^$|#\s) // 將字符串中以/"斜線"為分隔的動態(tài)路由規(guī)則轉(zhuǎn)換為([^\/]+), 在正則中表示以/"斜線"開頭的多個字符 // 將字符串中的*"星號"動態(tài)路由規(guī)則轉(zhuǎn)換為(.*?), 在正則中表示0或多個任意字符(這里使用了非貪婪模式, 因此你可以使用例如這樣的組合路由規(guī)則: *list/:id, 將匹配 orderlist/123 , 同時會將"order"和"123"作為參數(shù)傳遞給事件方法 ) // 請注意namedParam和splatParam替換后的正則表達(dá)式都是用()括號將匹配的內(nèi)容包含起來, 這是為了方便取出匹配的內(nèi)容作為參數(shù)傳遞給事件方法 // 請注意namedParam和splatParam匹配的字符串 :str, *str中的str字符串是無意義的, 它們會在下面替換后被忽略, 但一般寫作和監(jiān)聽事件方法的參數(shù)同名, 以便進(jìn)行標(biāo)識 route = route.replace(escapeRegExp, '\\$&').replace(namedParam, '([^\/]+)').replace(splatParam, '(.*?)'); // 將轉(zhuǎn)換后的字符串創(chuàng)建為正則表達(dá)式對象并返回 // 這個正則表達(dá)式將根據(jù)route字符串中的規(guī)則, 用于匹配URL片段 return new RegExp('^' + route + '$'); }, // 傳入一個路由規(guī)則(正則表達(dá)式)和URL片段(字符串)進(jìn)行匹配, 并返回從匹配的字符串中獲取參數(shù) /** * 例如路由規(guī)則為 'teams/:type/:id', 對應(yīng)的正則表達(dá)式會被轉(zhuǎn)換為/^teams/([^/]+)/([^/]+)$/ , (對路由規(guī)則轉(zhuǎn)換為正則表達(dá)式的過程可參考_routeToRegExp方法) * URL片段為 'teams/35/1228' * 則通過exec執(zhí)行后的結(jié)果為 ["teams/35/1228", "35", "1228"] * 數(shù)組中的一個元素是URL片段字符串本身, 從第二個開始則依次為路由規(guī)則表達(dá)式中的參數(shù) */ _extractParameters: function (route, fragment) { return route.exec(fragment).slice(1); } });// Backbone.History 路由器管理 // ----------------// History類提供路由管理相關(guān)操作, 包括監(jiān)聽URL的變化, (通過popstate和onhashchange事件進(jìn)行監(jiān)聽, 對于不支持事件的瀏覽器通過setInterval心跳監(jiān)控) // 提供路由規(guī)則與當(dāng)前URL的匹配驗證, 和觸發(fā)相關(guān)的監(jiān)聽事件 // History一般不會被直接調(diào)用, 在第一次實例化Router對象時, 將自動創(chuàng)建一個History的單例(通過Backbone.history訪問) var History = Backbone.History = function () { // handlers屬性記錄了當(dāng)前所有路由對象中已經(jīng)設(shè)置的規(guī)則和監(jiān)聽列表 // 形式如: [{route: route, callback: callback}], route記錄了正則表達(dá)式規(guī)則, callback記錄了匹配規(guī)則時的監(jiān)聽事件 // 當(dāng)history對象監(jiān)聽到URL發(fā)生變化時, 會自動與handlers中定義的規(guī)則進(jìn)行匹配, 并調(diào)用監(jiān)聽事件 this.handlers = []; // 將checkUrl方法的上下文對象綁定到history對象, 因為checkUrl方法被作為popstate和onhashchange事件或setInterval的回調(diào)函數(shù), 在執(zhí)行回調(diào)時, 上下文對象會被改變 // checkUrl方法用于在監(jiān)聽到URL發(fā)生變化時檢查并調(diào)用loadUrl方法 _.bindAll(this, 'checkUrl'); }; // 定義用于匹配URL片段中首字符是否為"#"或"/"的正則 var routeStripper = /^[#\/]/;// 定義用于匹配從userAgent中獲取的字符串是否包含IE瀏覽器的標(biāo)識, 用于判斷當(dāng)前瀏覽器是否為IE var isExplorer = /msie [\w.]+/;// 記錄當(dāng)前history單例對象是否已經(jīng)被初始化過(調(diào)用start方法) History.started = false;// 向History類的原型對象中添加方法, 這些方法可以通過History的實例調(diào)用(即Backbone.history對象) _.extend(History.prototype, Events, {// 當(dāng)用戶使用低版本的IE瀏覽器(不支持onhashchange事件)時, 通過心跳監(jiān)聽路由狀態(tài)的變化 // interval屬性設(shè)置心跳頻率(毫秒), 該頻率如果太低可能會導(dǎo)致延遲, 如果太高可能會消耗CPU資源(需要考慮用戶使用低端瀏覽器時的設(shè)備配置) interval: 50,// 獲取location中Hash字符串(錨點#后的片段) getHash: function (windowOverride) { // 如果傳入了一個window對象, 則從該對象中獲取, 否則默認(rèn)從當(dāng)前window對象中獲取 var loc = windowOverride ? windowOverride.location : window.location; // 將錨點(#)后的字符串提取出來并返回 var match = loc.href.match(/#(.*)$/); // 如果沒有找到匹配的內(nèi)容, 則返回空字符串 return match ? match[1] : ''; }, // 根據(jù)當(dāng)前設(shè)置的路由方式, 處理并返回當(dāng)前URL中的路由片段 getFragment: function (fragment, forcePushState) { // fragment是通過getHash或從URL中已經(jīng)提取的待處理路由片段(如 #/id/1288) if (fragment == null) { // 如果沒有傳遞fragment, 則根據(jù)當(dāng)前路由方式進(jìn)行提取 if (this._hasPushState || forcePushState) { // 使用了pushState方式進(jìn)行路由 // fragment記錄當(dāng)前域名后的URL路徑 fragment = window.location.pathname; // search記錄當(dāng)前頁面后的參數(shù)內(nèi)容 var search = window.location.search; // 將路徑和參數(shù)合并在一起, 作為待處理的路由片段 if (search) fragment += search; } else { // 使用了hash方式進(jìn)行路由 // 通過getHash方法獲取當(dāng)前錨點(#)后的字符串作為路由片段 fragment = this.getHash(); } } // 根據(jù)配置項中設(shè)置的root參數(shù), 則從路由片段取出root路徑之后的內(nèi)容 if (!fragment.indexOf(this.options.root)) fragment = fragment.substr(this.options.root.length); // 如果URL片段首字母為"#"或"/", 則去除該字符 // 返回處理之后的URL片段 return fragment.replace(routeStripper, ''); }, // 初始化History實例, 該方法只會被調(diào)用一次, 應(yīng)該在創(chuàng)建并初始化Router對象之后被自動調(diào)用 // 該方法作為整個路由的調(diào)度器, 它將針對不同瀏覽器監(jiān)聽URL片段的變化, 負(fù)責(zé)驗證并通知到監(jiān)聽函數(shù) start: function (options) { // 如果history對象已經(jīng)被初始化過, 則拋出錯誤 if (History.started) throw new Error("Backbone.history has already been started"); // 設(shè)置history對象的初始化狀態(tài) History.started = true;// 設(shè)置配置項, 使用調(diào)用start方法時傳遞的options配置項覆蓋默認(rèn)配置 this.options = _.extend({}, { // root屬性設(shè)置URL導(dǎo)航中的路由根目錄 // 如果使用pushState方式進(jìn)行路由, 則root目錄之后的地址會根據(jù)不同的路由產(chǎn)生不同的地址(這可能會定位到不同的頁面, 因此需要確保服務(wù)器支持) // 如果使用Hash錨點的方式進(jìn)行路由, 則root表示URL后錨點(#)的位置 root: '/' }, this.options, options); /** * history針對不同瀏覽器特性, 實現(xiàn)了3種方式的監(jiān)聽: * - 對于支持HTML5中popstate事件的瀏覽器, 通過popstate事件進(jìn)行監(jiān)聽 * - 對于不支持popstate的瀏覽器, 使用onhashchange事件進(jìn)行監(jiān)聽(通過改變hash(錨點)設(shè)置的URL在被載入時會觸發(fā)onhashchange事件) * - 對于不支持popstate和onhashchange事件的瀏覽器, 通過保持心跳監(jiān)聽 * * 關(guān)于HTML5中popstate事件的相關(guān)方法: * - pushState可以將指定的URL添加一個新的history實體到瀏覽器歷史里 * - replaceState方法可以將當(dāng)前的history實體替換為指定的URL * 使用pushState和replaceState方法時僅替換當(dāng)前URL, 而并不會真正轉(zhuǎn)到這個URL(當(dāng)使用后退或前進(jìn)按鈕時, 也不會跳轉(zhuǎn)到該URL) * (這兩個方法可以解決在AJAX單頁應(yīng)用中瀏覽器前進(jìn), 后退操作的問題) * 當(dāng)使用pushState或replaceState方法替換的URL, 在被載入時會觸發(fā)onpopstate事件 * 瀏覽器支持情況: * Chrome 5, Firefox 4.0, IE 10, Opera 11.5, Safari 5.0 * * 注意: * - history.start方法默認(rèn)使用Hash方式進(jìn)行導(dǎo)航 * - 如果需要啟用pushState方式進(jìn)行導(dǎo)航, 需要在調(diào)用start方法時, 手動傳入配置options.pushState * (設(shè)置前請確保瀏覽器支持pushState特性, 否則將默認(rèn)轉(zhuǎn)換為Hash方式) * - 當(dāng)使用pushState方式進(jìn)行導(dǎo)航時, URL可能會從options.root指定的根目錄后發(fā)生變化, 這可能會導(dǎo)航到不同頁面, 因此請確保服務(wù)器已經(jīng)支持pushState方式的導(dǎo)航 */ // _wantsHashChange屬性記錄是否希望使用hash(錨點)的方式來記錄和導(dǎo)航路由器 // 除非在options配置項中手動設(shè)置hashChange為false, 否則默認(rèn)將使用hash錨點的方式 // (如果手動設(shè)置了options.pushState為true, 且瀏覽器支持pushState特性, 則會使用pushState方式) this._wantsHashChange = this.options.hashChange !== false; // _wantsPushState屬性記錄是否希望使用pushState方式來記錄和導(dǎo)航路由器 // pushState是HTML5中為window.history添加的新特性, 如果沒有手動聲明options.pushState為true, 則默認(rèn)將使用hash方式 this._wantsPushState = !!this.options.pushState; // _hasPushState屬性記錄瀏覽器是否支持pushState特性 // 如果在options中設(shè)置了pushState(即希望使用pushState方式), 則檢查瀏覽器是否支持該特性 this._hasPushState = !!(this.options.pushState && window.history && window.history.pushState); // 獲取當(dāng)前URL中的路由字符串 var fragment = this.getFragment(); // documentMode是IE瀏覽器的獨有屬性, 用于標(biāo)識當(dāng)前瀏覽器使用的渲染模式 var docMode = document.documentMode; // oldIE用于檢查當(dāng)前瀏覽器是否為低版本的IE瀏覽器(即IE 7.0以下版本) // 這句代碼可理解為: 當(dāng)前瀏覽器為IE, 但不支持documentMode屬性, 或documentMode屬性返回的渲染模式為IE7.0以下 var oldIE = (isExplorer.exec(navigator.userAgent.toLowerCase()) && (!docMode || docMode <= 7));if (oldIE) { // 如果用戶使用低版本的IE瀏覽器, 不支持popstate和onhashchange事件 // 向DOM中插入一個隱藏的iframe, 并通過改變和心跳監(jiān)聽該iframe的URL實現(xiàn)路由 this.iframe = $('<iframe src="javascript:0" tabindex="-1" />').hide().appendTo('body')[0].contentWindow; // 通過navigate將iframe設(shè)置到當(dāng)前的URL片段, 這并不會真正加載到一個頁面, 因為fragment并非一個完整的URL this.navigate(fragment); }// 開始監(jiān)聽路由狀態(tài)變化 if (this._hasPushState) { // 如果使用了pushState方式路由, 且瀏覽器支持該特性, 則將popstate事件監(jiān)聽到checkUrl方法 $(window).bind('popstate', this.checkUrl); } else if (this._wantsHashChange && ('onhashchange' in window) && !oldIE) { // 如果使用Hash方式進(jìn)行路由, 且瀏覽器支持onhashchange事件, 則將hashchange事件監(jiān)聽到checkUrl方法 $(window).bind('hashchange', this.checkUrl); } else if (this._wantsHashChange) { // 對于低版本的瀏覽器, 通過setInterval方法心跳監(jiān)聽checkUrl方法, interval屬性標(biāo)識心跳頻率 this._checkUrlInterval = setInterval(this.checkUrl, this.interval); }// 記錄當(dāng)前的URL片段 this.fragment = fragment; // 驗證當(dāng)前是否處于根路徑(即options.root中所配置的路徑) var loc = window.location; var atRoot = loc.pathname == this.options.root;// 如果用戶通過pushState方式的URL訪問到當(dāng)前地址, 但用戶此時所使用的瀏覽器并不支持pushState特性 // (這可能是某個用戶通過pushState方式訪問該應(yīng)用, 然后將地址分享給其他用戶, 而其他用戶的瀏覽器并不支持該特性) if (this._wantsHashChange && this._wantsPushState && !this._hasPushState && !atRoot) { // 獲取當(dāng)前pushState方式中的URL片段, 并通過Hash方式重新打開頁面 this.fragment = this.getFragment(null, true); // 例如hashState方式的URL為 /root/topic/12001, 重新打開的Hash方式的URL則為 /root#topic/12001 window.location.replace(this.options.root + '#' + this.fragment); return true;// 如果用戶通過Hash方式的URL訪問到當(dāng)前地址, 但調(diào)用Backbone.history.start方法時設(shè)置了pushState(希望通過pushState方式進(jìn)行路由) // 且用戶瀏覽器支持pushState特性, 則將當(dāng)前URL替換為pushState方式(注意, 這里使用replaceState方式進(jìn)行替換URL, 而頁面不會被刷新) // 以下分支條件可理解為: 如果我們希望使用pushState方式進(jìn)行路由, 且瀏覽器支持該特性, 同時用戶還使用了Hash方式打開當(dāng)前頁面 // (這可能是某個用戶使用Hash方式瀏覽到一個URL, 并將URL分享給另一個瀏覽器支持pushState特性的用戶, 當(dāng)該用戶訪問時會執(zhí)行此分支) } else if (this._wantsPushState && this._hasPushState && atRoot && loc.hash) { // 獲取URL中的Hash片段, 并清除字符串首個"#"或"/" this.fragment = this.getHash().replace(routeStripper, ''); // 使用replaceState方法將當(dāng)前瀏覽器的URL替換為pushState支持的方式, 即: 協(xié)議//主機地址/URL路徑/Hash參數(shù), 例如: // 當(dāng)用戶訪問Hash方式的URL為 /root/#topic/12001, 將被替換為 /root/topic/12001 // 注: // pushState和replaceState方法的參數(shù)有3個, 分別是state, title, url // -state: 用于存儲插入或修改的history實體信息 // -title: 用于設(shè)置瀏覽器標(biāo)題(屬于保留參數(shù), 目前瀏覽器還沒有實現(xiàn)該特性) // -url: 設(shè)置history實體的URL地址(可以是絕對或相對路徑, 但無法設(shè)置跨域URL) window.history.replaceState({}, document.title, loc.protocol + '//' + loc.host + this.options.root + this.fragment); }// 一般調(diào)用start方法時會自動調(diào)用loadUrl, 匹配當(dāng)前URL片段對應(yīng)的路由規(guī)則, 調(diào)用該規(guī)則的方法 // 如果設(shè)置了silent屬性為true, 則loadUrl方法不會被調(diào)用 // 這種情況一般出現(xiàn)在調(diào)用了stop方法重置history對象狀態(tài)后, 再次調(diào)用start方法啟動(實際上此時并非為頁面初始化, 因此會設(shè)置silent屬性) if (!this.options.silent) { return this.loadUrl(); } }, // 停止history對路由的監(jiān)控, 并將狀態(tài)恢復(fù)為未監(jiān)聽狀態(tài) // 調(diào)用stop方法之后, 可重新調(diào)用start方法開始監(jiān)聽, stop方法一般用戶在調(diào)用start方法之后, 需要重新設(shè)置start方法的參數(shù), 或用于單元測試 stop: function () { // 解除對瀏覽器路由的onpopstate和onhashchange事件的監(jiān)聽 $(window).unbind('popstate', this.checkUrl).unbind('hashchange', this.checkUrl); // 停止對于低版本的IE瀏覽器的心跳監(jiān)控 clearInterval(this._checkUrlInterval); // 恢復(fù)started狀態(tài), 便于下次重新調(diào)用start方法 History.started = false; }, // 向handlers中綁定一個路由規(guī)則(參數(shù)route, 類型為正則表達(dá)式)與事件(參數(shù)callback)的映射關(guān)系(該方法由Router的實例自動調(diào)用) route: function (route, callback) { // 將route和callback插入到handlers列表的第一個位置 // 這是為了確保最后調(diào)用route時傳入的規(guī)則被優(yōu)先進(jìn)行匹配 this.handlers.unshift({ // 路由規(guī)則(正則) route: route, // 匹配規(guī)則時執(zhí)行的方法 callback: callback }); }, // 檢查當(dāng)前的URL相對上一次的狀態(tài)是否發(fā)生了變化 // 如果發(fā)生變化, 則記錄新的URL狀態(tài), 并調(diào)用loadUrl方法觸發(fā)新URL與匹配路由規(guī)則的方法 // 該方法在onpopstate和onhashchange事件被觸發(fā)后自動調(diào)用, 或者在低版本的IE瀏覽器中由setInterval心跳定時調(diào)用 checkUrl: function (e) { // 獲取當(dāng)前的URL片段 var current = this.getFragment(); // 對低版本的IE瀏覽器, 將從iframe中獲取最新的URL片段并賦給current變量 if (current == this.fragment && this.iframe) current = this.getFragment(this.getHash(this.iframe)); // 如果當(dāng)前URL與上一次的狀態(tài)沒有發(fā)生任何變化, 則停止執(zhí)行 if (current == this.fragment) return false; // 執(zhí)行到這里, URL已經(jīng)發(fā)生改變, 調(diào)用navigate方法將URL設(shè)置為當(dāng)前URL // 這里在自動調(diào)用navigate方法時, 并沒有傳遞options參數(shù), 因此不會觸發(fā)navigate方法中的loadUrl方法 if (this.iframe) this.navigate(current); // 調(diào)用loadUrl方法, 檢查匹配的規(guī)則, 并執(zhí)行規(guī)則綁定的方法 // 如果調(diào)用this.loadUrl方法沒有成功, 則試圖在調(diào)用loadUrl方法時, 將重新獲取的當(dāng)前Hash傳遞給該方法 this.loadUrl() || this.loadUrl(this.getHash()); }, // 根據(jù)當(dāng)前URL, 與handler路由列表中的規(guī)則進(jìn)行匹配 // 如果URL符合某一個規(guī)則, 則執(zhí)行這個規(guī)則所對應(yīng)的方法, 函數(shù)將返回true // 如果沒有找到合適的規(guī)則, 將返回false // loadUrl方法一般在頁面初始化時調(diào)用start方法會被自動調(diào)用(除非設(shè)置了silent參數(shù)為true) // - 或當(dāng)用戶改變URL后, 由checkUrl監(jiān)聽到URL發(fā)生變化時被調(diào)用 // - 或當(dāng)調(diào)用navigate方法手動導(dǎo)航到某個URL時被調(diào)用 loadUrl: function (fragmentOverride) { // 獲取當(dāng)前URL片段 var fragment = this.fragment = this.getFragment(fragmentOverride); // 調(diào)用Undersocre的any方法, 將URL片段與handlers中的所有規(guī)則依次進(jìn)行匹配 var matched = _.any(this.handlers, function (handler) { // 如果handlers中的規(guī)則與當(dāng)前URL片段匹配, 則執(zhí)行該歸額對應(yīng)的方法, 并返回true if (handler.route.test(fragment)) { handler.callback(fragment); return true; } }); // matched是any方法的返回值, 如果匹配到規(guī)則則返回true, 沒有匹配到返回false return matched; }, // 導(dǎo)航到指定的URL // 如果在options中設(shè)置了trigger, 將觸發(fā)導(dǎo)航的URL與對應(yīng)路由規(guī)則的事件 // 如果在options中設(shè)置了replace, 將使用需要導(dǎo)航的URL替換當(dāng)前的URL在history中的位置 navigate: function (fragment, options) { // 如果沒有調(diào)用start方法, 或已經(jīng)調(diào)用stop方法, 則無法導(dǎo)航 if (!History.started) return false; // 如果options參數(shù)不是一個對象, 而是true值, 則默認(rèn)trigger配置項為true(即觸發(fā)導(dǎo)航的URL與對應(yīng)路由規(guī)則的事件) if (!options || options === true) options = { trigger: options }; // 將傳遞的fragment(URL片段)去掉首字符的"#"或"/" var frag = (fragment || '').replace(routeStripper, ''); // 如果當(dāng)前URL與需要導(dǎo)航的URL沒有變化, 則不繼續(xù)執(zhí)行 if (this.fragment == frag) return;// 如果當(dāng)前支持并使用了pushState方式進(jìn)行導(dǎo)航 if (this._hasPushState) { // 構(gòu)造一個完整的URL, 如果當(dāng)前URL片段中沒有包含根路徑, 則使用根路徑連接URL片段 if (frag.indexOf(this.options.root) != 0) frag = this.options.root + frag; // 設(shè)置新的URL this.fragment = frag; // 如果在options選項中設(shè)置了replace屬性, 則將新的URL替換到history中的當(dāng)前URL, 否則默認(rèn)將新的URL追加到history中 window.history[options.replace ? 'replaceState' : 'pushState']({}, document.title, frag);// 如果使用hash方式進(jìn)行導(dǎo)航 } else if (this._wantsHashChange) { // 設(shè)置新的hash this.fragment = frag; // 調(diào)用_updateHash方法更新當(dāng)前URL為新的hash, 并將options中的replace配置傳遞給_updateHash方法(在該方法中實現(xiàn)替換或追加新的hash) this._updateHash(window.location, frag, options.replace); // 對于低版本的IE瀏覽器, 當(dāng)Hash發(fā)生變化時, 更新iframe URL中的Hash if (this.iframe && (frag != this.getFragment(this.getHash(this.iframe)))) { // 如果使用了replace參數(shù)替換當(dāng)前URL, 則直接將iframe替換為新的文檔 // 調(diào)用document.open打開一個新的文檔, 以擦除當(dāng)前文檔中的內(nèi)容(這里調(diào)用close方法是為了關(guān)閉文檔的狀態(tài)) // open和close方法之間沒有使用write或writeln方法輸出內(nèi)容, 因此這是一個空文檔 if (!options.replace) this.iframe.document.open().close(); // 調(diào)用_updateHash方法更新iframe中的URL this._updateHash(this.iframe.location, frag, options.replace); }} else { // 如果在調(diào)用start方法時, 手動設(shè)置hashChange參數(shù)為true, 不希望使用pushState和hash方式導(dǎo)航 // 則直接將頁面跳轉(zhuǎn)到新的URL window.location.assign(this.options.root + fragment); } // 如果在options配置項中設(shè)置了trigger屬性, 則調(diào)用loadUrl方法查找路由規(guī)則, 并執(zhí)行規(guī)則對應(yīng)的事件 // 在URL發(fā)生變化時, 通過checkUrl方法監(jiān)聽到的狀態(tài), 會在checkUrl方法中自動調(diào)用loadUrl方法 // 在手動調(diào)用navigate方法時, 如果需要觸發(fā)路由事件, 則需要傳遞trigger參數(shù) if (options.trigger) this.loadUrl(fragment); }, // 更新或設(shè)置當(dāng)前URL中的Has串, _updateHash方法在使用hash方式導(dǎo)航時被自動調(diào)用(navigate方法中) // location是需要更新hash的window.location對象 // fragment是需要更新的hash串 // 如果需要將新的hash替換到當(dāng)前URL, 可以設(shè)置replace為true _updateHash: function (location, fragment, replace) { // 如果設(shè)置了replace為true, 則使用location.replace方法替換當(dāng)前的URL // 使用replace方法替換URL后, 新的URL將占有原有URL在history歷史中的位置 if (replace) { // 將當(dāng)前URL與hash組合為一個完整的URL并替換 location.replace(location.toString().replace(/(javascript:|#).*$/, '') + '#' + fragment); } else { // 沒有使用替換方式, 直接設(shè)置location.hash為新的hash串 location.hash = fragment; } } });// Backbone.View 視圖相關(guān) // -------------// 視圖類用于創(chuàng)建與數(shù)據(jù)低耦合的界面控制對象, 通過將視圖的渲染方法綁定到數(shù)據(jù)模型的change事件, 當(dāng)數(shù)據(jù)發(fā)生變化時會通知視圖進(jìn)行渲染 // 視圖對象中的el用于存儲當(dāng)前視圖所需要操作的DOM最父層元素, 這主要是為了提高元素的查找和操作效率, 其優(yōu)點包括: // - 查找或操作元素時, 將操作的范圍限定在el元素內(nèi), 不需要再整個文檔樹中搜索 // - 在為元素綁定事件時, 可以方便地將事件綁定到el元素(默認(rèn)也會綁定到el元素)或者是其子元素 // - 在設(shè)計模式中, 將一個視圖相關(guān)的元素, 事件, 和邏輯限定在該視圖的范圍中, 降低視圖與視圖間的耦合(至少在邏輯上是這樣) var View = Backbone.View = function (options) { // 為每一個視圖對象創(chuàng)建一個唯一標(biāo)識, 前綴為"view" this.cid = _.uniqueId('view'); // 設(shè)置初始化配置 this._configure(options || {}); // 設(shè)置或創(chuàng)建視圖中的元素 this._ensureElement(); // 調(diào)用自定義的初始化方法 this.initialize.apply(this, arguments); // 解析options中設(shè)置的events事件列表, 并將事件綁定到視圖中的元素 this.delegateEvents(); }; // 定義用于解析events參數(shù)中事件名稱和元素的正則 var delegateEventSplitter = /^(\S+)\s*(.*)$/;// viewOptions列表記錄一些列屬性名, 在構(gòu)造視圖對象時, 如果傳遞的配置項中包含這些名稱, 則將屬性復(fù)制到對象本身 var viewOptions = ['model', 'collection', 'el', 'id', 'attributes', 'className', 'tagName'];// 向視圖類的原型對象中添加一些方法 _.extend(View.prototype, Events, {// 如果在創(chuàng)建視圖對象時, 沒有設(shè)置指定的el元素, 則會通過make方法創(chuàng)建一個元素, tagName為創(chuàng)建元素的默認(rèn)標(biāo)簽 // 也可以通過在options中自定義tagName來覆蓋默認(rèn)的"div"標(biāo)簽 tagName: 'div',// 每個視圖中都具有一個$選擇器方法, 該方法與jQuery或Zepto類似, 通過傳遞一個表達(dá)式來獲取元素 // 但該方法只會在視圖對象的$el元素范圍內(nèi)進(jìn)行查找, 因此會提高匹配效率 $: function (selector) { return this.$el.find(selector); }, // 初始化方法, 在對象被實例化后自動調(diào)用 initialize: function () {}, // render方法與initialize方法類似, 默認(rèn)沒有實現(xiàn)任何邏輯 // 一般會重載該方法, 以實現(xiàn)對視圖中元素的渲染 render: function () { // 返回當(dāng)前視圖對象, 以支持方法的鏈?zhǔn)讲僮?/span> // 因此如果重載了該方法, 建議在方法最后也返回視圖對象(this) return this; }, // 移除當(dāng)前視圖的$el元素 remove: function () { // 通過調(diào)用jQuery或Zepto的remove方法, 因此在第三方庫中會同時移除該元素綁定的所有事件和數(shù)據(jù) this.$el.remove(); return this; }, // 根據(jù)傳入的標(biāo)簽名稱, 屬性和內(nèi)容, 創(chuàng)建并返回一個DOM元素 // 該方法用于在內(nèi)部創(chuàng)建this.el時自動調(diào)用 make: function (tagName, attributes, content) { // 根據(jù)tagName創(chuàng)建元素 var el = document.createElement(tagName); // 設(shè)置元素屬性 if (attributes) $(el).attr(attributes); // 設(shè)置元素內(nèi)容 if (content) $(el).html(content); // 返回元素 return el; }, // 為視圖對象設(shè)置標(biāo)準(zhǔn)的$el及el屬性, 該方法在對象創(chuàng)建時被自動調(diào)用 // $el是通過jQuery或Zepto創(chuàng)建的對象, el是標(biāo)準(zhǔn)的DOM對象 setElement: function (element, delegate) { // 如果已經(jīng)存在了$el屬性(可能是手動調(diào)用了setElement方法切換視圖的元素), 則取消之前對$el綁定的events事件(詳細(xì)參考undelegateEvents方法) if (this.$el) this.undelegateEvents(); // 將元素創(chuàng)建為jQuery或Zepto對象, 并存放在$el屬性中 this.$el = (element instanceof $) ? element : $(element); // this.el存放標(biāo)準(zhǔn)的DOM對象 this.el = this.$el[0]; // 如果設(shè)置了delegate參數(shù), 則為元素綁定視圖中events參數(shù)設(shè)置的事件 // 在視圖類的構(gòu)造函數(shù)中, 已經(jīng)調(diào)用了delegateEvents方法進(jìn)行綁定, 因此在初始化的_ensureElement方法中調(diào)用setElement方法時沒有傳遞delegate參數(shù) // 在手動調(diào)用setElemen方法設(shè)置視圖元素時, 允許傳遞delegate綁定事件 if (delegate !== false) this.delegateEvents(); return this; }, // 為視圖元素綁定事件 // events參數(shù)配置了需要綁定事件的集合, 格式如('事件名稱 元素選擇表達(dá)式' : '事件方法名稱/或事件函數(shù)'): // { // 'click #title': 'edit', // 'click .save': 'save' // 'click span': function() {} // } // 該方法在視圖對象初始化時會被自動調(diào)用, 并將對象中的events屬性作為events參數(shù)(事件集合) delegateEvents: function (events) { // 如果沒有手動傳遞events參數(shù), 則從視圖對象獲取events屬性作為事件集合 if (!(events || (events = getValue(this, 'events')))) return; // 取消當(dāng)前已經(jīng)綁定過的events事件 this.undelegateEvents(); // 遍歷需要綁定的事件列表 for (var key in events) { // 獲取需要綁定的方法(允許是方法名稱或函數(shù)) var method = events[key]; // 如果是方法名稱, 則從對象中獲取該函數(shù)對象, 因此該方法名稱必須是視圖對象中已定義的方法 if (!_.isFunction(method)) method = this[events[key]]; // 對無效的方法拋出一個錯誤 if (!method) throw new Error('Method "' + events[key] + '" does not exist'); // 解析事件表達(dá)式(key), 從表達(dá)式中解析出事件的名字和需要操作的元素 // 例如 'click #title'將被解析為 'click' 和 '#title' 兩部分, 均存放在match數(shù)組中 var match = key.match(delegateEventSplitter); // eventName為解析后的事件名稱 // selector為解析后的事件元素選擇器表達(dá)式 var eventName = match[1], selector = match[2]; // bind方法是Underscore中用于綁定函數(shù)上下文的方法 // 這里將method事件方法的上下文綁定到當(dāng)前視圖對象, 因此在事件被觸發(fā)后, 事件方法中的this始終指向視圖對象本身 method = _.bind(method, this); // 設(shè)置事件名稱, 在事件名稱后追加標(biāo)識, 用于傳遞給jQuery或Zepto的事件綁定方法 eventName += '.delegateEvents' + this.cid; // 通過jQuery或Zepto綁定事件 if (selector === '') { // 如果沒有設(shè)置子元素選擇器, 則通過bind方法將事件和方法綁定到當(dāng)前$el元素本身 this.$el.bind(eventName, method); } else { // 如果當(dāng)前設(shè)置了子元素選擇器表達(dá)式, 則通過delegate方式綁定 // 該方法將查找當(dāng)前$el元素下的子元素, 并將于selector表達(dá)式匹配的元素進(jìn)行事件綁定 // 如果該選擇器的元素不屬于當(dāng)前$el的子元素, 則事件綁定無效 this.$el.delegate(selector, eventName, method); } } }, // 取消視圖中當(dāng)前元素綁定的events事件, 該方法一般不會被使用 // 除非調(diào)用delegateEvents方法重新為視圖中的元素綁定事件, 在重新綁定之前會清除當(dāng)前的事件 // 或通過setElement方法重新設(shè)置試圖的el元素, 也會清除當(dāng)前元素的事件 undelegateEvents: function () { this.$el.unbind('.delegateEvents' + this.cid); }, // 在實例化視圖對象時設(shè)置初始配置 // 將傳遞的配置覆蓋到對象的options中 // 將配置中與viewOptions列表相同的配置復(fù)制到對象本身, 作為對象的屬性 _configure: function (options) { // 如果對象本身設(shè)置了默認(rèn)配置, 則使用傳遞的配置進(jìn)行合并 if (this.options) options = _.extend({}, this.options, options); // 遍歷viewOptions列表 for (var i = 0, l = viewOptions.length; i < l; i++) { // attr依次為viewOptions中的屬性名 var attr = viewOptions[i]; // 將options配置中與viewOptions相同的配置復(fù)制到對象本身, 作為對象的屬性 if (options[attr]) this[attr] = options[attr]; } // 設(shè)置對象的options配置 this.options = options; }, // 每一個視圖對象都應(yīng)該有一個el元素, 作為渲染的元素 // 在構(gòu)造視圖時, 可以設(shè)置對象的el屬性來指定一個元素 // 如果設(shè)置的el是一個字符串或DOM對象, 則通過$方法將其創(chuàng)建為一個jQuery或Zepto對象 // 如果沒有設(shè)置el屬性, 則根據(jù)傳遞的tagName, id和className, 調(diào)用mak方法創(chuàng)建一個元素 // (新創(chuàng)建的元素不會被添加到文檔樹中, 而始終存儲在內(nèi)存, 當(dāng)處理完畢需要渲染到頁面時, 一般會在重寫的render方法, 或自定義方法中, 訪問this.el將其追加到文檔) // (如果我們需要向頁面添加一個目前還沒有的元素, 并且需要為其添加一些子元素, 屬性, 樣式或事件時, 可以通過該方式先將元素創(chuàng)建到內(nèi)存, 在完成所有操作之后再手動渲染到文檔, 可以提高渲染效率) _ensureElement: function () { // 如果沒有設(shè)置el屬性, 則創(chuàng)建默認(rèn)元素 if (!this.el) { // 從對象獲取attributes屬性, 作為新創(chuàng)建元素的默認(rèn)屬性列表 var attrs = getValue(this, 'attributes') || {}; // 設(shè)置新元素的id if (this.id) attrs.id = this.id; // 設(shè)置新元素的class if (this.className) attrs['class'] = this.className; // 通過make方法創(chuàng)建元素, 并調(diào)用setElement方法將元素設(shè)置為視圖所使用的標(biāo)準(zhǔn)元素 this.setElement(this.make(this.tagName, attrs), false); } else { // 如果設(shè)置了el屬性, 則直接調(diào)用setElement方法將el元素設(shè)置為視圖的標(biāo)準(zhǔn)元素 this.setElement(this.el, false); } } });// 實現(xiàn)對象繼承的函數(shù), 該函數(shù)內(nèi)部使用inherits實現(xiàn)繼承, 請參考inherits函數(shù) var extend = function (protoProps, classProps) { // child存儲已經(jīng)實現(xiàn)繼承自當(dāng)前類的子類(Function) // protoProps設(shè)置子類原型鏈中的屬性 // classProps設(shè)置子類的靜態(tài)屬性 var child = inherits(this, protoProps, classProps); // 將extend函數(shù)添加到子類, 因此調(diào)用子類的extend方法便可實現(xiàn)對子類的繼承 child.extend = this.extend; // 返回實現(xiàn)繼承的子類 return child; }; // 為Model, Collection, Router和View類實現(xiàn)繼承機制 Model.extend = Collection.extend = Router.extend = View.extend = extend;// Backbone.sync 與服務(wù)器異步交互相關(guān) // -------------// 定義Backbone中與服務(wù)器交互方法和請求type的對應(yīng)關(guān)系 var methodMap = { 'create': 'POST', 'update': 'PUT', 'delete': 'DELETE', 'read': 'GET' };// sync用于在Backbone中操作數(shù)據(jù)時, 向服務(wù)器發(fā)送請求同步數(shù)據(jù)狀態(tài), 以建立與服務(wù)器之間的無縫連接 // sync發(fā)送默認(rèn)通過第三方庫(jQuery, Zepto等) $.ajax方法發(fā)送請求, 因此如果要調(diào)用狀態(tài)同步相關(guān)的方法, 需要第三方庫支持 // Backbone默認(rèn)定義了一套與服務(wù)器交互的數(shù)據(jù)格式(JSON)和結(jié)構(gòu), 服務(wù)器響應(yīng)的數(shù)據(jù)應(yīng)該遵循該約定 // 如果數(shù)據(jù)不需要保存在服務(wù)器, 或與服務(wù)器交互方法, 數(shù)據(jù)格式結(jié)構(gòu)與約定不一致, 可以通過重載sync方法實現(xiàn) // @param {String} method 在Backbone中執(zhí)行的CRUD操作名稱 // @param {Model Obejct} model 需要與服務(wù)器同步狀態(tài)的模型對象 // @param {Object} options Backbone.sync = function (method, model, options) { // 根據(jù)CRUD方法名定義與服務(wù)器交互的方法(POST, GET, PUT, DELETE) var type = methodMap[method];// options默認(rèn)為一個空對象 options || (options = {});// params將作為請求參數(shù)對象傳遞給第三方庫的$.ajax方法 var params = { // 請求類型 type: type, // 數(shù)據(jù)格式默認(rèn)為json dataType: 'json' };// 如果在發(fā)送請求時沒有在options中設(shè)置url地址, 將會通過模型對象的url屬性或方法來獲取url // 模型所獲取url的方式可參考模型的url方法 if (!options.url) { // 獲取請求地址失敗時會調(diào)用urlError方法拋出一個錯誤 params.url = getValue(model, 'url') || urlError(); }// 如果調(diào)用create和update方法, 且沒有在options中定義請求數(shù)據(jù), 將序列化模型中的數(shù)據(jù)對象傳遞給服務(wù)器 if (!options.data && model && (method == 'create' || method == 'update')) { // 定義請求的Content-Type頭, 默認(rèn)為application/json params.contentType = 'application/json'; // 序列化模型中的數(shù)據(jù), 并作為請求數(shù)據(jù)傳遞給服務(wù)器 params.data = JSON.stringify(model.toJSON()); }// 對于不支持application/json編碼的瀏覽器, 可以通過設(shè)置Backbone.emulateJSON參數(shù)為true實現(xiàn)兼容 if (Backbone.emulateJSON) { // 不支持Backbone.emulateJSON編碼的瀏覽器, 將類型設(shè)置為application/x-www-form-urlencoded params.contentType = 'application/x-www-form-urlencoded'; // 將需要同步的數(shù)據(jù)存放在key為"model"參數(shù)中發(fā)送到服務(wù)器 params.data = params.data ? { model: params.data } : {}; }// 對于不支持REST方式的瀏覽器, 可以設(shè)置Backbone.emulateHTTP參數(shù)為true, 以POST方式發(fā)送數(shù)據(jù), 并在數(shù)據(jù)中加入_method參數(shù)標(biāo)識操作名稱 // 同時也將發(fā)送X-HTTP-Method-Override頭信息 if (Backbone.emulateHTTP) { // 如果操作類型為PUT或DELETE if (type === 'PUT' || type === 'DELETE') { // 將操作名稱存放到_method參數(shù)發(fā)送到服務(wù)器 if (Backbone.emulateJSON) params.data._method = type; // 實際以POST方式進(jìn)行提交, 并發(fā)送X-HTTP-Method-Override頭信息 params.type = 'POST'; params.beforeSend = function (xhr) { xhr.setRequestHeader('X-HTTP-Method-Override', type); }; } }// 對非GET方式的請求, 將不對數(shù)據(jù)進(jìn)行轉(zhuǎn)換, 因為傳遞的數(shù)據(jù)可能是一個JSON映射 if (params.type !== 'GET' && !Backbone.emulateJSON) { // 通過設(shè)置processData為false來關(guān)閉數(shù)據(jù)轉(zhuǎn)換 // processData參數(shù)是$.ajax方法中的配置參數(shù), 詳細(xì)信息可參考jQuery或Zepto相關(guān)文檔 params.processData = false; }// 通過第三方庫的$.ajax方法向服務(wù)器發(fā)送請求同步數(shù)據(jù)狀態(tài) // 傳遞給$.ajax方法的參數(shù)使用extend方法將options對象中的參數(shù)覆蓋到了params對象, 因此在調(diào)用sync方法時設(shè)置了與params同名的options參數(shù), 將以options為準(zhǔn) return $.ajax(_.extend(params, options)); }; // 包裝一個統(tǒng)一的模型錯誤處理方法, 會在模型與服務(wù)器交互發(fā)生錯誤時被調(diào)用 // onError是在調(diào)用與服務(wù)器的交互方法時(如fetch, destory等), options中指定的自定義錯誤處理函數(shù) // originalModel是發(fā)生錯誤的模型或集合對象 Backbone.wrapError = function (onError, originalModel, options) { return function (model, resp) { resp = model === originalModel ? resp : model;if (onError) { // 如果設(shè)置了自定義錯誤處理方法, 則調(diào)用自定義方法 onError(originalModel, resp, options); } else { // 默認(rèn)將觸發(fā)發(fā)生錯誤的模型或集合的error事件 originalModel.trigger('error', originalModel, resp, options); } }; }; // Helpers 定義一些供Backbone內(nèi)部使用的幫助函數(shù) // -------// ctor是一個共享的空函數(shù), 用于在調(diào)用inherits方法實現(xiàn)繼承時, 承載父類的原型鏈以便設(shè)置到子類原型中 var ctor = function () {}; // 實現(xiàn)OOP繼承特性 // @param {Function} parent 被繼承的父類Function // @param {Object} protoProps 擴展子類原型中的屬性(或方法)對象 // @param {Object} staticProps 擴展子類的靜態(tài)屬性(或方法)對象 var inherits = function (parent, protoProps, staticProps) { var child;// 如果在protoProps中指定了"constructor"屬性, 則"constructor"屬性被作為子類的構(gòu)造函數(shù) // 如果沒有指定構(gòu)造子類構(gòu)造函數(shù), 則默認(rèn)調(diào)用父類的構(gòu)造函數(shù) if (protoProps && protoProps.hasOwnProperty('constructor')) { // 使用"constructor"屬性指定的子類構(gòu)造函數(shù) child = protoProps.constructor; } else { // 使用父類的構(gòu)造函數(shù) child = function () { parent.apply(this, arguments); }; }// 將父類中的靜態(tài)屬性復(fù)制為子類靜態(tài)屬性 _.extend(child, parent);// 將父類原型鏈設(shè)置到子類的原型對象中, 子類以此繼承父類原型鏈中的所有屬性 ctor.prototype = parent.prototype; child.prototype = new ctor();// 將protoProps對象中的屬性復(fù)制到子類的原型對象, 子類以此擁有protoProps中的屬性 if (protoProps) _.extend(child.prototype, protoProps);// 將staticProps對象中的屬性復(fù)制到子類的構(gòu)造函數(shù)本身, 將staticProps中的屬性作為子類的靜態(tài)屬性 if (staticProps) _.extend(child, staticProps);// 在復(fù)制父類原型鏈到子類原型時, 子類原型鏈中的構(gòu)造函數(shù)已經(jīng)被覆蓋, 因此此處重新設(shè)置子類的構(gòu)造函數(shù) child.prototype.constructor = child;// 如果子類設(shè)置了constructor屬性, 則子類構(gòu)造函數(shù)為constructor指定的函數(shù) // 如果需要在子類構(gòu)造函數(shù)中調(diào)用父類構(gòu)造函數(shù), 則需要在子類構(gòu)造函數(shù)中手動調(diào)用父類的構(gòu)造函數(shù) // 此處將子類的__super__屬性指向父類的構(gòu)造函數(shù), 方便在子類中調(diào)用: 子類.__super__.constructor.call(this); child.__super__ = parent.prototype;// 返回子類 return child; }; // 獲取對象prop屬性的值, 如果prop屬性是一個函數(shù), 則執(zhí)行并返回該函數(shù)的返回值 var getValue = function (object, prop) { // 如果object為空或object不存在prop屬性, 則返回null if (!(object && object[prop])) return null; // 返回prop屬性值, 如果prop是一個函數(shù), 則執(zhí)行并返回該函數(shù)的返回值 return _.isFunction(object[prop]) ? object[prop]() : object[prop]; }; // 拋出一個Error異常, 在Backbone內(nèi)部會頻繁執(zhí)行, 因此獨立為一個公共函數(shù) var urlError = function () { throw new Error('A "url" property or function must be specified'); }; }).call(this);

?

轉(zhuǎn)載于:https://www.cnblogs.com/wpgraceii/p/6511667.html

總結(jié)

以上是生活随笔為你收集整理的Backbone.js源码解读(转载)的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。