【 js 基础 】【 源码学习 】源码设计 （持续更新）

var _ = function(obj) {
// 以下均针对 OOP 形式的调用
// 如果是非 OOP 形式的调用，不会进入该函数内部
// 如果 obj 已经是 `_` 函数的实例，则直接返回 obj
if (obj instanceof _) return obj; // 如果不是 `_` 函数的实例
// 则调用 new 运算符，返回实例化的对象
if (! (this instanceof _)) return new _(obj); // 将 obj 赋值给 this._wrapped 属性
this._wrapped = obj;
};

_.mixin = function(obj) {
// 遍历 obj 的 key，将方法挂载到 Underscore 上
// 其实是将方法浅拷贝到 _.prototype 上
_.each(_.functions(obj),
function(name) {
// 直接把方法挂载到 _[name] 上
// 调用类似 _.myFunc([1, 2, 3], ..)
var func = _[name] = obj[name]; // 浅拷贝
// 将 name 方法挂载到 _ 对象的原型链上，使之能 OOP 调用
_.prototype[name] = function() {
// 第一个参数
var args = [this._wrapped]; // arguments 为 name 方法需要的其他参数
push.apply(args, arguments);
// 执行 func 方法
// 支持链式操作
return result(this, func.apply(_, args));
};
});
};// Add all of the Underscore functions to the wrapper object.
// 将前面定义的 underscore 方法添加给包装过的对象
// 即添加到 _.prototype 中
// 使 underscore 支持面向对象形式的调用
_.mixin(_);// Add all mutator Array functions to the wrapper.
// 将 Array 原型链上有的方法都添加到 underscore 中
_.each(['pop', 'push', 'reverse', 'shift', 'sort', 'splice', 'unshift'],
function(name) {
var method = ArrayProto[name];
_.prototype[name] = function() {
var obj = this._wrapped;
method.apply(obj, arguments); if ((name === 'shift' || name === 'splice') && obj.length === 0) delete obj[0]; // 支持链式操作
return result(this, obj);
};
});// Add all accessor Array functions to the wrapper.
// 添加 concat、join、slice 等数组原生方法给 Underscore
_.each(['concat', 'join', 'slice'],
function(name) {
var method = ArrayProto[name];
_.prototype[name] = function() {
return result(this, method.apply(this._wrapped, arguments));
};
});
// 一个包装过(OOP)并且链式调用的对象
// 用 value 方法获取结果
_.prototype.value = function() {
return this._wrapped;
};_.prototype.valueOf = _.prototype.toJSON = _.prototype.value;_.prototype.toString = function() {
return '' + this._wrapped;
};

(function(factory) { })(function(root, Backbone, _, $) {
// Backbone.Events
// ---------------
// Backbone 事件部分
// Backbone的 Events 实际上就是一个观察者模式(发布订阅模式)的实现，并且巧妙的是，还可以作为mixin混入到自己写的object中， // 初始化Events为一个空对象,js中的对象是按引用传递的。
var Events = Backbone.Events = {}; // Bind an event to a `callback` function. Passing `"all"` will bind
// the callback to all events fired.
// 绑定事件。将一个事件绑定到 `callback` 函数上。事件触发时执行回调函数`callback`。
Events.on = function(name, callback, context) { }; // “on”的控制反转版本。
// 让 object 监听 另一个（other）对象上的一个特定事件。跟踪它正在监听的内容，以便以后解除绑定。
Events.listenTo = function(obj, name, callback) { }; // 此函数作用于删除一个或多个回调。
Events.off = function(name, callback, context) { }; // 解除 当前 object 监听的 其他对象上制定事件，或者说是所有当前监听的事件
// 如果 传入被监听对象 obj 就是解除特定对象上的事件，没有就是解除所有事件
Events.stopListening = function(obj, name, callback) { }; // 绑定事件只能触发一次。在第一次调用回调之后，它的监听器将被删除。如果使用空格分隔的语法传递多个事件，则处理程序将针对每个事件触发一次，而不是一次所有事件的组合。
Events.once = function(name, callback, context) { }; // once的反转控制版本
Events.listenToOnce = function(obj, name, callback) { }; // 触发一个或者多个事件，并触发所有的回调函数
Events.trigger = function(name) { }; // 将Events的特性全部extend到Backbone, 即Backbone也可以做Backbone.on/Backbone.trigger这样的操作.
// underscore:_.extend(destination, *sources) 复制source对象中的所有属性覆盖到destination对象上，并且返回 destination 对象. 复制是按顺序的, 所以后面的对象属性会把前面的对象属性覆盖掉(如果有重复).
_.extend(Backbone, Events); // 至此,Events部分结束,接下来是Model部分
// Backbone.Model 模型Model绑定键值数据和自定义事件；
// --------------
// 每当一个模型建立，一个 cid 便会被自动创建
// 实际上，Model 函数内的语句顺序也是很重要的，这个不能随便打乱顺序(初始化过程) // 创建具有指定属性的新model。 客户端ID（`cid`）自动生成并分配给您。
var Model = Backbone.Model = function(attributes, options) { // Model的唯一的id，这和自己传入的id并不一样，虽然我们也要保证id是唯一的
this.cid = _.uniqueId(this.cidPrefix); // model 模型元数据都存储在`attributes`变量中.
this.attributes = {}; // 如果指定`collection`则保存, model 在构造 url 时可能会用到此参数.
if (options.collection) this.collection = options.collection; // 如果之后 new 的时候传入的是 JSON,我们必须在 options 选项中声明 parse 为 true
if (options.parse) attrs = this.parse(attrs, options) || {}; // 存储历史变化记录，用于保存上一次`set`之后改变的数据字段.
this.changed = {};
// 调用initialize初始化方法。这个initialize也是空的，给初始化之后调用
this.initialize.apply(this, arguments);
}; // 使用extend方法为Model原型定义一系列属性和方法。
_.extend(Model.prototype, Events, {
// preinitialize默认为空函数。您可以使用函数或对象覆盖它。在模型中运行任何实例逻辑之前，preinitialize将运行。
preinitialize: function() {}, // 默认情况下，Initialize是一个空的函数。用自己的初始化逻辑覆盖它。
initialize: function() {}, // Get the value of an attribute.
// 从当前model中获取当前属性(attributes)值，比如： note.get("title")
get: function(attr) {
return this.attributes[attr];
}, // 检查模型中是否存在某个属性。属性值为非 null 或非 undefined 时返回 true。
// 当该属性的值被转换为Boolean类型后值为false, 则认为不存在。如果值为false, null, undefined, 0, NaN, 或空字符串时, 均会被转换为false。
has: function(attr) {
return this.get(attr) != null;
}, // 向 model 设置一个或多个 hash 属性(attributes)。如果任何一个属性改变了 model 的状态，在不传入 {silent: true} 选项参数的情况下，会触发 "change" 事件，更改特定属性的事件也会触发。 可以绑定事件到某个属性，例如：change:title，及 change:content。
set: function(key, val, options) { }, // 从 model 中删除所有属性， 包括id属性。 如果未设置 silent 选项，会触发 "change" 事件。unset 设置为 true,为删除操作。
clear: function(options) { }, // 标识模型从上次 set 事件发生后是否改变过。 如果传入 att ，当指定属性改变后返回 true。
hasChanged: function(attr) { }, // 如果服务器已经持久化，则在服务器上销毁此模型。如果有模型，则可以从Collection集合中删除该模型。 如果设置了“wait：true”，等待服务器成功响应再删除。
// 如果模型是在客户端新建的, 则直接从客户端删除
// 如果模型数据同时存在服务器, 则同时会删除服务器端的数据
destroy: function(options) { }
}); // 至此,Model部分结束,接下来是Collection部分
// Backbone.Collection 集合Colection是模型的有序或无序集合，带有丰富的可枚举API；
// ------------------- // 如果 model 更倾向于表示单行数据，那么 Backbone Collection 更类似于完整数据的表，或者表数据的一小片或者一页表格，或者因为一些原因而聚集在一起的多条行数据。Collections 维护其模型的索引，无论是按顺序的还是通过“id”进行查找。 // 创建一个新的 **Collection**，可能包含了某一种特定的类型的 model。如果指定了“comparator”，则Collection将按照排序顺序维护其模型，当它们被添加和删除。
var Collection = Backbone.Collection = function(models, options) {
// 配置对象
options || (options = {});
// 提前初始化
this.preinitialize.apply(this, arguments); // 实例化时重置集合的内部状态(第一次调用时可理解为定义状态)
this._reset();
}; // 通过extend方法定义集合类原型方法
_.extend(Collection.prototype, Events, { // preinitialize默认为空函数。你可以用函数或者对象重写它。preinitialize将在Collection中运行任何实例逻辑之前，先运行。
preinitialize: function() {}, // initialize 默认也是空函数。你可以用你自己的初始化函数覆盖它。
initialize: function() {}, // 向集合中增加一个模型（或一个模型数组），触发"add"事件。
add: function(models, options) { }, // 从集合中删除一个模型（或一个模型数组），会触发 "remove" 事件，
remove: function(models, options) { }, // 通过“set”更新集合，添加新的模型，删除不再存在的模型，并根据需要合并集合中已存在的模型。 类似于** Model＃set **，用于更新集合所包含的数据的核心操作。
set: function(models, options) { }, // 添加一个 model 到 collection 集合的最后。
push: function(model, options) { }, // 删除并且返回集合中最后一个模型。选项和remove相同。
pop: function(options) { } }); // Backbone.View 视图相关
// ------------- // 视图类用于创建与数据低耦合的界面控制对象, 通过将视图的渲染方法绑定到数据模型的change事件, 当数据发生变化时会通知视图进行渲染
// 视图对象中的el用于存储当前视图所需要操作的DOM最父层元素, 这主要是为了提高元素的查找和操作效率, 其优点包括:
// - 查找或操作元素时, 将操作的范围限定在el元素内, 不需要再整个文档树中搜索
// - 在为元素绑定事件时, 可以方便地将事件绑定到el元素(默认也会绑定到el元素)或者是其子元素
// - 在设计模式中, 将一个视图相关的元素, 事件, 和逻辑限定在该视图的范围中, 降低视图与视图间的耦合(至少在逻辑上是这样)
var View = Backbone.View = function(options) {
// 为每一个视图对象创建一个唯一标识, 前缀为"view"
this.cid = _.uniqueId('view');
// 提前初始化
this.preinitialize.apply(this, arguments);
// underscore _.pick(object, *keys)方法：返回一个object副本，只过滤出keys(有效的键组成的数组)参数指定的属性值。或者接受一个判断函数，指定挑选哪个key。
_.extend(this, _.pick(options, viewOptions));
// 初始化dom元素和jQuery元素工作,设置或创建视图中的元素
this._ensureElement();
// 调用自定义的初始化方法
this.initialize.apply(this, arguments);
}; // 设置所有可继承的** Backbone.View **属性和方法。
_.extend(View.prototype, Events, { // 默认空函数。可重写。
initialize: function() {}, // ** render **是您的视图应该覆盖的核心函数，以便使用适当的HTML填充其元素（`this.el`）。这个惯例是** render **总是返回`this`。
render: function() {
return this;
}, //移除这个View。
//通过将元素从DOM中移除，并删除任何适用的Backbone.Events侦听器来删除此视图。
remove: function() { }, // 如果你想应用一个Backbone视图到不同的DOM元素， 使用setElement， 这也将创造缓存$el引用，视图的委托事件从旧元素移动到新元素上。
// 更改视图的元素（`this.el`属性）并重新委派新元素上的视图事件。
setElement: function(element) { }
}); // Backbone.sync Backbone 每次向服务器读取或保存模型时都要调用执行的函数。
// -------------
// 覆盖此功能以更改Backbone将models持续到服务器的方式。你需要传递 request 的类型以及有问题的 model。默认情况下，一个 RESTful Ajax 请求会调用 model 的 url() 方法。一些可能的使用场景：
// 1、使用 setTimeout 将快速更新 批量导入到单个请求中。
// 2、发送 XML 形式的 model
// 3、通过WebSockets而不是Ajax来持久化模型。
Backbone.sync = function(method, model, options) { }; // Backbone.Router Backbone的路由部分,这部分被认为是backbone的MVC结构中的被弱化的controller
// --------------- var Router = Backbone.Router = function(options) {
options || (options = {});
// 提前初始化
this.preinitialize.apply(this, arguments);
// 如果在options中设置了routes对象(路由规则), 则赋给当前实例的routes属性
// routes属性记录了路由规则与事件方法的绑定关系, 当URL与某一个规则匹配时, 会自动调用关联的事件方法
if (options.routes) this.routes = options.routes;
// 解析和绑定路由规则
this._bindRoutes();
// 调用自定义的初始化方法
this.initialize.apply(this, arguments);
}; // 向Router类的原型对象中扩展属性和方法
_.extend(Router.prototype, Events, { // 默认为空函数，可以重写，在路由器中运行任何实例化逻辑之前，preinitialize将先运行。
preinitialize: function() {}, // 自定义初始化方法, 在路由器Router实例化后被自动调用
initialize: function() {}, // 将一个路由规则绑定给一个监听事件, 当URL片段匹配该规则时, 会自动调用触发该事件。
route: function(route, name, callback) { }, // 在route方法内部被调用， 每当路由和其相应的callback匹配时被执行。 覆盖它来执行自定义解析或包装路由。
execute: function(callback, args, name) { }, // 每当你达到你的应用的一个点时，你想保存为一个URL， 可以调用navigate以更新的URL。
navigate: function(fragment, options) { }
}); // Backbone.History 路由器管理
// ----------------
//
// Backbone的history是通过绑定hashchange事件的监听来监听网页url的变化(通过popstate和onhashchange事件进行监听, 对于不支持事件的浏览器通过setInterval心跳监控),从而调用相关函数
// 另外，在不支持hashchange事件的浏览器中,采用轮询的方式
var History = Backbone.History = function() { // handlers属性记录了当前所有路由对象中已经设置的规则和监听列表
// 形式如: [{route: route, callback: callback}], route记录了正则表达式规则, callback记录了匹配规则时的监听事件
// 当history对象监听到URL发生变化时, 会自动与handlers中定义的规则进行匹配, 并调用监听事件
this.handlers = []; this.checkUrl = _.bind(this.checkUrl, this);
}; // 向History类的原型对象中添加方法, 这些方法可以通过History的实例调用(即Backbone.history对象)
_.extend(History.prototype, Events, { // 如果处于根节点那么this.location.pathname获取到的应该是`/`
// 另外这里用到了getSearch来获取?后面的内容,如果能获取到自然说明并不是在根节点
atRoot: function() {
var path = this.location.pathname.replace(/[^\/]$/, '$&/');
return path === this.root && !this.getSearch();
}, // 防止像％这样的可能是参数的一部分的符号被编码 ????
decodeFragment: function(fragment) {
return decodeURI(fragment.replace(/%25/g, '%2525'));
}, // 取得?以及其后面的内容
getSearch: function() {
var match = this.location.href.replace(/#.*/, '').match(/\?.+/);
return match ? match[0] : '';
}, // 停止history对路由的监控, 并将状态恢复为未监听状态
// 调用stop方法之后, 可重新调用start方法开始监听, stop方法一般用户在调用start方法之后, 需要重新设置start方法的参数, 或用于单元测试
stop: function() { }, // 检查当前的URL相对上一次的状态是否发生了变化
checkUrl: function(e) { }, // 导航到指定的URL，存储/更新历史记录
navigate: function(fragment, options) { },
}); // Create the default Backbone.history.
Backbone.history = new History; return Backbone;
});