vue的双向绑定原理及实现
一个极简双向数据绑定的示例:
1.var obj = {};
2.Object.defineProperty(obj,'hello',{
3. set:function(newVal){
4. document.getElementById('a').value = newVal;
5. document.getElementById('b').innerHTML = newVal;
6. }
7.});
8.document.addEventListener('keyup',function(e){
9. obj.hello = e.target.value;
10.})
此例实现的效果是:随文本框输入文字的变化,span 中会同步显示相同的文字内容;在js或控制台显式的修改 obj.hello 的值,视图会相应更新。这样就实现了 model => view 以及 view => model 的双向绑定。这就是双向绑定的基本原理,下面是具体探究:
先上个成果图:
是不是看起来跟vue的使用方式差不多?接下来就来从原理到实现,从简到难一步一步来实现这个SelfVue。由于本文只是为了学习和分享,所以只是简单实现下原理,并没有考虑太多情况和设计,如果大家有什么建议,欢迎提出来。
本文主要介绍两大内容:
-
vue数据双向绑定的原理。
-
实现简单版vue的过程,主要实现{{}}、v-model和事件指令的功能。
相关代码地址:https://github.com/canfoo/self-vue
vue数据双向绑定原理
vue数据双向绑定是通过数据劫持结合发布者-订阅者模式的方式来实现的,那么vue是如果进行数据劫持的,我们可以先来看一下通过控制台输出一个定义在vue初始化数据上的对象是个什么东西。
代码:
1. var vm = new Vue({
2. data: {
3. obj: {
4. a: 1
5. }
6. },
7. created: function () {
8. console.log(this.obj);
9. }
10. });
结果:
我们可以看到属性a有两个相对应的get和set方法,为什么会多出这两个方法呢?因为vue是通过Object.defineProperty()来实现数据劫持的。
Object.defineProperty( )是用来做什么的?它可以来控制一个对象属性的一些特有操作,比如读写权、是否可以枚举,这里我们主要先来研究下它对应的两个描述属性get和set,如果还不熟悉其用法,请点击这里阅读更多用法。
在平常,我们很容易就可以打印出一个对象的属性数据:
1. var Book = {
2. name: 'vue权威指南'
3. };
4. console.log(Book.name); // vue权威指南
如果想要在执行console.log(book.name)的同时,直接给书名加个书名号,那要怎么处理呢?或者说要通过什么监听对象 Book 的属性值。这时候Object.defineProperty( )就派上用场了,代码如下:
1. var Book = {}
2. var name = '';
3. Object.defineProperty(Book, 'name', {
4. set: function (value) {
5. name = value;
6. console.log('你取了一个书名叫做' + value);
7. },
8. get: function () {
9. return '《' + name + '》'
10. }
11. })
12. Book.name = 'vue权威指南'; // 你取了一个书名叫做vue权威指南
13. console.log(Book.name); // 《vue权威指南》
我们通过Object.defineProperty( )设置了对象Book的name属性,对其get和set进行重写操作,顾名思义,get就是在读取name属性这个值触发的函数,set就是在设置name属性这个值触发的函数,所以当执行 Book.name = ‘vue权威指南’ 这个语句时,控制台会打印出 “你取了一个书名叫做vue权威指南”,紧接着,当读取这个属性时,就会输出 “《vue权威指南》”,因为我们在get函数里面对该值做了加工了。如果这个时候我们执行下下面的语句,控制台会输出什么?
1. console.log(Book);
结果:
乍一看,是不是跟我们在上面打印vue数据长得有点类似,说明vue确实是通过这种方法来进行数据劫持的。接下来我们通过其原理来实现一个简单版的mvvm双向绑定代码。
思路分析
实现mvvm主要包含两个方面,数据变化更新视图,视图变化更新数据:
关键点在于data如何更新view,因为view更新data其实可以通过事件监听即可,比如input标签监听 ‘input’ 事件就可以实现了。所以我们着重来分析下,当数据改变,如何更新视图的。
数据更新视图的重点是如何知道数据变了,只要知道数据变了,那么接下去的事都好处理。如何知道数据变了,其实上文我们已经给出答案了,就是通过Object.defineProperty( )对属性设置一个set函数,当数据改变了就会来触发这个函数,所以我们只要将一些需要更新的方法放在这里面就可以实现data更新view了。
思路有了,接下去就是实现过程了。
实现过程
我们已经知道实现数据的双向绑定,首先要对数据进行劫持监听,所以我们需要设置一个监听器Observer,用来监听所有属性。如果属性发上变化了,就需要告诉订阅者Watcher看是否需要更新。因为订阅者是有很多个,所以我们需要有一个消息订阅器Dep来专门收集这些订阅者,然后在监听器Observer和订阅者Watcher之间进行统一管理的。接着,我们还需要有一个指令解析器Compile,对每个节点元素进行扫描和解析,将相关指令对应初始化成一个订阅者Watcher,并替换模板数据或者绑定相应的函数,此时当订阅者Watcher接收到相应属性的变化,就会执行对应的更新函数,从而更新视图。因此接下去我们执行以下3个步骤,实现数据的双向绑定:
1.实现一个监听器Observer,用来劫持并监听所有属性,如果有变动的,就通知订阅者。
2.实现一个订阅者Watcher,可以收到属性的变化通知并执行相应的函数,从而更新视图。
3.实现一个解析器Compile,可以扫描和解析每个节点的相关指令,并根据初始化模板数据以及初始化相应的订阅器。
流程图如下:
1.实现一个Observer
Observer是一个数据监听器,其实现核心方法就是前文所说的Object.defineProperty( )。如果要对所有属性都进行监听的话,那么可以通过递归方法遍历所有属性值,并对其进行Object.defineProperty( )处理。如下代码,实现了一个Observer。
1. function defineReactive(data, key, val) {
2. observe(val); // 递归遍历所有子属性
3. Object.defineProperty(data, key, {
4. enumerable: true,
5. configurable: true,
6. get: function() {
7. return val;
8. },
9. set: function(newVal) {
10. val = newVal;
11. console.log('属性' + key + '已经被监听了,现在值为:“' + newVal.toString() + '”');
12. }
13. });
14. }
15. function observe(data) {
16. if (!data || typeof data !== 'object') {
17. return;
18. }
19. Object.keys(data).forEach(function(key) {
20. defineReactive(data, key, data[key]);
21. });
22. };
23. var library = {
24. book1: {
25. name: ''
26. },
27. book2: ''
28. };
29. observe(library);
30. library.book1.name = 'vue权威指南'; // 属性name已经被监听了,现在值为:“vue权威指南”
31. library.book2 = '没有此书籍'; // 属性book2已经被监听了,现在值为:“没有此书籍”
思路分析中,需要创建一个可以容纳订阅者的消息订阅器Dep,订阅器Dep主要负责收集订阅者,然后再属性变化的时候执行对应订阅者的更新函数。所以显然订阅器需要有一个容器,这个容器就是list,将上面的Observer稍微改造下,植入消息订阅器:
1. function defineReactive(data, key, val) {
2. observe(val); // 递归遍历所有子属性
3. var dep = new Dep();
4. Object.defineProperty(data, key, {
5. enumerable: true,
6. configurable: true,
7. get: function() {
8. if (是否需要添加订阅者) {
9. dep.addSub(watcher); // 在这里添加一个订阅者
10. }
11. return val;
12. },
13. set: function(newVal) {
14. if (val === newVal) {
15. return;
16. }
17. val = newVal;
18. console.log('属性' + key + '已经被监听了,现在值为:“' + newVal.toString() + '”');
19. dep.notify(); // 如果数据变化,通知所有订阅者
20. }
21. });
22. }
24. function Dep () {
25. this.subs = [];
26. }
27. Dep.prototype = {
28. addSub: function(sub) {
29. this.subs.push(sub);
30. },
31. notify: function() {
32. this.subs.forEach(function(sub) {
33. sub.update();
34. });
35. }
36. };
从代码上看,我们将订阅器Dep添加一个订阅者设计在getter里面,这是为了让Watcher初始化进行触发,因此需要判断是否要添加订阅者,至于具体设计方案,下文会详细说明的。在setter函数里面,如果数据变化,就会去通知所有订阅者,订阅者们就会去执行对应的更新的函数。到此为止,一个比较完整Observer已经实现了,接下来我们开始设计Watcher。
2.实现Watcher
订阅者Watcher在初始化的时候需要将自己添加进订阅器Dep中,那该如何添加呢?我们已经知道监听器Observer是在get函数执行了添加订阅者Wather的操作的,所以我们只要在订阅者Watcher初始化的时候出发对应的get函数去执行添加订阅者操作即可,那要如何触发get的函数,再简单不过了,只要获取对应的属性值就可以触发了,核心原因就是因为我们使用了Object.defineProperty( )进行数据监听。这里还有一个细节点需要处理,我们只要在订阅者Watcher初始化的时候才需要添加订阅者,所以需要做一个判断操作,因此可以在订阅器上做一下手脚:在Dep.target上缓存下订阅者,添加成功后再将其去掉就可以了。订阅者Watcher的实现如下:
1. function Watcher(vm, exp, cb) {
2. this.cb = cb;
3. this.vm = vm;
4. this.exp = exp;
5. this.value = this.get(); // 将自己添加到订阅器的操作
6. }
8. Watcher.prototype = {
9. update: function() {
10. this.run();
11. },
12. run: function() {
13. var value = this.vm.data[this.exp];
14. var oldVal = this.value;
15. if (value !== oldVal) {
16. this.value = value;
17. this.cb.call(this.vm, value, oldVal);
18. }
19. },
20. get: function() {
21. Dep.target = this; // 缓存自己
22. var value = this.vm.data[this.exp] // 强制执行监听器里的get函数
23. Dep.target = null; // 释放自己
24. return value;
25. }
26. };
这时候,我们需要对监听器Observer也做个稍微调整,主要是对应Watcher类原型上的get函数。需要调整地方在于defineReactive函数:
1. function defineReactive(data, key, val) {
2. observe(val); // 递归遍历所有子属性
3. var dep = new Dep();
4. Object.defineProperty(data, key, {
5. enumerable: true,
6. configurable: true,
7. get: function() {
8. if (Dep.target) {. // 判断是否需要添加订阅者
9. dep.addSub(Dep.target); // 在这里添加一个订阅者
10. }
11. return val;
12. },
13. set: function(newVal) {
14. if (val === newVal) {
15. return;
16. }
17. val = newVal;
18. console.log('属性' + key + '已经被监听了,现在值为:“' + newVal.toString() + '”');
19. dep.notify(); // 如果数据变化,通知所有订阅者
20. }
21. });
22. }
23. Dep.target = null;
到此为止,简单版的Watcher设计完毕,这时候我们只要将Observer和Watcher关联起来,就可以实现一个简单的双向绑定数据了。因为这里没有还没有设计解析器Compile,所以对于模板数据我们都进行写死处理,假设模板上又一个节点,且id号为’name’,并且双向绑定的绑定的变量也为’name’,且是通过两个大双括号包起来(这里只是为了掩饰,暂时没什么用处),模板如下:
1. <body>
2. <h1 id="name">{{name}}</h1>
3. </body>
这时候我们需要将Observer和Watcher关联起来:
1. function SelfVue (data, el, exp) {
2. this.data = data;
3. observe(data);
4. el.innerHTML = this.data[exp]; // 初始化模板数据的值
5. new Watcher(this, exp, function (value) {
6. el.innerHTML = value;
7. });
8. return this;
9. }
然后在页面上new以下SelfVue类,就可以实现数据的双向绑定了:
1. <body>
2. <h1 id="name">{{name}}</h1>
3. </body>
4. <script src="js/observer.js"></script>
5. <script src="js/watcher.js"></script>
6. <script src="js/index.js"></script>
7. <script type="text/javascript">
8. var ele = document.querySelector('#name');
9. var selfVue = new SelfVue({
10. name: 'hello world'
11. }, ele, 'name');
13. window.setTimeout(function () {
14. console.log('name值改变了');
15. selfVue.data.name = 'canfoo';
16. }, 2000);
18. </script>
这时候打开页面,可以看到页面刚开始显示了是’hello world’,过了2s后就变成’canfoo’了。到这里,总算大功告成一半了,但是还有一个细节问题,我们在赋值的时候是这样的形式 ’ selfVue.data.name = ‘canfoo’ ’ 而我们理想的形式是’ selfVue.name = ‘canfoo’ ’为了实现这样的形式,我们需要在new SelfVue的时候做一个代理处理,让访问selfVue的属性代理为访问selfVue.data的属性,实现原理还是使用Object.defineProperty( )对属性值再包一层:
1. function SelfVue (data, el, exp) {
2. var self = this;
3. this.data = data;
5. Object.keys(data).forEach(function(key) {
6. self.proxyKeys(key); // 绑定代理属性
7. });
9. observe(data);
10. el.innerHTML = this.data[exp]; // 初始化模板数据的值
11. new Watcher(this, exp, function (value) {
12. el.innerHTML = value;
13. });
14. return this;
15. }
17. SelfVue.prototype = {
18. proxyKeys: function (key) {
19. var self = this;
20. Object.defineProperty(this, key, {
21. enumerable: false,
22. configurable: true,
23. get: function proxyGetter() {
24. return self.data[key];
25. },
26. set: function proxySetter(newVal) {
27. self.data[key] = newVal;
28. }
29. });
30. }
31. }
这下我们就可以直接通过’ selfVue.name = ‘canfoo’ ’的形式来进行改变模板数据了。如果想要迫切看到现象的童鞋赶快来获取代码!
3.实现Compile
虽然上面已经实现了一个双向数据绑定的例子,但是整个过程都没有去解析dom节点,而是直接固定某个节点进行替换数据的,所以接下来需要实现一个解析器Compile来做解析和绑定工作。解析器Compile实现步骤:
1.解析模板指令,并替换模板数据,初始化视图
2.将模板指令对应的节点绑定对应的更新函数,初始化相应的订阅器
为了解析模板,首先需要获取到dom元素,然后对含有dom元素上含有指令的节点进行处理,因此这个环节需要对dom操作比较频繁,所有可以先建一个fragment片段,将需要解析的dom节点存入fragment片段里再进行处理:
1. function nodeToFragment (el) {
2. var fragment = document.createDocumentFragment();
3. var child = el.firstChild;
4. while (child) {
5. // 将Dom元素移入fragment中
6. fragment.appendChild(child);
7. child = el.firstChild
8. }
9. return fragment;
10. }
接下来需要遍历各个节点,对含有相关指定的节点进行特殊处理,这里咱们先处理最简单的情况,只对带有 ‘{{变量}}’ 这种形式的指令进行处理,先简道难嘛,后面再考虑更多指令情况:
1. function compileElement (el) {
2. var childNodes = el.childNodes;
3. var self = this;
4. [].slice.call(childNodes).forEach(function(node) {
5. var reg = /\{\{(.*)\}\}/;
6. var text = node.textContent;
8. if (self.isTextNode(node) && reg.test(text)) { // 判断是否是符合这种形式{{}}的指令
9. self.compileText(node, reg.exec(text)[1]);
10. }
12. if (node.childNodes && node.childNodes.length) {
13. self.compileElement(node); // 继续递归遍历子节点
14. }
15. });
16. },
17. function compileText (node, exp) {
18. var self = this;
19. var initText = this.vm[exp];
20. this.updateText(node, initText); // 将初始化的数据初始化到视图中
21. new Watcher(this.vm, exp, function (value) { // 生成订阅器并绑定更新函数
22. self.updateText(node, value);
23. });
24. },
25. function (node, value) {
26. node.textContent = typeof value == 'undefined' ? '' : value;
27. }
获取到最外层节点后,调用compileElement函数,对所有子节点进行判断,如果节点是文本节点且匹配{{}}这种形式指令的节点就开始进行编译处理,编译处理首先需要初始化视图数据,对应上面所说的步骤1,接下去需要生成一个并绑定更新函数的订阅器,对应上面所说的步骤2。这样就完成指令的解析、初始化、编译三个过程,一个解析器Compile也就可以正常的工作了。为了将解析器Compile与监听器Observer和订阅者Watcher关联起来,我们需要再修改一下类SelfVue函数:
1. function SelfVue (options) {
2. var self = this;
3. this.vm = this;
4. this.data = options;
6. Object.keys(this.data).forEach(function(key) {
7. self.proxyKeys(key);
8. });
10. observe(this.data);
11. new Compile(options, this.vm);
12. return this;
13. }
更改后,我们就不要像之前通过传入固定的元素值进行双向绑定了,可以随便命名各种变量进行双向绑定了:
1. <body>
2. <div id="app">
3. <h2>{{title}}</h2>
4. <h1>{{name}}</h1>
5. </div>
6. </body>
7. <script src="js/observer.js"></script>
8. <script src="js/watcher.js"></script>
9. <script src="js/compile.js"></script>
10. <script src="js/index.js"></script>
11. <script type="text/javascript">
13. var selfVue = new SelfVue({
14. el: '#app',
15. data: {
16. title: 'hello world',
17. name: ''
18. }
19. });
21. window.setTimeout(function () {
22. selfVue.title = '你好';
23. }, 2000);
25. window.setTimeout(function () {
26. selfVue.name = 'canfoo';
27. }, 2500);
29. </script>
如上代码,在页面上可观察到,刚开始titile和name分别被初始化为 ‘hello world’ 和空,2s后title被替换成 ‘你好’ 3s后name被替换成 ‘canfoo’ 了。废话不多说,再给你们来一个这个版本的代码(v2),获取代码!
到这里,一个数据双向绑定功能已经基本完成了,接下去就是需要完善更多指令的解析编译,在哪里进行更多指令的处理呢?答案很明显,只要在上文说的compileElement函数加上对其他指令节点进行判断,然后遍历其所有属性,看是否有匹配的指令的属性,如果有的话,就对其进行解析编译。这里我们再添加一个v-model指令和事件指令的解析编译,对于这些节点我们使用函数compile进行解析处理:
1. function compile (node) {
2. var nodeAttrs = node.attributes;
3. var self = this;
4. Array.prototype.forEach.call(nodeAttrs, function(attr) {
5. var attrName = attr.name;
6. if (self.isDirective(attrName)) {
7. var exp = attr.value;
8. var dir = attrName.substring(2);
9. if (self.isEventDirective(dir)) { // 事件指令
10. self.compileEvent(node, self.vm, exp, dir);
11. } else { // v-model 指令
12. self.compileModel(node, self.vm, exp, dir);
13. }
14. node.removeAttribute(attrName);
15. }
16. });
17. }
上面的compile函数是挂载Compile原型上的,它首先遍历所有节点属性,然后再判断属性是否是指令属性,如果是的话再区分是哪种指令,再进行相应的处理,处理方法相对来说比较简单,这里就不再列出来,想要马上看阅读代码的同学可以马上点击这里获取。
最后我们在稍微改造下类SelfVue,使它更像vue的用法:
1. function SelfVue (options) {
2. var self = this;
3. this.data = options.data;
4. this.methods = options.methods;
6. Object.keys(this.data).forEach(function(key) {
7. self.proxyKeys(key);
8. });
10. observe(this.data);
11. new Compile(options.el, this);
12. options.mounted.call(this); // 所有事情处理好后执行mounted函数
13. }
这时候我们可以来真正测试了,在页面上设置如下东西:
1. <body>
2. <div id="app">
3. <h2>{{title}}</h2>
4. <input v-model="name">
5. <h1>{{name}}</h1>
6. <button v-on:click="clickMe">click me!</button>
7. </div>
8. </body>
9. <script src="js/observer.js"></script>
10. <script src="js/watcher.js"></script>
11. <script src="js/compile.js"></script>
12. <script src="js/index.js"></script>
13. <script type="text/javascript">
15. new SelfVue({
16. el: '#app',
17. data: {
18. title: 'hello world',
19. name: 'canfoo'
20. },
21. methods: {
22. clickMe: function () {
23. this.title = 'hello world';
24. }
25. },
26. mounted: function () {
27. window.setTimeout(() => {
28. this.title = '你好';
29. }, 1000);
30. }
31. });
33. </script>
是不是看起来跟vue的使用方法一样,哈,真正的大功告成!想要代码,直接点击这里获取!现象还没描述?直接上图!!!请观赏
其实这个效果图,就是本文开头贴出来的效果图了,前文说着要带着大家实现,所以就在这里把图再贴一次了,这叫首尾呼应嘛。
最后希望本文对你有帮助,如果有问题请留言一起探讨。