mvvm源码初体验(2):模板解析

mvvm 实现模板解析的关键对象是 compile 对象,它在 compile.js 中,它是一个构造函数,在 mvvm.js 中的构造方法中运行,本文的模板解析只发生在 new MVVM 时运行一次:

// 创建一个用来编译模板的compile对象
this.$compile = new Compile(options.el || document.body, this);

1
2

当 new MVVM 时,引发 Compile 调用,对它传入当前选项对象中 el 属性的值,如果没有,则传入当前文档的 body 部分,同时传入当前的实例.

取出所有子节点

把当前 MVVM 实例保存到当前 compile 实例的$vm 属性中

this.$vm = vm;

判断当前传入的选项对象中的 el 属性的值,

如果是不是一个元素节点,是就保存到当前 compile 实例的$el 中,
如果不是则把它传入 document.querySelector(),保存方法返回的元素节点.

// 保存el元素
this.$el = this.isElementNode(el) ? el : document.querySelector(el);

1
2

其中 isElementNode()方法

Compile.prototype = {
  isElementNode: function(node) {
    return node.nodeType == 1;
  }
};

1
2
3
4
5

判断 this.$el是否存在,如果存在,首先将el的所有子节点取出,添加到一个新建的文档fragment对象中,然后保存到当前Compile实例的$fragment 属性中

// 如果el元素存在
if (this.$el) {
  // 1. 取出el中所有子节点, 封装在一个framgment对象中
  this.$fragment = this.node2Fragment(this.$el);
}

1
2
3
4
5

因为 Node.appendChild()方法如果被插入的节点已经存在于当前文档的文档树中,则那个节点会首先从原先的位置移除,然后再插入到新的位置.
所以其中 this.nodeFragment()的实现细节如下,

首先创建一个 DocumentFragment,用来装载 el 的所有子节点,一个 child 变量用来运输一个个子节点
循环检查 el 的第一个子节点,如果存在,则把它剪切到 DocumentFragment 里
最后当 el 中没有了子节点,循环结束,函数也结束,返回 DocumentFragment,其中装有所有 el 的子节点

Compile.prototype = {
  node2Fragment: function (el) {
    var fragment = document.createDocumentFragment(),
      child;

    // 将原生节点拷贝到fragment
    while (child = el.firstChild) {
      fragment.appendChild(child);
    }

    return fragment;
  }

1
2
3
4
5
6
7
8
9
10
11
12

编译子节点

然后编译 fragment 中所有层次子节点,解析其中的插值和指令,得到最终包含对应真实数据的节点.

function Compile(el, vm) {
  // 保存vm
  this.$vm = vm;
  // 保存el元素
  this.$el = this.isElementNode(el) ? el : document.querySelector(el);
  // 如果el元素存在
  if (this.$el) {
    // 1. 取出el中所有子节点, 封装在一个framgment对象中
    this.$fragment = this.node2Fragment(this.$el);
    // 2. 编译fragment中所有层次子节点
    this.init();
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
13

然后 this.init()的实现细节,其实就是调用一个新方法 this.compileElement(),同时把已经完全取出的 el 的子节点 this.$fragment 传入给它使用.

Compile.prototype = {
  init: function() {
    // 编译fragment
    this.compileElement(this.$fragment);
  }
};

1
2
3
4
5
6

所以我们来看看 this.compileElement()方法的实现细节. 5.this.compileElement()能解析表达式文本节点和指令

得到所有子节点,保存到变量 childNodes 中,保存保存当前 compile 实例到变量 me 中,
保存所有子节点转为数组,然后遍历,
判断每一个数组元素,如果是元素节点,则编译元素节点的指令属性
如果是个文本节点且其文本内容中有用到大括号表达式,则编译大括号表达式的内容
如果子节点还有子节点,则把该节点传入 me.compileElement(),递归调用实现所有层次节点的编译

Compile.prototype = {
  compileElement: function(el) {
    // 得到所有子节点
    var childNodes = el.childNodes,
      // 保存当前compile实例
      me = this;
    // 遍历所有子节点
    [].slice.call(childNodes).forEach(function(node) {
      // 得到节点的文本内容
      var text = node.textContent;
      // 正则对象(匹配大括号表达式)
      var reg = /\{\{(.*)\}\}/; // {{name}}
      // 如果是元素节点
      if (me.isElementNode(node)) {
        // 编译元素节点的指令属性
        me.compile(node);
        // 如果是一个大括号表达式格式的文本节点
      } else if (me.isTextNode(node) && reg.test(text)) {
        // 编译大括号表达式格式的文本节点
        me.compileText(node, RegExp.$1); // RegExp.$1: 表达式   name
      }
      // 如果子节点还有子节点
      if (node.childNodes && node.childNodes.length) {
        // 递归调用实现所有层次节点的编译
        me.compileElement(node);
      }
    });
  }
};

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

解析表达式文本节点

首先来看看 me.compileText()实现细节:

me.compileText()调用 compileUtil.text()得到对应的 this.bind(node, vm, exp, 'text')
compileUtil.text()调用 this.bind(node, vm, exp, 'text')得到对应的更新节点函数 updater.textUpdater()
然后调用 this._getVMVal(vm, exp)来获得对应 vm._data 中的属性值
最后调用 updater.textUpdater()并且把值传入
updater.textUpdater()里面判断 val,更新 fragment 中此时对应子节点的 textContent 的值,如果是 undefined 此时对应子节点的 textContent 为空

compileText()

  compileText: function (node, exp) {
    // 调用编译工具对象解析
    compileUtil.text(node, this.$vm, exp);
  },

1
2
3
4

compileUtil.text()

var compileUtil = {
  // 解析: v-text/{{}}
  text: function(node, vm, exp) {
    this.bind(node, vm, exp, 'text');
  }
};

1
2
3
4
5
6

this.bind()

  // 真正用于解析指令的方法
  bind: function (node, vm, exp, dir) {
    /*实现初始化显示*/
    // 根据指令名(text)得到对应的更新节点函数
    var updaterFn = updater[dir + 'Updater'];
    // 如果存在调用来更新节点
    updaterFn && updaterFn(node, this._getVMVal(vm, exp));
  },

1
2
3
4
5
6
7
8

updater.textUpdater()

// 包含多个用于更新节点方法的对象
var updater = {
  // 更新节点的textContent
  textUpdater: function (node, value) {
    node.textContent = typeof value == 'undefined' ? '' : value;
  },

1
2
3
4
5
6

_getVMVal()

  // 得到表达式对应的value
  _getVMVal: function (vm, exp) {
    var val = vm._data;
    exp = exp.split('.');
    exp.forEach(function (k) {
      val = val[k];
    });
    return val;
  },

1
2
3
4
5
6
7
8
9

解析事件指令

compileElement()中调用 compile()来编译元素节点的指令属性

得到所有当前子节点的标签属性
转为数组然后遍历
取到属性名,判断是否是指令属性
如果是就取到表达式(属性值)和指令名
判断是否是事件指令
如果是则调用 compileUtil.eventHandler(node, me.$vm, exp, dir);
如果不是则调用 compileUtil[dir] && compileUtil[dir](node, me.$vm, exp);
解析完成就移除指令属性

  compile: function (node) {
    // 得到所有标签属性节点
    var nodeAttrs = node.attributes,
      me = this;
    // 遍历所有属性
    [].slice.call(nodeAttrs).forEach(function (attr) {
      // 得到属性名: v-on:click
      var attrName = attr.name;
      // 判断是否是指令属性
      if (me.isDirective(attrName)) {
        // 得到表达式(属性值): test
        var exp = attr.value;
        // 得到指令名: on:click
        var dir = attrName.substring(2);
        // 事件指令
        if (me.isEventDirective(dir)) {
          // 解析事件指令
          compileUtil.eventHandler(node, me.$vm, exp, dir);
        // 普通指令
        } else {
          // 解析普通指令
          compileUtil[dir] && compileUtil[dir](node, me.$vm, exp);
        }

        // 移除指令属性
        node.removeAttribute(attrName);
      }
    });
  },

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

所以来看看 compileUtil.eventHandler(node, me.$vm, exp, dir);

首先首先取到指令对应的事件名
取得当前指令的事件处理函数,保存到变量 fn 中,但是前提是 vm.$options.methods 和 vm.$options.methods[exp]都存在
如果事件名和处理函数都存在则绑定指定事件名和回调函数的 DOM 事件监听, 将回调函数中的 this 强制绑定为当前实例 vm

// 指令处理集合
var compileUtil = {
  // 事件处理
  eventHandler: function(node, vm, exp, dir) {
    // 得到事件名/类型: click
    var eventType = dir.split(':')[1],
      // 根据表达式得到事件处理函数(从methods中): test(){}
      fn = vm.$options.methods && vm.$options.methods[exp];
    // 如果都存在
    if (eventType && fn) {
      // 绑定指定事件名和回调函数的DOM事件监听, 将回调函数中的this强制绑定为vm
      node.addEventListener(eventType, fn.bind(vm), false);
    }
  }
};

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

解析一般指令

从上面可以知道处理解析一般指令的函数是

compileUtil\[dir\] && compileUtil\[dir\](node, me.$vm, exp)

当指令存在时调用 compileUtil[dir](node, me.$vm, exp),如果不存在,则不解析,
下面暂时跳过 v-model,后面再讲.

同上面相似,先是得到对应的指令处理函数 compileUtil. xxx
调用 bind()然后根据指令名(text)得到对应的更新节点函数
更新节点函数调用对应的方法更新子节点
- v-text---textContent 属性
- v-html---innerHTML 属性
- v-class--className 属性

// 指令处理集合
var compileUtil = {
  // 解析: v-text/{{}}
  text: function(node, vm, exp) {
    this.bind(node, vm, exp, 'text');
  },
  // 解析: v-html
  html: function(node, vm, exp) {
    this.bind(node, vm, exp, 'html');
  },
  // 解析: v-class
  class: function(node, vm, exp) {
    this.bind(node, vm, exp, 'class');
  }
};

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

  // 真正用于解析指令的方法
  bind: function (node, vm, exp, dir) {
    /*实现初始化显示*/
    // 根据指令名(text)得到对应的更新节点函数
    var updaterFn = updater[dir + 'Updater'];
    // 如果存在调用来更新节点
    updaterFn && updaterFn(node, this._getVMVal(vm, exp));
  },

1
2
3
4
5
6
7
8

// 包含多个用于更新节点方法的对象
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 = className.replace(oldValue, '').replace(/\s$/, '');
    var space = className && String(value) ? ' ' : '';
    node.className = className + space + value;
  }
};

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

将解析后的 fragment 添加到 el 中显示

function Compile(el, vm) {
    // 3. 将fragment添加到el中
    this.$el.appendChild(this.$fragment);
  }
}

1
2
3
4
5

mvvm源码初体验(2):模板解析

最后更新时间：2019-02-23 00:09:45

取出所有子节点

编译子节点

解析表达式文本节点

解析事件指令

解析一般指令

将解析后的 fragment 添加到 el 中显示

TOC

mvvm源码初体验(2):模板解析

最后更新时间：2019-02-23 00:09:45

# 取出所有子节点

# 编译子节点

# 解析表达式文本节点

# 解析事件指令

# 解析一般指令

# 将解析后的 fragment 添加到 el 中显示

TOC

取出所有子节点

编译子节点

解析表达式文本节点

解析事件指令

解析一般指令

将解析后的 fragment 添加到 el 中显示