女王控的博客

MVVM原理探究

接上文腾讯面试总结

剖析 Vue 实现原理

html 复制代码
<div id="mvvm-app">
  <input type="text" v-model="word" />
  <p>{{word}}</p>
  <button v-on:click="sayHi">change model</button>
</div>

<script src="./js/observer.js"></script>
<script src="./js/watcher.js"></script>
<script src="./js/compile.js"></script>
<script src="./js/mvvm.js"></script>
<script>
  var vm = new MVVM({
    el: '#mvvm-app',
    data: {
      word: 'Hello World!'
    },
    methods: {
      sayHi: function() {
        this.word = 'Hi, everybody!';
      }
    }
  });
</script>

效果:

实现 Observer

ok, 思路已经整理完毕,也已经比较明确相关逻辑和模块功能了,let’s do it 我们知道可以利用Obeject.defineProperty()来监听属性变动那么将需要 observe 的数据对象进行递归遍历,包括子属性对象的属性,都加上settergetter,这样的话,给这个对象的某个值赋值,就会触发setter,那么就能监听到了数据变化。

js 复制代码
var data = { name: 'kindeng' };
observe(data);
data.name = 'dmq'; // 哈哈哈,监听到值变化了 kindeng --> dmq

function observe(data) {
  if (!data || typeof data !== 'object') {
    return;
  }
  // 取出所有属性遍历
  Object.keys(data).forEach(function(key) {
    defineReactive(data, key, data[key]);
  });
}

function defineReactive(data, key, val) {
  observe(val); // 监听子属性
  Object.defineProperty(data, key, {
    enumerable: true, // 可枚举
    configurable: false, // 不能再define
    get: function() {
      return val;
    },
    set: function(newVal) {
      console.log('哈哈哈,监听到值变化了 ', val, ' --> ', newVal);
      val = newVal;
    }
  });
}

这样我们已经可以监听每个数据的变化了,那么监听到变化之后就是怎么通知订阅者了,所以接下来我们需要实现一个消息订阅器,很简单,维护一个数组,用来收集订阅者,数据变动触发 notify,再调用订阅者的 update 方法,代码改善之后是这样:

js 复制代码
// ... 省略
function defineReactive(data, key, val) {
  var dep = new Dep();
  observe(val); // 监听子属性

  Object.defineProperty(data, key, {
    // ... 省略
    set: function(newVal) {
      if (val === newVal) return;
      console.log('哈哈哈,监听到值变化了 ', val, ' --> ', newVal);
      val = newVal;
      dep.notify(); // 通知所有订阅者
    }
  });
}

function Dep() {
  this.subs = [];
}
Dep.prototype = {
  addSub: function(sub) {
    this.subs.push(sub);
  },
  notify: function() {
    this.subs.forEach(function(sub) {
      sub.update();
    });
  }
};

那么问题来了,谁是订阅者?怎么往订阅器添加订阅者?没错,上面的思路整理中我们已经明确订阅者应该是 Watcher, 而且var dep = new Dep();是在 defineReactive方法内部定义的,所以想通过dep添加订阅者,就必须要在闭包内操作,所以我们可以在 getter里面动手脚:

js 复制代码
// Observer.js
// ...省略
Object.defineProperty(data, key, {
  get: function() {
    // 由于需要在闭包内添加watcher,所以通过Dep定义一个全局target属性,暂存watcher, 添加完移除
    Dep.target && dep.addDep(Dep.target);
    return val;
  }
  // ... 省略
});

// Watcher.js
Watcher.prototype = {
  get: function(key) {
    Dep.target = this;
    this.value = data[key]; // 这里会触发属性的getter,从而添加订阅者
    Dep.target = null;
  }
};

这里已经实现了一个 Observer 了,已经具备了监听数据和数据变化通知订阅者的功能,完整代码。那么接下来就是实现 Compile 了

实现 Compile

compile 主要做的事情是解析模板指令,将模板中的变量替换成数据,然后初始化渲染页面视图,并将每个指令对应的节点绑定更新函数,添加监听数据的订阅者,一旦数据有变动,收到通知,更新视图,如图所示:

wx20180428234629

因为遍历解析的过程有多次操作 dom 节点,为提高性能和效率,会先将跟节点el转换成文档碎片fragment进行解析编译操作,解析完成,再将fragment添加回原来的真实 dom 节点中

js 复制代码
function Compile(el) {
  this.$el = this.isElementNode(el) ? el : document.querySelector(el);
  if (this.$el) {
    this.$fragment = this.node2Fragment(this.$el);
    this.init();
    this.$el.appendChild(this.$fragment);
  }
}
Compile.prototype = {
  init: function() {
    this.compileElement(this.$fragment);
  },
  node2Fragment: function(el) {
    var fragment = document.createDocumentFragment(),
      child;
    // 将原生节点拷贝到fragment
    while ((child = el.firstChild)) {
      fragment.appendChild(child);
    }
    return fragment;
  }
};

compileElement 方法将遍历所有节点及其子节点,进行扫描解析编译,调用对应的指令渲染函数进行数据渲染,并调用对应的指令更新函数进行绑定,详看代码及注释说明:

javascript 复制代码
Compile.prototype = {
  // ... 省略
  compileElement: function(el) {
    var childNodes = el.childNodes,
      me = this;
    [].slice.call(childNodes).forEach(function(node) {
      var text = node.textContent;
      var reg = /\{\{(.*)\}\}/; // 表达式文本
      // 按元素节点方式编译
      if (me.isElementNode(node)) {
        me.compile(node);
      } 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) {
    var nodeAttrs = node.attributes,
      me = this;
    [].slice.call(nodeAttrs).forEach(function(attr) {
      // 规定:指令以 v-xxx 命名
      // 如 <span v-text="content"></span> 中指令为 v-text
      var attrName = attr.name; // v-text
      if (me.isDirective(attrName)) {
        var exp = attr.value; // content
        var dir = attrName.substring(2); // text
        if (me.isEventDirective(dir)) {
          // 事件指令, 如 v-on:click
          compileUtil.eventHandler(node, me.$vm, exp, dir);
        } else {
          // 普通指令
          compileUtil[dir] && compileUtil[dir](node, me.$vm, exp);
        }
      }
    });
  }
};

// 指令处理集合
var compileUtil = {
  text: function(node, vm, exp) {
    this.bind(node, vm, exp, 'text');
  },
  // ...省略
  bind: function(node, vm, exp, dir) {
    var updaterFn = updater[dir + 'Updater'];
    // 第一次初始化视图
    updaterFn && updaterFn(node, vm[exp]);
    // 实例化订阅者,此操作会在对应的属性消息订阅器中添加了该订阅者watcher
    new Watcher(vm, exp, function(value, oldValue) {
      // 一旦属性值有变化,会收到通知执行此更新函数,更新视图
      updaterFn && updaterFn(node, value, oldValue);
    });
  }
};

// 更新函数
var updater = {
  textUpdater: function(node, value) {
    node.textContent = typeof value == 'undefined' ? '' : value;
  }
  // ...省略
};

这里通过递归遍历保证了每个节点及子节点都会解析编译到,包括了 {{ }} 表达式声明的文本节点。指令的声明规定是通过特定前缀的节点属性来标记,如<span v-text="content" other-attrv-text便是指令,而other-attr不是指令,只是普通的属性。监听数据、绑定更新函数的处理是在compileUtil.bind()这个方法中,通过new Watcher()添加回调来接收数据变化的通知

至此,一个简单的 Compile 就完成了,完整代码。接下来要看看 Watcher 这个订阅者的具体实现了

实现 Watcher

Watcher 订阅者作为 Observer 和 Compile 之间通信的桥梁,主要做的事情是: 1、在自身实例化时往属性订阅器(dep)里面添加自己 2、自身必须有一个 update()方法 3、待属性变动 dep.notice()通知时,能调用自身的 update()方法,并触发 Compile 中绑定的回调,则功成身退。如果有点乱,可以回顾下前面的思路整理

javascript 复制代码
function Watcher(vm, exp, cb) {
  this.cb = cb;
  this.vm = vm;
  this.exp = exp;
  // 此处为了触发属性的getter,从而在dep添加自己,结合Observer更易理解
  this.value = this.get();
}
Watcher.prototype = {
  update: function() {
    this.run(); // 属性值变化收到通知
  },
  run: function() {
    var value = this.get(); // 取到最新值
    var oldVal = this.value;
    if (value !== oldVal) {
      this.value = value;
      this.cb.call(this.vm, value, oldVal); // 执行Compile中绑定的回调,更新视图
    }
  },
  get: function() {
    Dep.target = this; // 将当前订阅者指向自己
    var value = this.vm[exp]; // 触发getter,添加自己到属性订阅器中
    Dep.target = null; // 添加完毕,重置
    return value;
  }
};
// 这里再次列出Observer和Dep,方便理解
Object.defineProperty(data, key, {
  get: function() {
    // 由于需要在闭包内添加watcher,所以可以在Dep定义一个全局target属性,暂存watcher, 添加完移除
    Dep.target && dep.addDep(Dep.target);
    return val;
  }
  // ... 省略
});
Dep.prototype = {
  notify: function() {
    this.subs.forEach(function(sub) {
      sub.update(); // 调用订阅者的update方法,通知变化
    });
  }
};

实例化Watcher的时候,调用get()方法,通过Dep.target = watcherInstance标记订阅者是当前 watcher 实例,强行触发属性定义的getter方法,getter方法执行的时候,就会在属性的订阅器dep添加当前 watcher 实例,从而在属性值有变化的时候,watcherInstance 就能收到更新通知。

ok, Watcher 也已经实现了,完整代码。基本上 vue 中数据绑定相关比较核心的几个模块也是这几个,猛戳这里 , 在src 目录可找到 vue 源码。

最后来讲讲 MVVM 入口文件的相关逻辑和实现吧,相对就比较简单了~

实现 MVVM

MVVM 作为数据绑定的入口,整合 Observer、Compile 和 Watcher 三者,通过 Observer 来监听自己的 model 数据变化,通过 Compile 来解析编译模板指令,最终利用 Watcher 搭起 Observer 和 Compile 之间的通信桥梁,达到数据变化 -> 视图更新;视图交互变化(input) -> 数据 model 变更的双向绑定效果。

一个简单的 MVVM 构造器是这样子:

js 复制代码
function MVVM(options) {
  this.$options = options;
  var data = (this._data = this.$options.data);
  observe(data, this);
  this.$compile = new Compile(options.el || document.body, this);
}

但是这里有个问题,从代码中可看出监听的数据对象是 options.data,每次需要更新视图,则必须通过

js 复制代码
var vm = new MVVM({ data: { name: 'kindeng' } });
vm._data.name = 'dmq';

这样的方式来改变数据。

显然不符合我们一开始的期望,我们所期望的调用方式应该是这样的:

js 复制代码
var vm = new MVVM({ data: { name: 'kindeng' } });
vm.name = 'dmq';

所以这里需要给 MVVM 实例添加一个属性代理的方法,使访问 vm 的属性代理为访问 vm._data 的属性,改造后的代码如下:

js 复制代码
function MVVM(options) {
  this.$options = options;
  var data = (this._data = this.$options.data),
    me = this;
  // 属性代理,实现 vm.xxx -> vm._data.xxx
  Object.keys(data).forEach(function(key) {
    me._proxy(key);
  });
  observe(data, this);
  this.$compile = new Compile(options.el || document.body, this);
}

MVVM.prototype = {
  _proxy: function(key) {
    var me = this;
    Object.defineProperty(me, key, {
      configurable: false,
      enumerable: true,
      get: function proxyGetter() {
        return me._data[key];
      },
      set: function proxySetter(newVal) {
        me._data[key] = newVal;
      }
    });
  }
};

这里主要还是利用了Object.defineProperty()这个方法来劫持了 vm 实例对象的属性的读写权,使读写 vm 实例的属性转成读写了vm._data的属性值,达到鱼目混珠的效果,哈哈

至此,全部模块和功能已经完成了,如本文开头所承诺的两点。一个简单的 MVVM 模块已经实现,其思想和原理大部分来自经过简化改造的 vue源码,猛戳这里可以看到本文的所有相关代码。

由于本文内容偏实践,所以代码量较多,且不宜列出大篇幅代码,所以建议想深入了解的童鞋可以再次结合本文源代码来进行阅读,这样会更加容易理解和掌握。

总结

本文主要围绕“几种实现双向绑定的做法”、“实现 Observer”、“实现 Compile”、“实现 Watcher”、“实现 MVVM”这几个模块来阐述了双向绑定的原理和实现。并根据思路流程渐进梳理讲解了一些细节思路和比较关键的内容点,以及通过展示部分关键代码讲述了怎样一步步实现一个双向绑定 MVVM。文中肯定会有一些不够严谨的思考和错误,欢迎大家指正,有兴趣欢迎一起探讨和改进~

最后,感谢您的阅读!

评论

阅读上一篇

React虚拟Dom算法
2018-05-10 11:26:35

阅读下一篇

设计模式之行为型模式(三)
2018-04-19 00:04:46
0%