一步一步讲解underscore源码系列（一）——项目初始化

这是underscore源码系列第一节，帮助很多第一次看源码的同学理解和循序渐进的学习源码

废话不多说，直接进入主题。

目标：学完本节我们就能把一个整体架构搭建起来，就可以往里面添加其他方法了

1.因为我们要避免全局污染，所以我们在一个自执行函数里面执行代码

(function(){


})();

2.我们都知道underscore使用_符号对函数进行调用，为了在函数外部也能调用函数内部的_符号，所以我们可以把_符号挂载到window上，这样子外面就能访问到

//此处的this为window
var root = this;

root._ = _;

3.当使用_符号调用函数的时候，可以有以下两种写法

// 函数式风格
_.each([1, 2, 3], function(item){
    console.log(item)
});

// 面向对象风格
_([1, 2, 3]).each(function(item){
    console.log(item)
});

所以我们可以得出结论，underscore是一个函数

var _=function(obj){

}

第一种方式好说，因为这是直接引用_的方法。
重点是第二种，我们如何做到_([1,2,3])返回一个对象，而这个对象又能调用_原型上的方法呢

var _ = function(obj) {
    if (!(this instanceof _)) return new _(obj);
    this._wrapped = obj;
};

这是underscore的源码，我们来解析一下其中的思想

第一步：当执行_([1,2.3]),因为此时没有new，所以this等于window，不是_的实例，返回new _(obj);
第二部：这时this是_的实例，执行this._wrapped=[1,2,3];
第三步：因为这是构造函数，所以会返回return this；这个this就是实例，实例的_proto_指向其构造函数的prototype，所以我们就可以使用_的原型上的方法了

这也是我们为什么使用构造函数创建对象的原因，构造函数原型上的方法实例都可以使用
4.可是underscore的源码都是_.each=function(){}这样子去写的，这些方法并没有挂载到原型，_([1,2,3])依然会报错，所以我们使用mixin方法把这些方法挂载到原型上,我们先来看一下underscore是如何实现mixin方法的

var ArrayProto = Array.prototype;
var push = ArrayProto.push;

_.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 _;
};

_.mixin(_);

这里面有好多underscore自定义的函数，我们稍后来一个一个讲解。
mixin的第一个作用是把_上面的方法绑定到_的prototype上面，这样_的实例就能调用了；
第二个作用就是我们可以把自定义的方法扩展到_上面,后面我们会讲扩展的方法

5.我们先来梳理一下这里面用到的方法_.each函数，我们用jquery的时候都用过，其实他就是一个迭代器，
我们想一想如何设计each方法

1.可以传递数组和对象进行遍历
2.支持循环中退出

所以我们首先要判断是不是数组想
此处的设计思想是判断length是否为number，区间为[0,Math.pow(2,53)-1]

    //这是最大索引数
    var MAX_ARRAY_INDEX = Math.pow(2, 53) - 1;

    var isArrayLike = function(collection) {
        var length = collection.length;
        return typeof length == 'number' && length >= 0 && length <= MAX_ARRAY_INDEX;
    };

所以each的方法也很简单

_.each = function(obj, callback) {
        var length, i = 0;

        if (isArrayLike(obj)) {
            length = obj.length;
            for (; i < length; i++) {
                if (callback.call(obj[i], obj[i], i) === false) {
                    break;
                }
            }
        } else {
            for (i in obj) {
                if (callback.call(obj[i], obj[i], i) === false) {
                    break;
                }
            }
        }

        return obj;
    }

6.我们来看下一个函数_.functions(obj)

这个函数是干什么的

  // 传入一个对象
  // 遍历该对象的键值对（包括 own properties 以及 原型链上的）
  // 如果某个 value 的类型是方法（function），则将该 key 存入数组
  // 将该数组排序后返回

 _.functions = function(obj) {
        var names = [];
        for (var key in obj) {
            if (_.isFunction(obj[key])) names.push(key);
        }
        return names.sort();
    };

这里面有一个_.isFunction函数，顾名思义就是判断是不是函数，实现也很简单

  _.isFunction = function(obj) {
      return typeof obj == 'function' || false;
    };

7.接下来我们再来回过头来看一下mixin源码

var ArrayProto = Array.prototype;
var push = ArrayProto.push;

_.mixin = function(obj) {
 // 遍历 obj 的 key，将方法挂载到 Underscore 上
    // 其实是将方法浅拷贝到 _.prototype 上
    _.each(_.functions(obj), function(name) {
 // 直接把方法挂载到 _[name] 上
 
        var func = _[name] = obj[name];
 // 浅拷贝
      // 将 name 方法挂载到 _ 对象的原型链上，使之能 OOP 调用
        _.prototype[name] = function() {
// 第一个参数
            var args = [this._wrapped];
  // arguments 为 name 方法需要的其他参数
         
            return func.apply(_, args);
        };
    });
    return _;
};

_.mixin(_);

因为 _[name] = obj[name] 的缘故，我们可以给 underscore 拓展自定义的方法:

比如

 _.mixin({
        addNum: function(num) {
            return num + 1;
        }
    });

    console.log(_(1).addNum());// 2

8.我们先把能跑起来的结构写一下，其他的函数都可以往里面添加

(function() {

    var root =this;

    var ArrayProto = Array.prototype;

    var push = ArrayProto.push;

    var _ = function(obj) {
        if (obj instanceof _) return obj;
        if (!(this instanceof _)) return new _(obj);
        this._wrapped = obj;
    };

  
     root._ = _;
    

    _.VERSION = '0.1';

    var MAX_ARRAY_INDEX = Math.pow(2, 53) - 1;

    var isArrayLike = function(collection) {
        var length = collection.length;
        return typeof length == 'number' && length >= 0 && length <= MAX_ARRAY_INDEX;
    };

    _.each = function(obj, callback) {
        var length, i = 0;

        if (isArrayLike(obj)) {
            length = obj.length;
            for (; i < length; i++) {
                if (callback.call(obj[i], obj[i], i) === false) {
                    break;
                }
            }
        } else {
            for (i in obj) {
                if (callback.call(obj[i], obj[i], i) === false) {
                    break;
                }
            }
        }

        return obj;
    }

    _.isFunction = function(obj) {
        return typeof obj == 'function' || false;
    };

    _.functions = function(obj) {
        var names = [];
        for (var key in obj) {
            if (_.isFunction(obj[key])) names.push(key);
        }
        return names.sort();
    };

    _.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 _;
    };

    _.mixin(_);

})()

如果对你有帮助欢迎点赞，你的认同就是我不断努力的动力

参考 https://github.com/mqyqingfeng/Blog/issues/56
https://my.oschina.net/liuyuantao/blog/783480