Underscore.js 1.3.3 中文注释翻译说明
程序员文章站
2023-10-26 20:32:10
// underscore.js 1.3.3
// (c) 2009-2012 jeremy ashkenas, documentcloud inc....
// underscore.js 1.3.3
// (c) 2009-2012 jeremy ashkenas, documentcloud inc.
// underscore is freely distributable under the mit license.
// portions of underscore are inspired or borrowed from prototype,
// oliver steele's functional, and john resig's micro-templating.
// for all details and documentation:
// http://documentcloud.github.com/underscore
(function() {
// 创建一个全局对象, 在浏览器中表示为window对象, 在node.js中表示global对象
var root = this;
// 保存"_"(下划线变量)被覆盖之前的值
// 如果出现命名冲突或考虑到规范, 可通过_.noconflict()方法恢复"_"被underscore占用之前的值, 并返回underscore对象以便重新命名
var previousunderscore = root._;
// 创建一个空的对象常量, 便于内部共享使用
var breaker = {};
// 将内置对象的原型链缓存在局部变量, 方便快速调用
var arrayproto = array.prototype, //
objproto = object.prototype, //
funcproto = function.prototype;
// 将内置对象原型中的常用方法缓存在局部变量, 方便快速调用
var slice = arrayproto.slice, //
unshift = arrayproto.unshift, //
tostring = objproto.tostring, //
hasownproperty = objproto.hasownproperty;
// 这里定义了一些javascript 1.6提供的新方法
// 如果宿主环境中支持这些方法则优先调用, 如果宿主环境中没有提供, 则会由underscore实现
var nativeforeach = arrayproto.foreach, //
nativemap = arrayproto.map, //
nativereduce = arrayproto.reduce, //
nativereduceright = arrayproto.reduceright, //
nativefilter = arrayproto.filter, //
nativeevery = arrayproto.every, //
nativesome = arrayproto.some, //
nativeindexof = arrayproto.indexof, //
nativelastindexof = arrayproto.lastindexof, //
nativeisarray = array.isarray, //
nativekeys = object.keys, //
nativebind = funcproto.bind;
// 创建对象式的调用方式, 将返回一个underscore包装器, 包装器对象的原型中包含underscore所有方法(类似与将dom对象包装为一个jquery对象)
var _ = function(obj) {
// 所有underscore对象在内部均通过wrapper对象进行构造
return new wrapper(obj);
};
// 针对不同的宿主环境, 将undersocre的命名变量存放到不同的对象中
if( typeof exports !== 'undefined') {// node.js环境
if( typeof module !== 'undefined' && module.exports) {
exports = module.exports = _;
}
exports._ = _;
} else {// 浏览器环境中underscore的命名变量被挂在window对象中
root['_'] = _;
}
// 版本声明
_.version = '1.3.3';
// 集合相关的方法(数据和对象的通用处理方法)
// --------------------
// 迭代处理器, 对集合中每一个元素执行处理器方法
var each = _.each = _.foreach = function(obj, iterator, context) {
// 不处理空值
if(obj == null)
return;
if(nativeforeach && obj.foreach === nativeforeach) {
// 如果宿主环境支持, 则优先调用javascript 1.6提供的foreach方法
obj.foreach(iterator, context);
} else if(obj.length === +obj.length) {
// 对<数组>中每一个元素执行处理器方法
for(var i = 0, l = obj.length; i < l; i++) {
if( i in obj && iterator.call(context, obj[i], i, obj) === breaker)
return;
}
} else {
// 对<对象>中每一个元素执行处理器方法
for(var key in obj) {
if(_.has(obj, key)) {
if(iterator.call(context, obj[key], key, obj) === breaker)
return;
}
}
}
};
// 迭代处理器, 与each方法的差异在于map会存储每次迭代的返回值, 并作为一个新的数组返回
_.map = _.collect = function(obj, iterator, context) {
// 用于存放返回值的数组
var results = [];
if(obj == null)
return results;
// 优先调用宿主环境提供的map方法
if(nativemap && obj.map === nativemap)
return obj.map(iterator, context);
// 迭代处理集合中的元素
each(obj, function(value, index, list) {
// 将每次迭代处理的返回值存储到results数组
results[results.length] = iterator.call(context, value, index, list);
});
// 返回处理结果
if(obj.length === +obj.length)
results.length = obj.length;
return results;
};
// 将集合中每个元素放入迭代处理器, 并将本次迭代的返回值作为"memo"传递到下一次迭代, 一般用于累计结果或连接数据
_.reduce = _.foldl = _.inject = function(obj, iterator, memo, context) {
// 通过参数数量检查是否存在初始值
var initial = arguments.length > 2;
if(obj == null)
obj = [];
// 优先调用宿主环境提供的reduce方法
if(nativereduce && obj.reduce === nativereduce && false) {
if(context)
iterator = _.bind(iterator, context);
return initial ? obj.reduce(iterator, memo) : obj.reduce(iterator);
}
// 迭代处理集合中的元素
each(obj, function(value, index, list) {
if(!initial) {
// 如果没有初始值, 则将第一个元素作为初始值; 如果被处理的是对象集合, 则默认值为第一个属性的值
memo = value;
initial = true;
} else {
// 记录处理结果, 并将结果传递给下一次迭代
memo = iterator.call(context, memo, value, index, list);
}
});
if(!initial)
throw new typeerror('reduce of empty array with no initial value');
return memo;
};
// 与reduce作用相似, 将逆向迭代集合中的元素(即从最后一个元素开始直到第一个元素)
_.reduceright = _.foldr = function(obj, iterator, memo, context) {
var initial = arguments.length > 2;
if(obj == null)
obj = [];
// 优先调用宿主环境提供的reduceright方法
if(nativereduceright && obj.reduceright === nativereduceright) {
if(context)
iterator = _.bind(iterator, context);
return initial ? obj.reduceright(iterator, memo) : obj.reduceright(iterator);
}
// 逆转集合中的元素顺序
var reversed = _.toarray(obj).reverse();
if(context && !initial)
iterator = _.bind(iterator, context);
// 通过reduce方法处理数据
return initial ? _.reduce(reversed, iterator, memo, context) : _.reduce(reversed, iterator);
};
// 遍历集合中的元素, 返回第一个能够通过处理器验证的元素
_.find = _.detect = function(obj, iterator, context) {
// result存放第一个能够通过验证的元素
var result;
// 通过any方法遍历数据, 并记录通过验证的元素
// (如果是在迭代中检查处理器返回状态, 这里使用each方法会更合适)
any(obj, function(value, index, list) {
// 如果处理器返回的结果被转换为boolean类型后值为true, 则当前记录并返回当前元素
if(iterator.call(context, value, index, list)) {
result = value;
return true;
}
});
return result;
};
// 与find方法作用类似, 但filter方法会记录下集合中所有通过验证的元素
_.filter = _.select = function(obj, iterator, context) {
// 用于存储通过验证的元素数组
var results = [];
if(obj == null)
return results;
// 优先调用宿主环境提供的filter方法
if(nativefilter && obj.filter === nativefilter)
return obj.filter(iterator, context);
// 迭代集合中的元素, 并将通过处理器验证的元素放到数组中并返回
each(obj, function(value, index, list) {
if(iterator.call(context, value, index, list))
results[results.length] = value;
});
return results;
};
// 与filter方法作用相反, 即返回没有通过处理器验证的元素列表
_.reject = function(obj, iterator, context) {
var results = [];
if(obj == null)
return results;
each(obj, function(value, index, list) {
if(!iterator.call(context, value, index, list))
results[results.length] = value;
});
return results;
};
// 如果集合中所有元素均能通过处理器验证, 则返回true
_.every = _.all = function(obj, iterator, context) {
var result = true;
if(obj == null)
return result;
// 优先调用宿主环境提供的every方法
if(nativeevery && obj.every === nativeevery)
return obj.every(iterator, context);
// 迭代集合中的元素
each(obj, function(value, index, list) {
// 这里理解为 result = (result && iterator.call(context, value, index, list))
// 验证处理器的结果被转换为boolean类型后是否为true值
if(!( result = result && iterator.call(context, value, index, list)))
return breaker;
});
return !!result;
};
// 检查集合中任何一个元素在被转换为boolean类型时, 是否为true值?或者通过处理器处理后, 是否值为true?
var any = _.some = _.any = function(obj, iterator, context) {
// 如果没有指定处理器参数, 则默认的处理器函数会返回元素本身, 并在迭代时通过将元素转换为boolean类型来判断是否为true值
iterator || ( iterator = _.identity);
var result = false;
if(obj == null)
return result;
// 优先调用宿主环境提供的some方法
if(nativesome && obj.some === nativesome)
return obj.some(iterator, context);
// 迭代集合中的元素
each(obj, function(value, index, list) {
if(result || ( result = iterator.call(context, value, index, list)))
return breaker;
});
return !!result;
};
// 检查集合中是否有值与目标参数完全匹配(同时将匹配数据类型)
_.include = _.contains = function(obj, target) {
var found = false;
if(obj == null)
return found;
// 优先调用宿主环境提供的array.prototype.indexof方法
if(nativeindexof && obj.indexof === nativeindexof)
return obj.indexof(target) != -1;
// 通过any方法迭代集合中的元素, 验证元素的值和类型与目标是否完全匹配
found = any(obj, function(value) {
return value === target;
});
return found;
};
// 依次调用集合中所有元素的同名方法, 从第3个参数开始, 将被以此传入到元素的调用方法中
// 返回一个数组, 存储了所有方法的处理结果
_.invoke = function(obj, method) {
// 调用同名方法时传递的参数(从第3个参数开始)
var args = slice.call(arguments, 2);
// 依次调用每个元素的方法, 并将结果放入数组中返回
return _.map(obj, function(value) {
return (_.isfunction(method) ? method || value : value[method]).apply(value, args);
});
};
// 遍历一个由对象列表组成的数组, 并返回每个对象中的指定属性的值列表
_.pluck = function(obj, key) {
// 如果某一个对象中不存在该属性, 则返回undefined
return _.map(obj, function(value) {
return value[key];
});
};
// 返回集合中的最大值, 如果不存在可比较的值, 则返回undefined
_.max = function(obj, iterator, context) {
// 如果集合是一个数组, 且没有使用处理器, 则使用math.max获取最大值
// 一般会是在一个数组存储了一系列number类型的数据
if(!iterator && _.isarray(obj) && obj[0] === +obj[0])
return math.max.apply(math, obj);
// 对于空值, 直接返回负无穷大
if(!iterator && _.isempty(obj))
return -infinity;
// 一个临时的对象, computed用于在比较过程中存储最大值(临时的)
var result = {
computed : -infinity
};
// 迭代集合中的元素
each(obj, function(value, index, list) {
// 如果指定了处理器参数, 则比较的数据为处理器返回的值, 否则直接使用each遍历时的默认值
var computed = iterator ? iterator.call(context, value, index, list) : value;
// 如果比较值相比上一个值要大, 则将当前值放入result.value
computed >= result.computed && ( result = {
value : value,
computed : computed
});
});
// 返回最大值
return result.value;
};
// 返回集合中的最小值, 处理过程与max方法一致
_.min = function(obj, iterator, context) {
if(!iterator && _.isarray(obj) && obj[0] === +obj[0])
return math.min.apply(math, obj);
if(!iterator && _.isempty(obj))
return infinity;
var result = {
computed : infinity
};
each(obj, function(value, index, list) {
var computed = iterator ? iterator.call(context, value, index, list) : value;
computed < result.computed && ( result = {
value : value,
computed : computed
});
});
return result.value;
};
// 通过随机数, 让数组无须排列
_.shuffle = function(obj) {
// shuffled变量存储处理过程及最终的结果数据
var shuffled = [], rand;
// 迭代集合中的元素
each(obj, function(value, index, list) {
// 生成一个随机数, 随机数在<0-当前已处理的数量>之间
rand = math.floor(math.random() * (index + 1));
// 将已经随机得到的元素放到shuffled数组末尾
shuffled[index] = shuffled[rand];
// 在前面得到的随机数的位置插入最新值
shuffled[rand] = value;
});
// 返回一个数组, 该数组中存储了经过随机混排的集合元素
return shuffled;
};
// 对集合中元素, 按照特定的字段或值进行排列
// 相比array.prototype.sort方法, sortby方法支持对对象排序
_.sortby = function(obj, val, context) {
// val应该是对象的一个属性, 或一个处理器函数, 如果是一个处理器, 则应该返回需要进行比较的数据
var iterator = _.isfunction(val) ? val : function(obj) {
return obj[val];
};
// 调用顺序: _.pluck(_.map().sort());
// 调用_.map()方法遍历集合, 并将集合中的元素放到value节点, 将元素中需要进行比较的数据放到criteria属性中
// 调用sort()方法将集合中的元素按照criteria属性中的数据进行顺序排序
// 调用pluck获取排序后的对象集合并返回
return _.pluck(_.map(obj, function(value, index, list) {
return {
value : value,
criteria : iterator.call(context, value, index, list)
};
}).sort(function(left, right) {
var a = left.criteria, b = right.criteria;
if(a ===
void 0)
return 1;
if(b ===
void 0)
return -1;
return a < b ? -1 : a > b ? 1 : 0;
}), 'value');
};
// 将集合中的元素, 按处理器返回的key分为多个数组
_.groupby = function(obj, val) {
var result = {};
// val将被转换为进行分组的处理器函数, 如果val不是一个function类型的数据, 则将被作为筛选元素时的key值
var iterator = _.isfunction(val) ? val : function(obj) {
return obj[val];
};
// 迭代集合中的元素
each(obj, function(value, index) {
// 将处理器的返回值作为key, 并将相同的key元素放到一个新的数组
var key = iterator(value, index);
(result[key] || (result[key] = [])).push(value);
});
// 返回已分组的数据
return result;
};
_.sortedindex = function(array, obj, iterator) {
iterator || ( iterator = _.identity);
var low = 0, high = array.length;
while(low < high) {
var mid = (low + high) >> 1;
iterator(array[mid]) < iterator(obj) ? low = mid + 1 : high = mid;
}
return low;
};
// 将一个集合转换一个数组并返回
// 一般用于将arguments转换为数组, 或将对象无序集合转换为数据形式的有序集合
_.toarray = function(obj) {
if(!obj)
return [];
if(_.isarray(obj))
return slice.call(obj);
// 将arguments转换为数组
if(_.isarguments(obj))
return slice.call(obj);
if(obj.toarray && _.isfunction(obj.toarray))
return obj.toarray();
// 将对象转换为数组, 数组中包含对象中所有属性的值列表(不包含对象原型链中的属性)
return _.values(obj);
};
// 计算集合中元素的数量
_.size = function(obj) {
// 如果集合是一个数组, 则计算数组元素数量
// 如果集合是一个对象, 则计算对象中的属性数量(不包含对象原型链中的属性)
return _.isarray(obj) ? obj.length : _.keys(obj).length;
};
// 数组相关的方法
// ---------------
// 返回一个数组的第一个或順序指定的n个元素
_.first = _.head = _.take = function(array, n, guard) {
// 如果没有指定参数n, 则返回第一个元素
// 如果指定了n, 则返回一个新的数组, 包含顺序指定数量n个元素
// guard参数用于确定只返回第一个元素, 当guard为true时, 指定数量n无效
return (n != null) && !guard ? slice.call(array, 0, n) : array[0];
};
// 返回一个新数组, 包含除第一个元素外的其它元素, 或排除从最后一个元素开始向前指定n个元素
// 与first方法不同在于, first确定需要的元素在数组之前的位置, initial确定能排除的元素在数组最后的位置
_.initial = function(array, n, guard) {
// 如果没有传递参数n, 则默认返回除最后一个元素外的其它元素
// 如果传递参数n, 则返回从最后一个元素开始向前的n个元素外的其它元素
// guard用于确定只返回一个元素, 当guard为true时, 指定数量n无效
return slice.call(array, 0, array.length - ((n == null) || guard ? 1 : n));
};
// 返回数组的最后一个或倒序指定的n个元素
_.last = function(array, n, guard) {
if((n != null) && !guard) {
// 计算并指定获取的元素位置n, 直到数组末尾, 作为一个新的数组返回
return slice.call(array, math.max(array.length - n, 0));
} else {
// 如果没有指定数量, 或guard为true时, 只返回最后一个元素
return array[array.length - 1];
}
};
// 获取除了第一个或指定前n个元素外的其它元素
_.rest = _.tail = function(array, index, guard) {
// 计算slice的第二个位置参数, 直到数组末尾
// 如果没有指定index, 或guard值为true, 则返回除第一个元素外的其它元素
// (index == null)值为true时, 作为参数传递给slice函数将被自动转换为1
return slice.call(array, (index == null) || guard ? 1 : index);
};
// 返回数组中所有值能被转换为true的元素, 返回一个新的数组
// 不能被转换的值包括 false, 0, '', null, undefined, nan, 这些值将被转换为false
_.compact = function(array) {
return _.filter(array, function(value) {
return !!value;
});
};
// 将一个多维数组合成为一维数组, 支持深层合并
// shallow参数用于控制合并深度, 当shallow为true时, 只合并第一层, 默认进行深层合并
_.flatten = function(array, shallow) {
// 迭代数组中的每一个元素, 并将返回值作为demo传递给下一次迭代
return _.reduce(array, function(memo, value) {
// 如果元素依然是一个数组, 进行以下判断:
// - 如果不进行深层合并, 则使用array.prototype.concat将当前数组和之前的数据进行连接
// - 如果支持深层合并, 则迭代调用flatten方法, 直到底层元素不再是数组类型
if(_.isarray(value))
return memo.concat( shallow ? value : _.flatten(value));
// 数据(value)已经处于底层, 不再是数组类型, 则将数据合并到memo中并返回
memo[memo.length] = value;
return memo;
}, []);
};
// 筛选并返回当前数组中与指定数据不相等的差异数据(可参考difference方法注释)
_.without = function(array) {
return _.difference(array, slice.call(arguments, 1));
};
// 对数组中的数据进行去重(使用===进行比较)
// 当issorted参数不为false时, 将依次对数组中的元素调用include方法, 检查相同元素是否已经被添加到返回值(数组)中
// 如果调用之前确保数组中数据按顺序排列, 则可以将issorted设为true, 它将通过与最后一个元素进行对比来排除相同值, 使用issorted效率会高于默认的include方式
// uniq方法默认将以数组中的数据进行对比, 如果声明iterator处理器, 则会根据处理器创建一个对比数组, 比较时以该数组中的数据为准, 但最终返回的唯一数据仍然是原始数组
_.uniq = _.unique = function(array, issorted, iterator) {
// 如果使用了iterator处理器, 则先将当前数组中的数据会先经过按迭代器处理, 并返回一个处理后的新数组
// 新数组用于作为比较的基准
var initial = iterator ? _.map(array, iterator) : array;
// 用于记录处理结果的临时数组
var results = [];
// 如果数组中只有2个值, 则不需要使用include方法进行比较, 将issorted设置为true能提高运行效率
if(array.length < 3)
issorted = true;
// 使用reduce方法迭代并累加处理结果
// initial变量是需要进行比较的基准数据, 它可能是原始数组, 也可能是处理器的结果集合(如果设置过iterator)
_.reduce(initial, function(memo, value, index) {
// 如果issorted参数为true, 则直接使用===比较记录中的最后一个数据
// 如果issorted参数为false, 则使用include方法与集合中的每一个数据进行对比
if( issorted ? _.last(memo) !== value || !memo.length : !_.include(memo, value)) {
// memo记录了已经比较过的无重复数据
// 根据iterator参数的状态, memo中记录的数据可能是原始数据, 也可能是处理器处理后的数据
memo.push(value);
// 处理结果数组中保存的始终为原始数组中的数据
results.push(array[index]);
}
return memo;
}, []);
// 返回处理结果, 它只包含数组中无重复的数据
return results;
};
// union方法与uniq方法作用一致, 不同之处在于union允许在参数中传入多个数组
_.union = function() {
// union对参数中的多个数组进行浅层合并为一个数组对象传递给uniq方法进行处理
return _.uniq(_.flatten(arguments, true));
};
// 获取当前数组与其它一个或多个数组的交集元素
// 从第二个参数开始为需要进行比较的一个或多个数组
_.intersection = _.intersect = function(array) {
// rest变量记录需要进行比较的其它数组对象
var rest = slice.call(arguments, 1);
// 使用uniq方法去除当前数组中的重复数据, 避免重复计算
// 对当前数组的数据通过处理器进行过滤, 并返回符合条件(比较相同元素)的数据
return _.filter(_.uniq(array), function(item) {
// 使用every方法验证每一个数组中都包含了需要对比的数据
// 如果所有数组中均包含对比数据, 则全部返回true, 如果任意一个数组没有包含该元素, 则返回false
return _.every(rest, function(other) {
// other参数存储了每一个需要进行对比的数组
// item存储了当前数组中需要进行对比的数据
// 使用indexof方法搜索数组中是否存在该元素(可参考indexof方法注释)
return _.indexof(other, item) >= 0;
});
});
};
// 筛选并返回当前数组中与指定数据不相等的差异数据
// 该函数一般用于删除数组中指定的数据, 并得到删除后的新数组
// 该方法的作用与without相等, without方法参数形式上不允许数据被包含在数组中, 而difference方法参数形式上建议是数组(也可以和without使用相同形式的参数)
_.difference = function(array) {
// 对第2个参数开始的所有参数, 作为一个数组进行合并(仅合并第一层, 而并非深层合并)
// rest变量存储验证数据, 在本方法中用于与原数据对比
var rest = _.flatten(slice.call(arguments, 1), true);
// 对合并后的数组数据进行过滤, 过滤条件是当前数组中不包含参数指定的验证数据的内容
// 将符合过滤条件的数据组合为一个新的数组并返回
return _.filter(array, function(value) {
return !_.include(rest, value);
});
};
// 将每个数组的相同位置的数据作为一个新的二维数组返回, 返回的数组长度以传入参数中最大的数组长度为准, 其它数组的空白位置使用undefined填充
// zip方法应该包含多个参数, 且每个参数应该均为数组
_.zip = function() {
// 将参数转换为数组, 此时args是一个二维数组
var args = slice.call(arguments);
// 计算每一个数组的长度, 并返回其中最大长度值
var length = _.max(_.pluck(args, 'length'));
// 依照最大长度值创建一个新的空数组, 该数组用于存储处理结果
var results = new array(length);
// 循环最大长度, 在每次循环将调用pluck方法获取每个数组中相同位置的数据(依次从0到最后位置)
// 将获取到的数据存储在一个新的数组, 放入results并返回
for(var i = 0; i < length; i++)
results[i] = _.pluck(args, "" + i);
// 返回的结果是一个二维数组
return results;
};
// 搜索一个元素在数组中首次出现的位置, 如果元素不存在则返回 -1
// 搜索时使用 === 对元素进行匹配
_.indexof = function(array, item, issorted) {
if(array == null)
return -1;
var i, l;
if(issorted) {
i = _.sortedindex(array, item);
return array[i] === item ? i : -1;
}
// 优先调用宿主环境提供的indexof方法
if(nativeindexof && array.indexof === nativeindexof)
return array.indexof(item);
// 循环并返回元素首次出现的位置
for( i = 0, l = array.length; i < l; i++)
if( i in array && array[i] === item)
return i;
// 没有找到元素, 返回-1
return -1;
};
// 返回一个元素在数组中最后一次出现的位置, 如果元素不存在则返回 -1
// 搜索时使用 === 对元素进行匹配
_.lastindexof = function(array, item) {
if(array == null)
return -1;
// 优先调用宿主环境提供的lastindexof方法
if(nativelastindexof && array.lastindexof === nativelastindexof)
return array.lastindexof(item);
var i = array.length;
// 循环并返回元素最后出现的位置
while(i--)
if( i in array && array[i] === item)
return i;
// 没有找到元素, 返回-1
return -1;
};
// 根据区间和步长, 生成一系列整数, 并作为数组返回
// start参数表示最小数
// stop参数表示最大数
// step参数表示生成多个数值之间的步长值
_.range = function(start, stop, step) {
// 参数控制
if(arguments.length <= 1) {
// 如果没有参数, 则start = 0, stop = 0, 在循环中不会生成任何数据, 将返回一个空数组
// 如果有1个参数, 则参数指定给stop, start = 0
stop = start || 0;
start = 0;
}
// 生成整数的步长值, 默认为1
step = arguments[2] || 1;
// 根据区间和步长计算将生成的最大值
var len = math.max(math.ceil((stop - start) / step), 0);
var idx = 0;
var range = new array(len);
// 生成整数列表, 并存储到range数组
while(idx < len) {
range[idx++] = start;
start += step;
}
// 返回列表结果
return range;
};
// 函数相关方法
// ------------------
// 创建一个用于设置prototype的公共函数对象
var ctor = function() {
};
// 为一个函数绑定执行上下文, 任何情况下调用该函数, 函数中的this均指向context对象
// 绑定函数时, 可以同时给函数传递调用形参
_.bind = function bind(func, context) {
var bound, args;
// 优先调用宿主环境提供的bind方法
if(func.bind === nativebind && nativebind)
return nativebind.apply(func, slice.call(arguments, 1));
// func参数必须是一个函数(function)类型
if(!_.isfunction(func))
throw new typeerror;
// args变量存储了bind方法第三个开始的参数列表, 每次调用时都将传递给func函数
args = slice.call(arguments, 2);
return bound = function() {
if(!(this instanceof bound))
return func.apply(context, sargs.concat(slice.call(arguments)));
ctor.prototype = func.prototype;
var self = new ctor;
var result = func.apply(self, args.concat(slice.call(arguments)));
if(object(result) === result)
return result;
return self;
};
};
// 将指定的函数, 或对象本身的所有函数上下本绑定到对象本身, 被绑定的函数在被调用时, 上下文对象始终指向对象本身
// 该方法一般在处理对象事件时使用, 例如:
// _(obj).bindall(); // 或_(obj).bindall('handlerclick');
// document.addeventlistener('click', obj.handlerclick);
// 在handlerclick方法中, 上下文依然是obj对象
_.bindall = function(obj) {
// 第二个参数开始表示需要绑定的函数名称
var funcs = slice.call(arguments, 1);
// 如果没有指定特定的函数名称, 则默认绑定对象本身所有类型为function的属性
if(funcs.length == 0)
funcs = _.functions(obj);
// 循环并将所有的函数上下本设置为obj对象本身
// each方法本身不会遍历对象原型链中的方法, 但此处的funcs列表是通过_.functions方法获取的, 它已经包含了原型链中的方法
each(funcs, function(f) {
obj[f] = _.bind(obj[f], obj);
});
return obj;
};
// memoize方法将返回一个函数, 该函数集成了缓存功能, 将经过计算的值缓存到局部变量并在下次调用时直接返回
// 如果计算结果是一个庞大的对象或数据, 使用时应该考虑内存占用情况
_.memoize = function(func, hasher) {
// 用于存储缓存结果的memo对象
var memo = {};
// hasher参数应该是一个function, 它用于返回一个key, 该key作为读取缓存的标识
// 如果没有指定key, 则默认使用函数的第一个参数作为key, 如果函数的第一个参数是复合数据类型, 可能会返回类似[object object]的key, 这个key可能会造成后续计算的数据不正确
hasher || ( hasher = _.identity);
// 返回一个函数, 该函数首先通过检查缓存, 再对没有缓存过的数据进行调用
return function() {
var key = hasher.apply(this, arguments);
return _.has(memo, key) ? memo[key] : (memo[key] = func.apply(this, arguments));
};
};
// 延时执行一个函数
// wait单位为ms, 第3个参数开始将被依次传递给执行函数
_.delay = function(func, wait) {
var args = slice.call(arguments, 2);
return settimeout(function() {
return func.apply(null, args);
}, wait);
};
// 延迟执行函数
// javascript中的settimeout会被放到一个单独的函数堆栈中执行, 执行时间是在当前堆栈中调用的函数都被执行完毕之后
// defer设置函数在1ms后执行, 目的是将func函数放到单独的堆栈中, 等待当前函数执行完成后再执行
// defer方法一般用于处理dom操作的优先级, 实现正确的逻辑流程和更流畅的交互体验
_.defer = function(func) {
return _.delay.apply(_, [func, 1].concat(slice.call(arguments, 1)));
};
// 函数节流方法, throttle方法主要用于控制函数的执行频率, 在被控制的时间间隔内, 频繁调用函数不会被多次执行
// 在时间间隔内如果多次调用了函数, 时间隔截止时会自动调用一次, 不需要等到时间截止后再手动调用(自动调用时不会有返回值)
// throttle函数一般用于处理复杂和调用频繁的函数, 通过节流控制函数的调用频率, 节省处理资源
// 例如window.onresize绑定的事件函数, 或element.onmousemove绑定的事件函数, 可以用throttle进行包装
// throttle方法返回一个函数, 该函数会自动调用func并进行节流控制
_.throttle = function(func, wait) {
var context, args, timeout, throttling, more, result;
// whendone变量调用了debounce方法, 因此在多次连续调用函数时, 最后一次调用会覆盖之前调用的定时器, 清除状态函数也仅会被执行一次
// whendone函数在最后一次函数执行的时间间隔截止时调用, 清除节流和调用过程中记录的一些状态
var whendone = _.debounce(function() {
more = throttling = false;
}, wait);
// 返回一个函数, 并在函数内进行节流控制
return function() {
// 保存函数的执行上下文和参数
context = this;
args = arguments;
// later函数在上一次函数调用时间间隔截止时执行
var later = function() {
// 清除timeout句柄, 方便下一次函数调用
timeout = null;
// more记录了在上一次调用至时间间隔截止之间, 是否重复调用了函数
// 如果重复调用了函数, 在时间间隔截止时将自动再次调用函数
if(more)
func.apply(context, args);
// 调用whendone, 用于在时间间隔后清除节流状态
whendone();
};
// timeout记录了上一次函数执行的时间间隔句柄
// timeout时间间隔截止时调用later函数, later中将清除timeout, 并检查是否需要再次调用函数
if(!timeout)
timeout = settimeout(later, wait);
// throttling变量记录上次调用的时间间隔是否已经结束, 即是否处于节流过程中
// throttling在每次函数调用时设为true, 表示需要进行节流, 在时间间隔截止时设置为false(在whendone函数中实现)
if(throttling) {
// 节流过程中进行了多次调用, 在more中记录一个状态, 表示在时间间隔截止时需要再次自动调用函数
more = true;
} else {
// 没有处于节流过程, 可能是第一次调用函数, 或已经超过上一次调用的间隔, 可以直接调用函数
result = func.apply(context, args);
}
// 调用whendone, 用于在时间间隔后清除节流状态
whendone();
// throttling变量记录函数调用时的节流状态
throttling = true;
// 返回调用结果
return result;
};
};
// debounce与throttle方法类似, 用于函数节流, 它们的不同之处在于:
// -- throttle关注函数的执行频率, 在指定频率内函数只会被执行一次;
// -- debounce函数更关注函数执行的间隔, 即函数两次的调用时间不能小于指定时间;
// 如果两次函数的执行间隔小于wait, 定时器会被清除并重新创建, 这意味着连续频繁地调用函数, 函数一直不会被执行, 直到某一次调用与上一次调用的时间不小于wait毫秒
// debounce函数一般用于控制需要一段时间之后才能执行的操作, 例如在用户输入完毕200ms后提示用户, 可以使用debounce包装一个函数, 绑定到onkeyup事件
// ----------------------------------------------------------------
// @param {function} func 表示被执行的函数
// @param {number} wait 表示允许的时间间隔, 在该时间范围内重复调用会被重新推迟wait毫秒
// @param {boolean} immediate 表示函数调用后是否立即执行, true为立即调用, false为在时间截止时调用
// debounce方法返回一个函数, 该函数会自动调用func并进行节流控制
_.debounce = function(func, wait, immediate) {
// timeout用于记录函数上一次调用的执行状态(定时器句柄)
// 当timeout为null时, 表示上一次调用已经结束
var timeout;
// 返回一个函数, 并在函数内进行节流控制
return function() {
// 保持函数的上下文对象和参数
var context = this, args = arguments;
var later = function() {
// 设置timeout为null
// later函数会在允许的时间截止时被调用
// 调用该函数时, 表明上一次函数执行时间已经超过了约定的时间间隔, 此时之后再进行调用都是被允许的
timeout = null;
if(!immediate)
func.apply(context, args);
};
// 如果函数被设定为立即执行, 且上一次调用的时间间隔已经过去, 则立即调用函数
if(immediate && !timeout)
func.apply(context, args);
// 创建一个定时器用于检查和设置函数的调用状态
// 创建定时器之前先清空上一次settimeout句柄, 无论上一次绑定的函数是否已经被执行
// 如果本次函数在调用时, 上一次函数执行还没有开始(一般是immediate设置为false时), 则函数的执行时间会被推迟, 因此timeout句柄会被重新创建
cleartimeout(timeout);
// 在允许的时间截止时调用later函数
timeout = settimeout(later, wait);
};
};
// 创建一个只会被执行一次的函数, 如果该函数被重复调用, 将返回第一次执行的结果
// 该函数用于获取和计算固定数据的逻辑, 如获取用户所用的浏览器类型
_.once = function(func) {
// ran记录函数是否被执行过
// memo记录函数最后一次执行的结果
var ran = false, memo;
return function() {
// 如果函数已被执行过, 则直接返回第一次执行的结果
if(ran)
return memo;
ran = true;
return memo = func.apply(this, arguments);
};
};
// 返回一个函数, 该函数会将当前函数作为参数传递给一个包裹函数
// 在包裹函数中可以通过第一个参数调用当前函数, 并返回结果
// 一般用于多个流程处理函数的低耦合组合调用
_.wrap = function(func, wrapper) {
return function() {
// 将当前函数作为第一个参数, 传递给wrapper函数
var args = [func].concat(slice.call(arguments, 0));
// 返回wrapper函数的处理结果
return wrapper.apply(this, args);
};
};
// 将多个函数组合到一起, 按照参数传递的顺序, 后一个函数的返回值会被一次作为参数传递给前一个函数作为参数继续处理
// _.compose(a, b, c); 等同于 a(b(c()));
// 该方法的缺点在于被关联的函数处理的参数数量只能有一个, 如果需要传递多个参数, 可以通过array或object复合数据类型进行组装
_.compose = function() {
// 获取函数列表, 所有参数需均为function类型
var funcs = arguments;
// 返回一个供调用的函数句柄
return function() {
// 从后向前依次执行函数, 并将记录的返回值作为参数传递给前一个函数继续处理
var args = arguments;
for(var i = funcs.length - 1; i >= 0; i--) {
args = [funcs[i].apply(this, args)];
}
// 返回最后一次调用函数的返回值
return args[0];
};
};
// 返回一个函数, 该函数作为调用计数器, 当该函数被调用times次(或超过times次)后, func函数将被执行
// after方法一般用作异步的计数器, 例如在多个ajax请求全部完成后需要执行一个函数, 则可以使用after在每个ajax请求完成后调用
_.after = function(times, func) {
// 如果没有指定或指定无效次数, 则func被直接调用
if(times <= 0)
return func();
// 返回一个计数器函数
return function() {
// 每次调用计数器函数times减1, 调用times次之后执行func函数并返回func函数的返回值
if(--times < 1) {
return func.apply(this, arguments);
}
};
};
// 对象相关方法
// ----------------
// 获取一个对象的属性名列表(不包含原型链中的属性)
_.keys = nativekeys ||
function(obj) {
if(obj !== object(obj))
throw new typeerror('invalid object');
var keys = [];
// 记录并返回对象的所有属性名
for(var key in obj)
if(_.has(obj, key))
keys[keys.length] = key;
return keys;
};
// 返回一个对象中所有属性的值列表(不包含原型链中的属性)
_.values = function(obj) {
return _.map(obj, _.identity);
};
// 获取一个对象中所有属性值为function类型的key列表, 并按key名进行排序(包含原型链中的属性)
_.functions = _.methods = function(obj) {
var names = [];
for(var key in obj) {
if(_.isfunction(obj[key]))
names.push(key);
}
return names.sort();
};
// 将一个或多个对象的属性(包含原型链中的属性), 复制到obj对象, 如果存在同名属性则覆盖
_.extend = function(obj) {
// each循环参数中的一个或多个对象
each(slice.call(arguments, 1), function(source) {
// 将对象中的全部属性复制或覆盖到obj对象
for(var prop in source) {
obj[prop] = source[prop];
}
});
return obj;
};
// 返回一个新对象, 并从obj中复制指定的属性到新对象中
// 第2个参数开始为指定的需要复制的属性名(支持多个参数和深层数组)
_.pick = function(obj) {
// 创建一个对象, 存放复制的指定属性
var result = {};
// 从第二个参数开始合并为一个存放属性名列表的数组
each(_.flatten(slice.call(arguments, 1)), function(key) {
// 循环属性名列表, 如果obj中存在该属性, 则将其复制到result对象
if( key in obj)
result[key] = obj[key];
});
// 返回复制结果
return result;
};
// 将obj中不存在或转换为boolean类型后值为false的属性, 从参数中指定的一个或多个对象中复制到obj
// 一般用于给对象指定默认值
_.defaults = function(obj) {
// 从第二个参数开始可指定多个对象, 这些对象中的属性将被依次复制到obj对象中(如果obj对象中不存在该属性的话)
each(slice.call(arguments, 1), function(source) {
// 遍历每个对象中的所有属性
for(var prop in source) {
// 如果obj中不存在或属性值转换为boolean类型后值为false, 则将属性复制到obj中
if(obj[prop] == null)
obj[prop] = source[prop];
}
});
return obj;
};
// 创建一个obj的副本, 返回一个新的对象, 该对象包含obj中的所有属性和值的状态
// clone函数不支持深层复制, 例如obj中的某个属性存放着一个对象, 则该对象不会被复制
// 如果obj是一个数组, 则会创建一个相同的数组对象
_.clone = function(obj) {
// 不支持非数组和对象类型的数据
if(!_.isobject(obj))
return obj;
// 复制并返回数组或对象
return _.isarray(obj) ? obj.slice() : _.extend({}, obj);
};
// 执行一个函数, 并将obj作为参数传递给该函数, 函数执行完毕后最终返回obj对象
// 一般在创建一个方法链的时候会使用tap方法, 例如:
// _(obj).chain().tap(click).tap(mouseover).tap(mouseout);
_.tap = function(obj, interceptor) {
interceptor(obj);
return obj;
};
// eq函数只在isequal方法中调用, 用于比较两个数据的值是否相等
// 与 === 不同在于, eq更关注数据的值
// 如果进行比较的是两个复合数据类型, 不仅仅比较是否来自同一个引用, 且会进行深层比较(对两个对象的结构和数据进行比较)
function eq(a, b, stack) {
// 检查两个简单数据类型的值是否相等
// 对于复合数据类型, 如果它们来自同一个引用, 则认为其相等
// 如果被比较的值其中包含0, 则检查另一个值是否为-0, 因为 0 === -0 是成立的
// 而 1 / 0 == 1 / -0 是不成立的(1 / 0值为infinity, 1 / -0值为-infinity, 而infinity不等于-infinity)
if(a === b)
return a !== 0 || 1 / a == 1 / b;
// 将数据转换为布尔类型后如果值为false, 将判断两个值的数据类型是否相等(因为null与undefined, false, 0, 空字符串, 在非严格比较下值是相等的)
if(a == null || b == null)
return a === b;
// 如果进行比较的数据是一个underscore封装的对象(具有_chain属性的对象被认为是underscore对象)
// 则将对象解封后获取本身的数据(通过_wrapped访问), 然后再对本身的数据进行比较
// 它们的关系类似与一个jquery封装的dom对象, 和浏览器本身创建的dom对象
if(a._chain)
a = a._wrapped;
if(b._chain)
b = b._wrapped;
// 如果对象提供了自定义的isequal方法(此处的isequal方法并非undersocre对象的isequal方法, 因为在上一步已经对undersocre对象进行了解封)
// 则使用对象自定义的isequal方法与另一个对象进行比较
if(a.isequal && _.isfunction(a.isequal))
return a.isequal(b);
if(b.isequal && _.isfunction(b.isequal))
return b.isequal(a);
// 对两个数据的数据类型进行验证
// 获取对象a的数据类型(通过object.prototype.tostring方法)
var classname = tostring.call(a);
// 如果对象a的数据类型与对象b不匹配, 则认为两个数据值也不匹配
if(classname != tostring.call(b))
return false;
// 执行到此处, 可以确保需要比较的两个数据均为复合数据类型, 且数据类型相等
// 通过switch检查数据的数据类型, 针对不同数据类型进行不同的比较
// (此处不包括对数组和对象类型, 因为它们可能包含更深层次的数据, 将在后面进行深层比较)
switch (classname) {
case '[object string]':
// 如果被比较的是字符串类型(其中a的是通过new string()创建的字符串)
// 则将b转换为string对象后进行匹配(这里匹配并非进行严格的数据类型检查, 因为它们并非来自同一个对象的引用)
// 在调用 == 进行比较时, 会自动调用对象的tostring()方法, 返回两个简单数据类型的字符串
return a == string(b);
case '[object number]':
// 通过+a将a转成一个number, 如果a被转换之前与转换之后不相等, 则认为a是一个nan类型
// 因为nan与nan是不相等的, 因此当a值为nan时, 无法简单地使用a == b进行匹配, 而是用相同的方法检查b是否为nan(即 b != +b)
// 当a值是一个非nan的数据时, 则检查a是否为0, 因为当b为-0时, 0 === -0是成立的(实际上它们在逻辑上属于两个不同的数据)
return a != +a ? b != +b : (a == 0 ? 1 / a == 1 / b : a == +b);
case '[object date]':
// 对日期类型没有使用return或break, 因此会继续执行到下一步(无论数据类型是否为boolean类型, 因为下一步将对boolean类型进行检查)
case '[object boolean]':
// 将日期或布尔类型转换为数字
// 日期类型将转换为数值类型的时间戳(无效的日期格式将被换转为nan)
// 布尔类型中, true被转换为1, false被转换为0
// 比较两个日期或布尔类型被转换为数字后是否相等
return +a == +b;
case '[object regexp]':
// 正则表达式类型, 通过source访问表达式的字符串形式
// 检查两个表达式的字符串形式是否相等
// 检查两个表达式的全局属性是否相同(包括g, i, m)
// 如果完全相等, 则认为两个数据相等
return a.source == b.source && a.global == b.global && a.multiline == b.multiline && a.ignorecase == b.ignorecase;
}
// 当执行到此时, ab两个数据应该为类型相同的对象或数组类型
if( typeof a != 'object' || typeof b != 'object')
return false;
// stack(堆)是在isequal调用eq函数时内部传递的空数组, 在后面比较对象和数据的内部迭代中调用eq方法也会传递
// length记录堆的长度
var length = stack.length;
while(length--) {
// 如果堆中的某个对象与数据a匹配, 则认为相等
if(stack[length] == a)
return true;
}
// 将数据a添加到堆中
stack.push(a);
// 定义一些局部变量
var size = 0, result = true;
// 通过递归深层比较对象和数组
if(classname == '[object array]') {
// 被比较的数据为数组类型
// size记录数组的长度
// result比较两个数组的长度是否一致, 如果长度不一致, 则方法的最后将返回result(即false)
size = a.length;
result = size == b.length;
// 如果两个数组的长度一致
if(result) {
// 调用eq方法对数组中的元素进行迭代比较(如果数组中包含二维数组或对象, eq方法会进行深层比较)
while(size--) {
// 在确保两个数组都存在当前索引的元素时, 调用eq方法深层比较(将堆数据传递给eq方法)
// 将比较的结果存储到result变量, 如果result为false(即在比较中得到某个元素的数据不一致), 则停止迭代
if(!( result = size in a == size in b && eq(a[size], b[size], stack)))
break;
}
}
} else {
// 被比较的数据为对象类型
// 如果两个对象不是同一个类的实例(通过constructor属性比较), 则认为两个对象不相等
if('constructor' in a != 'constructor' in b || a.constructor != b.constructor)
return false;
// 深层比较两个对象中的数据
for(var key in a) {
if(_.has(a, key)) {
// size用于记录比较过的属性数量, 因为这里遍历的是a对象的属性, 并比较b对象中该属性的数据
// 当b对象中的属性数量多余a对象时, 此处的逻辑成立, 但两个对象并不相等
size++;
// 迭代调用eq方法, 深层比较两个对象中的属性值
// 将比较的结果记录到result变量, 当比较到不相等的数据时停止迭代
if(!( result = _.has(b, key) && eq(a[key], b[key], stack)))
break;
}
}
// 深层比较完毕, 这里已经可以确保在对象a中的所有数据, 对象b中也存在相同的数据
// 根据size(对象属性长度)检查对象b中的属性数量是否与对象a相等
if(result) {
// 遍历对象b中的所有属性
for(key in b) {
// 当size已经到0时(即对象a中的属性数量已经遍历完毕), 而对象b中还存在有属性, 则对象b中的属性多于对象a
if(_.has(b, key) && !(size--))
break;
}
// 当对象b中的属性多于对象a, 则认为两个对象不相等
result = !size;
}
}
// 函数执行完毕时, 从堆中移除第一个数据(在比较对象或数组时, 会迭代eq方法, 堆中可能存在多个数据)
stack.pop();
// 返回的result记录了最终的比较结果
return result;
}
// 对两个数据的值进行比较(支持复合数据类型), 内部函数eq的外部方法
_.isequal = function(a, b) {
return eq(a, b, []);
};
// 检查数据是否为空值, 包含'', false, 0, null, undefined, nan, 空数组(数组长度为0)和空对象(对象本身没有任何属性)
_.isempty = function(obj) {
// obj被转换为boolean类型后值为false
if(obj == null)
return true;
// 检查对象或字符串长度是否为0
if(_.isarray(obj) || _.isstring(obj))
return obj.length === 0;
// 检查对象(使用for in循环时将首先循环对象本身的属性, 其次是原型链中的属性), 因此如果第一个属性是属于对象本身的, 那么该对象不是一个空对象
for(var key in obj)
if(_.has(obj, key))
return false;
// 所有数据类型均没有通过验证, 是一个空数据
return true;
};
// 验证对象是否是一个dom对象
_.iselement = function(obj) {
return !!(obj && obj.nodetype == 1);
};
// 验证对象是否是一个数组类型, 优先调用宿主环境提供的isarray方法
_.isarray = nativeisarray ||
function(obj) {
return tostring.call(obj) == '[object array]';
};
// 验证对象是否是一个复合数据类型的对象(即非基本数据类型string, boolean, number, null, undefined)
// 如果基本数据类型通过new进行创建, 则也属于对象类型
_.isobject = function(obj) {
return obj === object(obj);
};
// 检查一个数据是否是一个arguments参数对象
_.isarguments = function(obj) {
return tostring.call(obj) == '[object arguments]';
};
// 验证isarguments函数, 如果运行环境无法正常验证arguments类型的数据, 则重新定义isarguments方法
if(!_.isarguments(arguments)) {
// 对于环境无法通过tostring验证arguments类型的, 则通过调用arguments独有的callee方法来进行验证
_.isarguments = function(obj) {
// callee是arguments的一个属性, 指向对arguments所属函数自身的引用
return !!(obj && _.has(obj, 'callee'));
};
}
// 验证对象是否是一个函数类型
_.isfunction = function(obj) {
return tostring.call(obj) == '[object function]';
};
// 验证对象是否是一个字符串类型
_.isstring = function(obj) {
return tostring.call(obj) == '[object string]';
};
// 验证对象是否是一个数字类型
_.isnumber = function(obj) {
return tostring.call(obj) == '[object number]';
};
// 检查一个数字是否为有效数字且有效范围(number类型, 值在负无穷大 - 正无穷大之间)
_.isfinite = function(obj) {
return _.isnumber(obj) && isfinite(obj);
};
// 检查数据是否为nan类型(所有数据中只有nan与nan不相等)
_.isnan = function(obj) {
return obj !== obj;
};
// 检查数据是否时boolean类型
_.isboolean = function(obj) {
// 支持字面量和对象形式的boolean数据
return obj === true || obj === false || tostring.call(obj) == '[object boolean]';
};
// 检查数据是否是一个date类型
_.isdate = function(obj) {
return tostring.call(obj) == '[object date]';
};
// 检查数据是否是一个正则表达式类型
_.isregexp = function(obj) {
return tostring.call(obj) == '[object regexp]';
};
// 检查数据是否是null值
_.isnull = function(obj) {
return obj === null;
};
// 检查数据是否是undefined(未定义的)值
_.isundefined = function(obj) {
return obj ===
void 0;
};
// 检查一个属性是否属于对象本身, 而非原型链中
_.has = function(obj, key) {
return hasownproperty.call(obj, key);
};
// 工具函数
// -----------------
// 放弃_(下划线)命名的underscore对象, 并返回underscore对象, 一般用于避免命名冲突或规范命名方式
// 例如:
// var us = _.noconflict(); // 取消_(下划线)命名, 并将underscore对象存放于us变量中
// console.log(_); // _(下划线)已经无法再访问underscore对象, 而恢复为underscore定义前的值
_.noconflict = function() {
// previousunderscore变量记录了underscore定义前_(下划线)的值
root._ = previousunderscore;
return this;
};
// 返回与参数相同的值, 一般用于将一个数据的获取方式转换为函数获取方式(内部用于构建方法时作为默认处理器函数)
_.identity = function(value) {
return value;
};
// 使指定的函数迭代执行n次(无参数)
_.times = function(n, iterator, context) {
for(var i = 0; i < n; i++)
iterator.call(context, i);
};
// 将html字符串中的特殊字符转换为html实体, 包含 & < > " ' \
_.escape = function(string) {
return ('' + string).replace(/&/g, '&').replace(/</g, '<').replace(/>/g, '>').replace(/"/g, '"').replace(/'/g, ''').replace(/\//g, '/');
};
// 指定一个对象的属性, 返回该属性对应的值, 如果该属性对应的是一个函数, 则会执行该函数并返回结果
_.result = function(object, property) {
if(object == null)
return null;
// 获取对象的值
var value = object[property];
// 如果值是一个函数, 则执行并返回, 否则将直接返回
return _.isfunction(value) ? value.call(object) : value;
};
// 添加一系列自定义方法到underscore对象中, 用于扩展underscore插件
_.mixin = function(obj) {
// obj是一个集合一系列自定义方法的对象, 此处通过each遍历对象的方法
each(_.functions(obj), function(name) {
// 通过addtowrapper函数将自定义方法添加到underscore构建的对象中, 用于支持对象式调用
// 同时将方法添加到 _ 本身, 用于支持函数式调用
addtowrapper(name, _[name] = obj[name]);
});
};
// 获取一个全局唯一标识, 标识从0开始累加
var idcounter = 0;
// prefix表示标识的前缀, 如果没有指定前缀则直接返回标识, 一般用于给对象或dom创建唯一id
_.uniqueid = function(prefix) {
var id = idcounter++;
return prefix ? prefix + id : id;
};
// 定义模板的界定符号, 在template方法中使用
_.templatesettings = {
// javascript可执行代码的界定符
evaluate : /<%([\s\s]+?)%>/g,
// 直接输出变量的界定符
interpolate : /<%=([\s\s]+?)%>/g,
// 需要将html输出为字符串(将特殊符号转换为字符串形式)的界定符
escape : /<%-([\s\s]+?)%>/g
};
var nomatch = /.^/;
// escapes对象记录了需要进行相互换转的特殊符号与字符串形式的对应关系, 在两者进行相互转换时作为索引使用
// 首先根据字符串形式定义特殊字符
var escapes = {
'\\' : '\\',
"'" : "'",
'r' : '\r',
'n' : '\n',
't' : '\t',
'u2028' : '\u2028',
'u2029' : '\u2029'
};
// 遍历所有特殊字符字符串, 并以特殊字符作为key记录字符串形式
for(var p in escapes)
escapes[escapes[p]] = p;
// 定义模板中需要替换的特殊符号, 包含反斜杠, 单引号, 回车符, 换行符, 制表符, 行分隔符, 段落分隔符
// 在将字符串中的特殊符号转换为字符串形式时使用
var escaper = /\\|'|\r|\n|\t|\u2028|\u2029/g;
// 在将字符串形式的特殊符号进行反转(替换)时使用
var unescaper = /\\(\\|'|r|n|t|u2028|u2029)/g;
// 反转字符串中的特殊符号
// 在模板中涉及到需要执行的javascript源码, 需要进行特殊符号反转, 否则如果以html实体或字符串形式出现, 会抛出语法错误
var unescape = function(code) {
return code.replace(unescaper, function(match, escape) {
return escapes[escape];
});
};
// underscore模板解析方法, 用于将数据填充到一个模板字符串中
// 模板解析流程:
// 1. 将模板中的特殊符号转换为字符串
// 2. 解析escape形式标签, 将内容解析为html实体
// 3. 解析interpolate形式标签, 输出变量
// 4. 解析evaluate形式标签, 创建可执行的javascript代码
// 5. 生成一个处理函数, 该函数在得到数据后可直接填充到模板并返回填充后的字符串
// 6. 根据参数返回填充后的字符串或处理函数的句柄
// -------------------
// 在模板体内, 可通过argments获取2个参数, 分别为填充数据(名称为obj)和underscore对象(名称为_)
_.template = function(text, data, settings) {
// 模板配置, 如果没有指定配置项, 则使用templatesettings中指定的配置项
settings = _.defaults(settings || {}, _.templatesettings);
// 开始将模板解析为可执行源码
var source = "__p+='" + text.replace(escaper, function(match) {
// 将特殊符号转移为字符串形式
return '\\' + escapes[match];
}).replace(settings.escape || nomatch, function(match, code) {
// 解析escape形式标签 <%- %>, 将变量中包含的html通过_.escape函数转换为html实体
return "'+\n_.escape(" + unescape(code) + ")+\n'";
}).replace(settings.interpolate || nomatch, function(match, code) {
// 解析interpolate形式标签 <%= %>, 将模板内容作为一个变量与其它字符串连接起来, 则会作为一个变量输出
return "'+\n(" + unescape(code) + ")+\n'";
}).replace(settings.evaluate || nomatch, function(match, code) {
// 解析evaluate形式标签 <% %>, evaluate标签中存储了需要执行的javascript代码, 这里结束当前的字符串拼接, 并在新的一行作为javascript语法执行, 并将后面的内容再次作为字符串的开始, 因此evaluate标签内的javascript代码就能被正常执行
return "';\n" + unescape(code) + "\n;__p+='";
}) + "';\n";
if(!settings.variable)
source = 'with(obj||{}){\n' + source + '}\n';
source = "var __p='';" + "var print=function(){__p+=array.prototype.join.call(arguments, '')};\n" + source + "return __p;\n";
// 创建一个函数, 将源码作为函数执行体, 将obj和underscore作为参数传递给该函数
var render = new function(settings.variable || 'obj', '_', source);
// 如果指定了模板的填充数据, 则替换模板内容, 并返回替换后的结果
if(data)
return render(data, _);
// 如果没有指定填充数据, 则返回一个函数, 该函数用于将接收到的数据替换到模板
// 如果在程序中会多次填充相同模板, 那么在第一次调用时建议不指定填充数据, 在获得处理函数的引用后, 再直接调用会提高运行效率
var template = function(data) {
return render.call(this, data, _);
};
// 将创建的源码字符串添加到函数对象中, 一般用于调试和测试
template.source = 'function(' + (settings.variable || 'obj') + '){\n' + source + '}';
// 没有指定填充数据的情况下, 返回处理函数句柄
return template;
};
// 支持underscore对象的方法链操作, 可参考 wrapper.prototype.chain
_.chain = function(obj) {
return _(obj).chain();
};
// underscore对象封装相关方法
// ---------------
// 创建一个包装器, 将一些原始数据进行包装
// 所有的undersocre对象, 内部均通过wrapper函数进行构造和封装
// underscore与wrapper的内部关系:
// -内部定义变量_, 将underscore相关的方法添加到_, 这样就可以支持函数式的调用, 如_.bind()
// -内部定义wrapper类, 将_的原型对象指向wrapper类的原型
// -将underscore相关的方法添加到wrapper原型, 创建的_对象就具备了underscore的方法
// -将array.prototype相关方法添加到wrapper原型, 创建的_对象就具备了array.prototype中的方法
// -new _()时实际创建并返回了一个wrapper()对象, 并将原始数组存储到_wrapped变量, 并将原始值作为第一个参数调用对应方法
var wrapper = function(obj) {
// 原始数据存放在包装对象的_wrapped属性中
this._wrapped = obj;
};
// 将underscore的原型对象指向wrapper的原型, 因此通过像wrapper原型中添加方法, underscore对象也会具备同样的方法
_.prototype = wrapper.prototype;
// 返回一个对象, 如果当前underscore调用了chain()方法(即_chain属性为true), 则返回一个被包装的underscore对象, 否则返回对象本身
// result函数用于在构造方法链时返回underscore的包装对象
var result = function(obj, chain) {
return chain ? _(obj).chain() : obj;
};
// 将一个自定义方法添加到underscore对象中(实际是添加到wrapper的原型中, 而underscore对象的原型指向了wrapper的原型)
var addtowrapper = function(name, func) {
// 向wrapper原型中添加一个name函数, 该函数调用func函数, 并支持了方法链的处理
wrapper.prototype[name] = function() {
// 获取func函数的参数, 并将当前的原始数据添加到第一个参数
var args = slice.call(arguments);
unshift.call(args, this._wrapped);
// 执行函数并返回结果, 并通过result函数对方法链进行封装, 如果当前调用了chain()方法, 则返回封装后的underscore对象, 否则返回对象本身
return result(func.apply(_, args), this._chain);
};
};
// 将内部定义的_(下划线, 即underscore方法集合对象)中的方法复制到wrapper的原型链中(即underscore的原型链中)
// 这是为了在构造对象式调用的underscore对象时, 这些对象也会具有内部定义的underscore方法
_.mixin(_);
// 将array.prototype中的相关方法添加到underscore对象中, 因此在封装后的underscore对象中也可以直接调用array.prototype中的方法
// 如: _([]).push()
each(['pop', 'push', 'reverse', 'shift', 'sort', 'splice', 'unshift'], function(name) {
// 获取array.prototype中对应方法的引用
var method = arrayproto[name];
// 将该方法添加到underscore对象中(实际是添加到wrapper的原型对象, 因此在创建underscore对象时同时具备了该方法)
wrapper.prototype[name] = function() {
// _wrapped变量中存储underscore对象的原始值
var wrapped = this._wrapped;
// 调用array对应的方法并返回结果
method.apply(wrapped, arguments);
var length = wrapped.length;
if((name == 'shift' || name == 'splice') && length === 0)
delete wrapped[0];
// 即使是对于array中的方法, underscore同样支持方法链操作
return result(wrapped, this._chain);
};
});
// 作用同于上一段代码, 将数组中的一些方法添加到underscore对象, 并支持了方法链操作
// 区别在于上一段代码所添加的函数, 均返回array对象本身(也可能是封装后的array), concat, join, slice方法将返回一个新的array对象(也可能是封装后的array)
each(['concat', 'join', 'slice'], function(name) {
var method = arrayproto[name];
wrapper.prototype[name] = function() {
return result(method.apply(this._wrapped, arguments), this._chain);
};
});
// 对underscore对象进行链式操作的声明方法
wrapper.prototype.chain = function() {
// this._chain用来标示当前对象是否使用链式操作
// 对于支持方法链操作的数据, 一般在具体方法中会返回一个underscore对象, 并将原始值存放在_wrapped属性中, 也可以通过value()方法获取原始值
this._chain = true;
return this;
};
// 返回被封装的underscore对象的原始值(存放在_wrapped属性中)
wrapper.prototype.value = function() {
return this._wrapped;
};
}).call(this);