Vue的双向绑定原理及实现

前言

---

学习vue也有一段时间了，对双向绑定原理的实现一直有所了解，但是并没有深入了解其实现原理。所以花了时间和查阅了一些资料，自己动手尝试实现了简单的vue的双向绑定。

本文主要分为两部分：

• vue的数据双向绑定的实现原理
• 实现简单版的vue的双向绑定，主要实现{{}}、v-model和事件指令的功能。

Vue的数据双向绑定原理

vue的数据绑定是通过数据劫持结合发布者和订阅者模式来实现的。那么vue是如何进行数据劫持的。可以先看一下vue初始化数据上的对象在控制台上输出的是什么？

var vm = new Vue({
    data:{
        obj:{
            a:1
        }
    },
    created(){
        console.log(obj);
    }
})

结果：

上图中可以看到属性a有两个对应的get和set方法，为什么会多出这两个方法呢？那是因为Vue是通过Object.defineProperty()方法进行数据劫持的。

Object.defineProperty( )是用来做什么的？它可以来控制一个对象属性的一些特有操作，比如读写权、是否可以枚举，这里我们主要先来研究下它对应的两个描述属性 get 和 set。更多内容可以点击这里。

在平常，我们可以很容易打印出一个对象的属性

var Book = {
    name: 'node权威指南',
}

console.log(Book.name);

当我想要在执行console.log(Book.name)的时候，我想要输出的内容加上书名号，或者说我们该通过什么方法来实现监听数据的变化，这时候Object.defineProperty()方法就派上了用场。

Object.defineProperty(Book, 'name', {
    set:function(value) {
        name = value;
        console.log(`you have got a book named:${name}`);
    },
    get:function() {
        return '《'+name+'》';
    }
})

Book.name = '深入浅出webpack'; //you have got a book named:深入浅出webpack
console.log(Book.name);//《深入浅出webpack》

我们通过 Object.defineProperty( )设置了对象Book的name 属性，对其get和set进行重写操作，顾名思义，get就是在读取name属性这个值触发的函数，set就是在设置name属性这个值触发的函数，所以当执行Book.name = '深入浅出webpack'这个语句时，控制台会打印出 “you have got a book named:深入浅出webpack”，紧接着，当读取这个属性时，就会输出 “《深入浅出webpack》”，因为我们在 get 函数里面对该值做了加工了。如果这个时候我们执行console.log(Book)的语句，控制台会输出什么？

结果：

乍一看，是不是跟我们在上面打印 vue 数据长得有点类似，说明 vue 确实是通过这种方法来进行数据劫持的。接下来我们通过其原理来实现一个简单版的 mvvm 双向绑定代码。

思路分析

实现mvvm主要包含两个方面，数据变化更新视图，视图变化更新数据。

关键点在于data如果更新view,因为view更新data。其实可以通过事件监听即可，比如监听’input’事件就可以实现了。所以着重分析一下，当数据改变如何更新视图的。

数据更新视图的重点是如何知道数据变了，只要知道数据变了，那么接下去的事情都好处理。如何知道数据变了，其实上文我们已经给出答案了，就是通过Object.defineProperty()对属性设置了一个set函数，当数据改变了就会触发这个函数，所以只要我们将一些需要更新的方法放在这里面就可以实现data更新view了。

实现过程

我们已经知道实现数据的双向绑定，首先要对数据进行劫持监听，我们需要设置一个监听器Observer,用来监听所有属性。如果属性上发生了变化，就需要告诉订阅者Watcher是否需要更新。因为订阅者是有很多个，所以我们需要有一个消息订阅器Dep来专门收集这些订阅者，然后在监听器Observer和订阅者Watcher之间进行统一管理的，接着，我们还需要一个指令解析器compile，对每一个节点元素进行扫描和解析。将相关指令对应初始化成一个订阅者Watcher,并替换模板数据或者绑定相应的函数，此时订阅者Watcher接收到相应属性的变化，就会执行相应的更新函数，从而更新视图，因此接下去我们执行以下3个步骤，并实现数据的双向绑定。

1. 实现一个监听器 Observer，用来劫持并监听所有属性，如果有变动的，就通知订阅者。

2. 实现一个订阅者 Watcher，可以收到属性的变化通知并执行相应的函数，从而更新视图。

3. 实现一个解析器 Compile，可以扫描和解析每个节点的相关指令，并根据指令 初始化模板数据以及初始化相应的订阅器。

流程图如下：

1. 实现一个Observe

Observer 是一个数据监听器，其实现核心方法就是前文所说的 Object.defineProperty( )。如果要对所有属性都进行监听的话，那么可以通过递归方法遍历所有属性值，并对其进行 Object.defineProperty( )处理。如下代码，实现了一个 Observer

    defineReactive(object, key, value) {
        observe(value);
        Object.defineProperty(object, key, {
            enumerable:true,
            configurable:true,
            get:function() {
                return value;
            },
            set:function(newVal) {
                value = newVal;
                console.log(`property ${key} has been listened, now value is ${newVal}`);
            }
        });
    }

    function observe(val) {
        if(!val || typeof val !== 'object') {
            return;
        }

        Obejct.keys(val).forEach(e => {
            defineReactive(val, e, val[e])
        });
    }


    var book = {
        name:'node',
        author:{
            firstName:'lee',
            lastName: 'wang'
        }
    }

    observe(book);
    book.name = 'webpack';
    book.author.firstName = 'Tian';

思路分析中，需要创建一个可以容纳订阅者的消息订阅器 Dep，订阅器 Dep 主要负责收集订阅者，然后再属性变化的时候执行对应订阅者的更新函数。所以显然订阅器需要有一个容器，这个容器就是 list，将上面的 Observer 稍微改造下，植入消息订阅器：

function defineReactive(obj, key, value) {
    observe(value);
    var dep = new Dep();
    Object.defineProperty(obj, key, {
        enumerable:true,
        configurable:true,
        get: function() {
            if(是否需要添加订阅) {
                dep.addSub(watcher); //在这里需要添加一个订阅者
            }
            return val;
        },
        set: function(newVal) {
            if(val === newVal) {
                return;
            }
            console.log(`property ${key} has been listened, now value is ${newVal}`);
            dep.notify();
        }
    })
}

function Dep() {
    this.subs = [];
}

Dep.prototype = {
    addSub:function(key) {
        this.subs.push(key);
    },
    notify: function() {
        this.subs.forEach(e => {
            e.update();
        }) 
    }
}

从代码上看，我们将订阅器 Dep 添加一个订阅者设计在 getter 里面，这是为了让 Watcher 初始化进行触发，因此需要判断是否要添加订阅者，至于具体设计方案，下文会详细说明的。在 setter 函数里面，如果数据变化，就会去通知所有订阅者，订阅者们就会去执行对应的更新的函数。到此为止，一个比较完整 Observer 已经实现了，接下来我们开始设计 Watcher。

2.实现Watcher

订阅者 Watcher 在初始化的时候需要将自己添加进订阅器 Dep 中，那该如何添加呢？我们已经知道监听器 Observer 是在 get 函数执行了添加订阅者 Wather 的操作的，所以我们只要在订阅者 Watcher 初始化的时候出发对应的 get 函数去执行添加订阅者操作即可，那要如何触发 get 的函数，再简单不过了，只要获取对应的属性值就可以触发了，核心原因就是因为我们使用了 Object.defineProperty( )进行数据监听。这里还有一个细节点需要处理，我们只要在订阅者 Watcher 初始化的时候才需要添加订阅者，所以需要做一个判断操作，因此可以在订阅器上做一下手脚：在 Dep.target 上缓存下订阅者，添加成功后再将其去掉就可以了。订阅者 Watcher 的实现如下：

function Watcher(vm, exp, cb) {
    this.cb = cb;
    this.vm = vm;
    this.cb = cb;
    this.value = this.get();
} 

Watcher.prototype = {
    update:function() {
        this.run();
    },
    run:function() {
        var value = this.vm.data[this.exp];
        var oldVal = this.value;
        if(value !== oldVal) {
            this.value = value;
            this.cb.call(this.value, value, oldVal);
        }
    },
    get:function(){
        Dep.target = this; //自己绑定自己
        var value = this.vm.data[this.exp]; //强制执行监听器里的get函数
        Dep.target = null; //释放自己
        return value;
    }
}

这时候，我们需要对监听器 Observer 也做个稍微调整，主要是对应 Watcher 类原型上的 get 函数。需要调整地方在于 defineReactive 函数：

    function defineReactive(object, key, value) {
        observe(value);
        var dep = new Dep();
        Object.defineProperty(object, key, {
            enumerable:true,
            configurable:true,
            set:function(newVal){
                if (val === newVal) {
                return;
                }
                val = newVal;
                console.log('属性' + key + '已经被监听了，现在值为：“' + newVal.toString() + '”');
                dep.notify(); // 如果数据变化，通知所有订阅者
            },
            get:function() {
                if (Dep.target) {.  // 判断是否需要添加订阅者
                    dep.addSub(Dep.target); // 在这里添加一个订阅者
                }
                return val;
            }
        });
    }

到此为止，简单版的 Watcher 设计完毕，这时候我们只要将 Observer 和 Watcher 关联起来，就可以实现一个简单的双向绑定数据了。因为这里没有还没有设计解析器 Compile，所以对于模板数据我们都进行写死处理，假设模板上又一个节点，且 id 号为’name’，并且双向绑定的绑定的变量也为’name’，且是通过两个大双括号包起来（这里只是为了掩饰，暂时没什么用处），模板如下：

<body>
    <h1 id="name">{{name}}</h1>
</body>

这时候我们需要将Observer和Watcher关联起来：

function selfVue(data, el, exp) {
    this.data = data;
    observe(data);
    el.innerHTML = this.data[exp]; // 初始化模板数据的值
    new Watcher(this, exp, function(value) {
        el.innerHTML = value;
    });
    return this;
}

然后在页面上 new 以下 SelfVue 类，就可以实现数据的双向绑定了：

<body>
  <h1 id="name">{{name}}</h1>
</body>
<script src="js/observer.js"></script>
<script src="js/watcher.js"></script>
<script src="js/index.js"></script>
<script type="text/javascript">
  var ele = document.querySelector("#name");
  var selfVue = new SelfVue(
    {
      name: "hello world"
    },
    ele,
    "name"
  );

  window.setTimeout(function() {
    console.log("name值改变了");
    selfVue.data.name = "canfoo";
  }, 2000);
</script>

这时候打开页面，可以看到页面刚开始显示了是’hello world’，过了 2s 后就变成’canfoo’了。到这里，总算大功告成一半了，但是还有一个细节问题，我们在赋值的时候是这样的形式 selfVue.data.name = ‘canfoo’ 而我们理想的形式是selfVue.name = 'canfoo’为了实现这样的形式，我们需要在 new SelfVue 的时候做一个代理处理，让访问 selfVue 的属性代理为访问 selfVue.data 的属性，实现原理还是使用 Object.defineProperty( )对属性值再包一层：

function SelfVue(data, el, exp) {
  var self = this;
  this.data = data;

  Object.keys(data).forEach(function(key) {
    self.proxyKeys(key); // 绑定代理属性
  });

  observe(data);
  el.innerHTML = this.data[exp]; // 初始化模板数据的值
  new Watcher(this, exp, function(value) {
    el.innerHTML = value;
  });
  return this;
}

SelfVue.prototype = {
  proxyKeys: function(key) {
    var self = this;
    Object.defineProperty(this, key, {
      enumerable: false,
      configurable: true,
      get: function proxyGetter() {
        return self.data[key];
      },
      set: function proxySetter(newVal) {
        self.data[key] = newVal;
      }
    });
  }
};

这下我们就可以直接通过selfVue.name = 'canfoo’的形式来进行改变模板数据了。如果想要迫切看到现象的童鞋赶快来获取代码！

3.实现compile

虽然上面已经实现了一个双向数据绑定的例子，但是整个过程都没有去解析 dom 节点，而是直接固定某个节点进行替换数据的，所以接下来需要实现一个解析器 Compile 来做解析和绑定工作。解析器 Compile 实现步骤：

1. 解析模板指令，并替换模板数据，初始化视图

2. 将模板指令对应的节点绑定对应的更新函数，初始化相应的订阅器

为了解析模板，首先需要获取到 dom 元素，然后对含有 dom 元素上含有指令的节点进行处理，因此这个环节需要对 dom 操作比较频繁，所有可以先建一个 fragment 片段，将需要解析的 dom 节点存入 fragment 片段里再进行处理：

function nodeToFragment(el) {
  var fragment = document.createDocumentFragment();
  var child = el.firstChild;
  while (child) {
    // 将 Dom 元素移入 fragment 中
    fragment.appendChild(child);
    child = el.firstChild;
  }
  return fragment;
}

接下来需要遍历各个节点，对含有相关指定的节点进行特殊处理，这里咱们先处理最简单的情况，只对带有 ‘{{变量}}’ 这种形式的指令进行处理，先简到难嘛，后面再考虑更多指令情况：

function compileElement (el) {
    var childNodes = el.childNodes;
    var self = this;
    [].slice.call(childNodes).forEach(function(node) {
        var reg = /\{\{(.*)\}\}/;
        var text = node.textContent;

        if (self.isTextNode(node) && reg.test(text)) {  // 判断是否是符合这种形式{{}}的指令
            self.compileText(node, reg.exec(text)[1]);
        }

        if (node.childNodes && node.childNodes.length) {
            self.compileElement(node);  // 继续递归遍历子节点
        }
    });
},
function compileText (node, exp) {
    var self = this;
    var initText = this.vm[exp];
    this.updateText(node, initText);  // 将初始化的数据初始化到视图中
    new Watcher(this.vm, exp, function (value) {  // 生成订阅器并绑定更新函数
        self.updateText(node, value);
    });
},
function (node, value) {
    node.textContent = typeof value == 'undefined' ? '' : value;
}

获取到最外层节点后，调用 compileElement 函数，对所有子节点进行判断，如果节点是文本节点且匹配{{}}这种形式指令的节点就开始进行编译处理，编译处理首先需要初始化视图数据，对应上面所说的步骤 1. 接下去需要生成一个并绑定更新函数的订阅器，对应上面所说的步骤 2. 这样就完成指令的解析、初始化、编译三个过程，一个解析器 Compile 也就可以正常的工作了。为了将解析器 Compile 与监听器 Observer 和订阅者 Watcher 关联起来，我们需要再修改一下类 SelfVue 函数：

function SelfVue(options) {
  var self = this;
  this.vm = this;
  this.data = options;

  Object.keys(this.data).forEach(function(key) {
    self.proxyKeys(key);
  });

  observe(this.data);
  new Compile(options, this.vm);
  return this;
}

更改后，我们就不要像之前通过传入固定的元素值进行双向绑定了，可以随便命名各种变量进行双向绑定了：

<body>
  <div id="app">
    <h2>{{title}}</h2>
    <h1>{{name}}</h1>
  </div>
</body>
<script src="js/observer.js"></script>
<script src="js/watcher.js"></script>
<script src="js/compile.js"></script>
<script src="js/index.js"></script>
<script type="text/javascript">
  var selfVue = new SelfVue({
    el: "#app",
    data: {
      title: "hello world",
      name: ""
    }
  });

  window.setTimeout(function() {
    selfVue.title = "你好";
  }, 2000);

  window.setTimeout(function() {
    selfVue.name = "canfoo";
  }, 2500);
</script>

如上代码，在页面上可观察到，刚开始 title 和 name 分别被初始化为 ‘hello world’ 和空，2s 后 title 被替换成 ‘你好’ 3s 后 name 被替换成 ‘canfoo’ 了。

到这里，一个数据双向绑定功能已经基本完成了，接下去就是需要完善更多指令的解析编译，在哪里进行更多指令的处理呢？答案很明显，只要在上文说的 compileElement 函数加上对其他指令节点进行判断，然后遍历其所有属性，看是否有匹配的指令的属性，如果有的话，就对其进行解析编译。这里我们再添加一个v-model 指令和事件指令的解析编译，对于这些节点我们使用函数 compile 进行解析处理：

function compile(node) {
  var nodeAttrs = node.attributes;
  var self = this;
  Array.prototype.forEach.call(nodeAttrs, function(attr) {
    var attrName = attr.name;
    if (self.isDirective(attrName)) {
      var exp = attr.value;
      var dir = attrName.substring(2);
      if (self.isEventDirective(dir)) {
        // 事件指令
        self.compileEvent(node, self.vm, exp, dir);
      } else {
        // v-model 指令
        self.compileModel(node, self.vm, exp, dir);
      }
      node.removeAttribute(attrName);
    }
  });
}

上面的 compile 函数是挂载 Compile 原型上的，它首先遍历所有节点属性，然后再判断属性是否是指令属性，如果是的话再区分是哪种指令，再进行相应的处理，处理方法相对来说比较简单，这里就不再列出来.

最后我们在稍微改造下类 SelfVue，使它更像 vue 的用法：

function SelfVue(options) {
  var self = this;
  this.data = options.data;
  this.methods = options.methods;

  Object.keys(this.data).forEach(function(key) {
    self.proxyKeys(key);
  });

  observe(this.data);
  new Compile(options.el, this);
  options.mounted.call(this); // 所有事情处理好后执行mounted函数
}

这时候我们可以来真正测试了，在页面上设置如下东西：

<body>
  <div id="app">
    <h2>{{title}}</h2>
    <input v-model="name" />
    <h1>{{name}}</h1>
    <button v-on:click="clickMe">click me!</button>
  </div>
</body>
<script src="js/observer.js"></script>
<script src="js/watcher.js"></script>
<script src="js/compile.js"></script>
<script src="js/index.js"></script>
<script type="text/javascript">
  new SelfVue({
    el: "#app",
    data: {
      title: "hello world",
      name: "canfoo"
    },
    methods: {
      clickMe: function() {
        this.title = "hello world";
      }
    },
    mounted: function() {
      window.setTimeout(() => {
        this.title = "你好";
      }, 1000);
    }
  });
</script>

这时候看起来就更像Vue了。