原文:https://zhehuaxuan.github.io/… 作者:zhehuaxuan目的Underscore 是一个 JavaScript 工具库,它提供了一整套函数式编程的实用功能,但是没有扩展任何 JavaScript 内置对象。本文主要梳理underscore内部的函数组织与调用逻辑的方式和思想。通过这篇文章,我们可以:了解underscore在函数组织方面的巧妙构思;为自己书写函数库提供一定思路;我们开始!自己写个函数库前端的小伙伴一定不会对jQuery陌生,经常使用$.xxxx的形式进行调用,underscore使用_.xxxx,如果自己在ES5语法中写过自定义模块的话,就可以写出下面一段代码://IIFE函数(function(){ //获取全局对象 var root = this; //定义对象 var _ = {}; //定义和实现函数 .first = function(arr,n){ var n = n || 0; if(n==0) return arr[0]; return arr.slice(0,n); } //绑定在全局变量上面 root. = ;})();console.log(this);在Chrome浏览器中打开之后,打印出如下结果:我们看到在全局对象下有一个_属性,属性下面挂载了自定义函数。 我们不妨使用.first(xxxx)在全局环境下直接调用。console.log(.first([1,2,3,4]));console.log(.first([1,2,3,4],1));console.log(.first([1,2,3,4],3));输出结果如下:没问题,我们的函数库制作完成了,我们一般直接这么用,也不会有太大问题。underscore是怎么做的?underscore正是基于上述代码进行完善,那么underscore是如何接着往下做的呢?容我娓娓道来!对兼容性的考虑首先是对兼容性的考虑,工具库当然需要考虑各种运行环境。// Establish the root object, window (self) in the browser, global// on the server, or this in some virtual machines. We use self// instead of window for WebWorker support.var root = typeof self == ‘object’ && self.self === self && self || typeof global == ‘object’ && global.global === global && global || this || {};上面是underscore1.9.1在IIFE函数中的源码,对应于我们上面自己写的var root = this;。在源码中作者也作了解释: 创建root对象,并且给root赋值。怎么赋值呢?浏览器端:window也可以是window.self或者直接self服务端(node):globalWebWorker:self虚拟机:thisunderscore充分考虑了兼容性,使得root指向对局对象。支持两种不同风格的函数调用在underscore中我们可以使用以下两种方式调用:函数式的调用:console.log(.first([1,2,3,4]));对象式调用:console.log(([1,2,3,4])).first();在underscore中,它们返回的结果都是相同的。第一种方式我们现在就没有问题,难点就是第二种方式的实现。对象式调用的实现解决这个问题要达到两个目的:是一个函数,并且调用返回一个对象;这个对象依然能够调用挂载在_对象上声明的方法。我们来看看underscore对于_的实现:var _ = function(obj) { if (obj instanceof ) return obj; if (!(this instanceof )) return new (obj); this.wrapped = obj;};不怕,我们不妨调用([1,2,3,4]))看看他是怎么执行的!第一步:if (obj instanceof ) return obj;传入的对象及其原型链上有_类型的对象,则返回自身。我们这里的[1,2,3,4]显然不是,跳过。第二步:if (!(this instanceof )) return new (obj);,如果当前的this对象及其原型链上没有_类型的对象,那么执行new操作。调用([1,2,3,4]))时,this为window,那么(this instanceof )为false,所以我们执行new ([1,2,3,4])。第三步:执行new ([1,2,3,4]),继续调用_函数,这时obj为[1,2,3,4]this为一个新对象,并且这个对象的__proto__指向.prototype(对于new对象执行有疑问,请猛戳此处)此时(obj instanceof )为false(this instanceof )为true所以此处会执行this.wrapped = obj;,在新对象中,添加_wrapped属性,将[1,2,3,4]挂载进去。综合上述函数实现的效果就是: ([1,2,3,4]))<=====>new ([1,2,3,4])然后执行如下构造函数:var _ = function(obj){ this.wrapped = obj}最后得到的对象为:我们执行如下代码:console.log(([1,2,3,4]));console.log(.prototype);console.log(([1,2,3,4]).proto == .prototype);看一下打印的信息:这表明通过(obj)构建出来的对象确实具有两个特征:下面挂载了我们传入的对象/数组对象的_proto_属性指向_的prototype到此我们已经完成了第一个问题。接着解决第二个问题:这个对象依然能够调用挂载在_对象上声明的方法我们先来执行如下代码:([1,2,3,4]).first();此时JavaScript执行器会先去找([1,2,3,4])返回的对象上是否有first属性,如果没有就会顺着对象的原型链上去找first属性,直到找到并执行它。我们发现([1,2,3,4])返回的对象属性和原型链上都没有first!那我们自己先在.prototype上面加一个first属性上去试试:(function(){ //定义 var root = typeof self == ‘object’ && self.self === self && self || typeof global == ‘object’ && global.global === global && global || this || {}; var _ = function(obj) { if (obj instanceof ) return obj; if (!(this instanceof )) return new (obj); this.wrapped = obj; }; .first = function(arr,n){ var n = n || 0; if(n==0) return arr[0]; return arr.slice(0,n); } .prototype.first = function(arr,n){ var n = n || 0; if(n==0) return arr[0]; return arr.slice(0,n); } root. = ;})();我们在执行打印一下:console.log(([1,2,3,4]));效果如下:原型链上找到了first函数,我们可以调用first函数了。如下:console.log(([1,2,3,4]).first());可惜报错了:于是调试一下:我们发现arr是undefined,但是我们希望arr是[1,2,3,4]。我们马上改一下.prototype.first的实现(function(){ var root = typeof self == ‘object’ && self.self === self && self || typeof global == ‘object’ && global.global === global && global || this || {}; var _ = function(obj) { if (obj instanceof ) return obj; if (!(this instanceof )) return new (obj); this.wrapped = obj; }; .first = function(arr,n){ var n = n || 0; if(n==0) return arr[0]; return arr.slice(0,n); } .prototype.first = function(arr,n=0){ arr = this.wrapped; if(n==0) return arr[0]; return arr.slice(0,n); } root. = ;})();我们在执行一下代码:console.log(([1,2,3,4]).first());效果如下:我们的效果似乎已经达到了!现在我们执行下面的代码:console.log(([1,2,3,4]).first(2));调试一下:凉凉了。其实我们希望的是:将[1,2,3,4]和2以arguments的形式传入first函数我们再来改一下: //.prototype.first = function(arr,n=0){ // arr = this.wrapped; // if(n==0) return arr[0]; // return arr.slice(0,n); //} .prototype.first=function(){ /** * 搜集待传入的参数 */ var that = this.wrapped; var args = [that].concat(Array.from(arguments)); console.log(args); }我们再执行下面代码:([1,2,3,4]).first(2);看一下打印的效果:参数都已经拿到了。我们调用函数一下first函数,我们继续改代码:.prototype.first=function(){ /** * 搜集待传入的参数 / var that = this._wrapped; var args = [that].concat(Array.from(arguments)); /* * 调用在_属性上的first函数 */ return .first(…args);}这样一来.prototype上面的函数的实现都省掉了,相当于做一层代理;而且我们不用再维护两套代码,一旦修改实现,两边都要改。一举两得!执行一下最初我们的代码:console.log(.first([1,2,3,4]));console.log(.first([1,2,3,4],1));console.log(.first([1,2,3,4],3));现在好像我们所有的问题都解决了。但是似乎还是怪怪的。 我们每声明一个函数都得在原型链上也声明一个同名函数。形如下面:.a = function(args){ //a的实现}.prototype.a = function(){ //调用.a(args)}.b = function(args){ //b的实现}.prototype.b = function(){ //调用.b(args)}.c = function(args){ //c的实现}.prototype.c = function(){ //调用.c(args)}…1000个函数之后…会不会觉得太恐怖了!我们能不能改成如下这样呢?.a = function(args){ //a的实现}.b = function(args){ //b的实现}.c = function(args){ //c的实现}1000个函数之后….mixin = function(){ //将_属性中声明的函数都挂载在_prototype上面}.mixin();上面这么做好处大大的:我们可以专注于函数库的实现,不用机械式的复写prototype上的函数。underscore也正是这么做的!我们看看mixin函数在underscore中的源码实现:// Add your own custom functions to the Underscore object..mixin = function(obj) { .each(.functions(obj), function(name) { var func = [name] = obj[name]; .prototype[name] = function() { var args = [this.wrapped]; push.apply(args, arguments); return chainResult(this, func.apply(, args)); }; }); return ;}; // Add all of the Underscore functions to the wrapper object..mixin();有了上面的铺垫,这个代码一点都不难看懂,首先调用.each函数,形式如下: .each(arrs, function(item) { //遍历arrs数组中的每一个元素 }我们一想就明白,我们在_对象属性上实现了自定义函数,那么现在要把它们挂载到—.prototype属性上面,当然先要遍历它们了。我们可以猜到.functions(obj)肯定返回的是一个数组,而且这个数组肯定是存储_对象属性上面关于我们实现的各个函数的信息。我们看一下_.function(obj)的实现:.functions = .methods = function(obj) { var names = []; /** ** 遍历对象中的属性 **/ for (var key in obj) { //如果属性值是函数,那么存入names数组中 if (.isFunction(obj[key])) names.push(key); } return names.sort();};确实是这样的!我们把上述实现的代码整合起来:(function(){ /** * 保证兼容性 / var root = typeof self == ‘object’ && self.self === self && self || typeof global == ‘object’ && global.global === global && global || this || {}; /* * 在调用(obj)时,让其执行new (obj),并将obj挂载在_wrapped属性之下 / var _ = function(obj) { if (obj instanceof _) return obj; if (!(this instanceof _)) return new _(obj); this._wrapped = obj; }; //自己实现的first函数 _.first = function(arr,n){ var n = n || 0; if(n==0) return arr[0]; return arr.slice(0,n); } //判断是否是函数 .isFunction = function(obj) { return typeof obj == ‘function’ || false; }; //遍历生成数组存储_对象的函数值属性 .functions = .methods = function(obj) { var names = []; for (var key in obj) { if (.isFunction(obj[key])) names.push(key); } return names.sort(); }; //自己实现的遍历数组的函数 .each = function(arrs,callback){ for(let i=0;i<arrs.length;i++){ callback(arrs[i]); } } var ArrayProto = Array.prototype; var push = ArrayProto.push; //underscore实现的mixin函数 .mixin = function(obj) { console.log(.functions(obj)); //我们打印一下.functions()到底存储了什么? .each(.functions(obj), function(name) { var func = [name] = obj[name]; .prototype[name] = function() { var args = [this.wrapped]; push.apply(args, arguments); return func.apply(, args); }; }); return ; }; //执行minxin函数 .mixin(); root. = ;})();我们看一下.functions(obj)返回的打印信息:确实是_中自定义函数的属性值。我们再来分析一下each中callback遍历各个属性的实现逻辑。var func = [name] = obj[name]; .prototype[name] = function() { var args = [this.wrapped]; push.apply(args, arguments); return func.apply(, args);};第一句:func变量存储每个自定义函数第二句: .prototype[name]=function();在.prototype上面声明相同属性的函数第三句:args变量存储_wrapped下面挂载的值第四句:跟var args = [that].concat(Array.from(arguments));作用相似,将两边的参数结合起来第五句:执行func变量指向的函数,执行apply函数,将上下文对象_和待传入的参数args`传入即可。我们再执行以下代码:console.log(.first([1,2,3,4]));console.log(.first([1,2,3,4],1));console.log(.first([1,2,3,4],3));结果如下:Perfect!这个函数在我们的浏览器中使用已经没有问题。但是在Node中呢?又引出新的问题。再回归兼容性问题我们知道在Node中,我们是这样的://a.jslet a = 1;module.exports = a;//index.jslet b = require(’./a.js’);console.log(b) //打印1那么:let _ = require(’./underscore.js’)([1,2,3,4]).first(2);我们也希望上述的代码能够在Node中执行。所以root. = _是不够的。underscore是怎么做的呢?如下:if (typeof exports != ‘undefined’ && !exports.nodeType) { if (typeof module != ‘undefined’ && !module.nodeType && module.exports) { exports = module.exports = ; } exports. = ;} else { root. = ;}我们看到当全局属性exports不存在或者不是DOM节点时,说明它在浏览器中,所以: root. = _;如果exports存在,那么就是在Node环境下,我们再来进行判断:如果module存在,并且不是DOM节点,并且module.exports也存在的话,那么执行:exports = module.exports = ;在统一执行:exports. = _;附录下面是最后整合的阉割版underscore代码:(function(){ /* * 保证兼容性 / var root = typeof self == ‘object’ && self.self === self && self || typeof global == ‘object’ && global.global === global && global || this || {}; /* * 在调用(obj)时,让其执行new _(obj),并将obj挂载在_wrapped属性之下 */ var _ = function(obj) { if (obj instanceof _) return obj; if (!(this instanceof _)) return new _(obj); this._wrapped = obj; }; //自己实现的first函数 _.first = function(arr,n){ var n = n || 0; if(n==0) return arr[0]; return arr.slice(0,n); } //判断是否是函数 _.isFunction = function(obj) { return typeof obj == ‘function’ || false; }; //遍历生成数组存储_对象的函数值属性 _.functions = .methods = function(obj) { var names = []; for (var key in obj) { if (.isFunction(obj[key])) names.push(key); } return names.sort(); }; //自己实现的遍历数组的函数 _.each = function(arrs,callback){ for(let i=0;i<arrs.length;i++){ callback(arrs[i]); } } var ArrayProto = Array.prototype; var push = ArrayProto.push; //underscore实现的mixin函数 _.mixin = function(obj) { .each(.functions(obj), function(name) { var func = _[name] = obj[name]; _.prototype[name] = function() { var args = [this.wrapped]; push.apply(args, arguments); return func.apply(, args); }; }); return _; }; //执行minxin函数 .mixin(); if (typeof exports != ‘undefined’ && !exports.nodeType) { if (typeof module != ‘undefined’ && !module.nodeType && module.exports) { exports = module.exports = ; } exports. = ; } else { root. = _; }})();欢迎各位大佬拍砖!同时您的点赞是我写作的动力~谢谢。
...