vue简版源码 Compile

vue简版源码 Compile篇

相关链接：MVVM篇、Observer篇、Watcher篇

这篇源码里 bind 方法很重要，不管我们解析什么（除事件指令）都会调用到 bind 方法，同时给每一个都添加 Watcher 监听者。

function Compile(el, vm) {
    this.$vm = vm; // this Compile的实例  $vm 是MVVM的实例 (vm)
    // el  ==  "#app"  判断当前用户传递的el属性是元素节点还是选择器,如果是元素节点则直接保存到$el中通,
    //如果不是 则根据选择器 去查找对应的元素 然后保存
    this.$el = this.isElementNode(el) ? el : document.querySelector(el);

    //确定元素是否真正存在
    if (this.$el) { //#app
        // 文档碎片
        this.$fragment = this.node2Fragment(this.$el);
        this.init(); // 初始化数据
        this.$el.appendChild(this.$fragment); // 把文档数据添加到真实DOM
    }
}

Compile.prototype = {
    /**
     * node to fragment 把节点转换成文档碎片
     * @param el
     * @returns {DocumentFragment}
     */
    node2Fragment: function (el) { // 传递过来的元素
        var fragment = document.createDocumentFragment(),// 创建文档碎片
            child; // 创捷变量用来暂存子节点，做中转

        // 将原生节点拷贝到fragment
        while (child = el.firstChild) { // 终止条件直到el里没有子节点
            fragment.appendChild(child); // 添加子节点到文档碎片
        }

        return fragment;
    },

    /**
     * 初始化
     */
    init: function () {
        //解析所有层次的元素节点
        this.compileElement(this.$fragment);
    },

    /**
     * 解析html元素
     * @param el 元素
     */
    compileElement: function (el) {
        //初始化数据,保存所有子节点   保存this
        var childNodes = el.childNodes,
            me = this; // 留住this ，保证this的正确指向，这里的this还是指向 Compile 实例

        //对所有子节点进行递归遍历
        [].slice.call(childNodes).forEach(function (node) {
            //text节点的文本内容
            var text = node.textContent;
            //声明匹配大括号表达式的正则
            var reg = /\{\{(.*)\}\}/; //{{name+{{age}}+phone}} //()非贪婪匹配 ->name+{{age}}+phone
            // var reg = /(.*)/; //{{name}}

            //判断当前节点是不是元素节点
            if (me.isElementNode(node)) {
                // 解析指令
                me.compile(node);

                //判断当前元素是否为文本节点 并且 文本节点中是否拥有{{xxx}}
            } else if (me.isTextNode(node) && reg.test(text)) {
                // 解析文本(大括号表达式) 并且赋值
                me.compileText(node, RegExp.$1);

            }
            //如果当前节点还有子节点 那么就需要递归查找所有的子节点是否符合以上条件
            if (node.childNodes && node.childNodes.length) {
                me.compileElement(node);
            }
        });
    },

    //解析指令
    compile: function (node) {//button
        //获取元素中的所有属性节点 
        var nodeAttrs = node.attributes, // 获取元素中的所有属性，类数组
            me = this;

        // 遍历所有属性节点  [].slice.call() , 伪数组转数组的方法
        [].slice.call(nodeAttrs).forEach(function (attr) {
            var attrName = attr.name;// 取出属性名
            if (me.isDirective(attrName)) {//判断当前属性名是否为指令 (根据是否有v-)
                var exp = attr.value; // 获取指令值
                var dir = attrName.substring(2);//on:click //去掉v- 取出指令名
                // 判断当前指令是否为事件指令(是否有on)
                if (me.isEventDirective(dir)) {  // dir表示 on:click 或者 text 类型
                    //为当前元素绑定事件
                    // 参数一：传过来的元素节点
                    // 参数二： 实际上是在Compile的实例上做暂存的MVVM的实例
                    // 参数三： 指令值
                    // 参数四： 去掉v-的指令名 on:click 
                    compileUtil.eventHandler(node, me.$vm, exp, dir);
                } else {
                    // 普通指令
                    // 指令处理集合有这个方法 就执行  参数跟上面一样
                    compileUtil[dir] && compileUtil[dir](node, me.$vm, exp);
                }

                //移除解析完成的指令
                node.removeAttribute(attrName);
            }
        });
    },

    compileText: function (node, exp) {
        compileUtil.text(node, this.$vm, exp);
    },

    // 判断是不是指令的方法
    isDirective: function (attr) {
        return attr.indexOf('v-') == 0;
    },

    // 判断当前指令是否为事件指令的方法
    isEventDirective: function (dir) {
        return dir.indexOf('on') === 0;
    },

    /**
     * 判断当前的node是不是元节点节点
     * @param node 节点
     * @returns {boolean}
     */ // 是不是元素节点的方法
    isElementNode: function (node) {
        return node.nodeType == 1;
    },

    /**
     * 判断当前的node是不是文本节点
     * @param node 节点
     * @returns {boolean}
     */
    isTextNode: function (node) {
        return node.nodeType == 3;
    }
};

// 指令处理集合
var compileUtil = {
    //解析v-text指令
    text: function (node, vm, exp) {
        // 参数一：节点，参数二：MVVM的实例 ，参数三：表达式里的值,如{{name}}里的 name , 参数四：写死的一个参数名，相当于指令名 
        this.bind(node, vm, exp, 'text');
    },

    //解析v-html指令
    html: function (node, vm, exp) {
        this.bind(node, vm, exp, 'html');
    },
    //解析v-model指令
    model: function (node, vm, exp) {
        this.bind(node, vm, exp, 'model');

        var me = this, // 保存this 为了之后使用this的时候保证this指向的正确性 此时this指向 Compile 实例
            val = this._getVMVal(vm, exp);  // 获取到绑定属性的属性值
        node.addEventListener('input', function (e) {  // 给节点添加input事件
            var newValue = e.target.value; // 获取到最新的值做一下暂存
            if (val === newValue) { // 容错处理 如果新值和旧值一样就不管他 ，结束下面执行
                return;
            }

            me._setVMVal(vm, exp, newValue);  // 调用Compile实例上的方法 设置vm中data里相对应的属性值
            val = newValue;
        });
    },
    //解析v-class指令
    class: function (node, vm, exp) {
        this.bind(node, vm, exp, 'class');
    },
    //解析v-bind指令  // 很强大的一个方法，可以看到不管我们解析什么都会调用到bind方法，同时给每一个添加 Watcher 监听者
    bind: function (node, vm, exp, dir) {
        //根据指令名称获取对应的更新函数
        var updaterFn = updater[dir + 'Updater']; // 相当于 updater.textUpdater  只是dir是上面传过来的不确定，所以要用拼接的方式

        //如果更新函数存在 则执行更新
        if (updaterFn) {
            // 参数一：node 当前的文本节点 ， 参数二： 得到的是 属性值 
            // updaterFn ==> node #text {{name}}  _data.name
            // updaterFn(node, this._data.name);

            updaterFn(node, this._getVMVal(vm, exp));

        }

        //Watcher监听者   vm实例  exp表达式{{a}}/v-text="a"
        new Watcher(vm, exp, function (value, oldValue) {
            updaterFn && updaterFn(node, value, oldValue);
        });
    },

    // 事件处理
    eventHandler: function (node, vm, exp, dir) {//dir==>on:click  exp==>"show"
        //从指令名中取出事件名
        //根据指令的值(表达式)从methods中得到对应的回调函数
        var eventType = dir.split(':')[1],
            fn = vm.$options.methods && vm.$options.methods[exp];

        if (eventType && fn) {
            //给当前元素节点绑定指定的事件名和回调函数(指定this指向为vm)
            node.addEventListener(eventType, fn.bind(vm), false);
        }
    },
    //获取vm中data里相对应的属性值
    _getVMVal: function (vm, exp) { // vm实例，参数二：{{表达式}} 里的内容 ，可能直接是 neme , 也可能是 obj.name
        var val = vm._data; // 暂存一下 data 
        // {
        //     name: "aa",
        //     age: {
        //         a1: 18
        //     }
        // }

        exp = exp.split('.'); // 防止点式调用age.a1 所以转成数组 [age, a1] 
        exp.forEach(function (k) { // 循环遍历里面的每一项，最后得到我们想要的属性值 k 代表每一项
            val = val[k];
            // val = {
            //         a1: 18
            //     }
        });
        return val;
    },
    //设置vm中data里相对应的属性值
    _setVMVal: function (vm, exp, value) {
        var val = vm._data;
        exp = exp.split('.');
        exp.forEach(function (k, i) {
            // 非最后一个key，更新val的值
            if (i < exp.length - 1) {
                val = val[k];
            } else {
                val[k] = value;
            }
        });
    }
};

// a-> b ->c ->d  函数嵌套调用
// a-> a -> a -> 递归 ->特殊的函数嵌套

//更新器 操作原生DOM的方法
var updater = {
    //更新节点的textContent属性
    textUpdater: function (node, value) {
        node.textContent = typeof value == 'undefined' ? '' : value;
    },

    //更新节点的innerHTML属性
    htmlUpdater: function (node, value) {
        node.innerHTML = typeof value == 'undefined' ? '' : value;
    },

    //更新节点的className属性
    classUpdater: function (node, value, oldValue) {
        var className = node.className; //className = > "bb"

        node.className = className + (className ? ' ' : '') + value;  //bb aa


        /*    className = className.replace(oldValue, '').replace(/\s$/, '');
    
            var space = className && String(value) ? ' ' : '';*/

        // node.className = className + space + value;  //bb aa
    },

    //更新节点的value属性
    modelUpdater: function (node, value, oldValue) {
        node.value = typeof value == 'undefined' ? '' : value;
    }
};