天天看点

Vue 2.x 和 3.0 实现双向绑定的原理(Object.defineProperty 以及 Proxy)

说明

vue实现双向绑定原理,主要是利用Object.defineProperty 来给实例data的属性添加 setter和getter.

并通过发布订阅模式(一对多的依赖关系,当状态发生改变,它的所有依赖都将被通知)来实现响应。

这个环节中包含了三个部分

  • Observer 用来监听拦截data的属性为监察者。
  • Dep用来添加订阅者,为订阅器
  • Watcher 就是订阅者

监察者通过 Dep 向 Watcher发布更新消息

简单实现

那么首先

  1. 通过对set和get的拦截,在get阶段进行依赖收集,在set阶段对通知该属性上所啊绑定的依赖。

如下我们就已经实现了一个简单的双向绑定了。

我们将data的value属性绑定上set和get,通过 _value 来进行操作。

<!-- HTML部分 -->

<input type="text" id="inp" oninput="inputFn(this.value)">
<div id='div'></div>
           
<!-- JS部分 -->
var inp = document.getElementById('inp');
var div = document.getElementById('div');
var data = {
  value:''
}
var _data = {
  value:''
}
Object.defineProperty(_data, 'value', {
  enumerable: true,
  configurable: true,
  set: function (newValue) {
      data.value = newValue; //watcher
      div.innerText = data.value
  },
  get: function () {
      return data.value;
  }
})
function inputFn(value) {
  _data.value = value;
}
           

如果只是实现一个简单的双向绑定那么上面的代码就已经实现了。

进一步完善模拟vue实现

首先我们将watcher抽出来 备用

function watcher(params) {
    div.innerText = inp.value = params; // 派发watcher
  }
           

声明一个vm来模拟vue的实例,并初始化。

var vm = {

        //类似vue实例上的data
        data: {
            value: ''
        }, 

        // vue私有, _data的所有属性为data中的所有属性被改造为 getter/setter 之后的。
        _data: {
            value: ''
        }, 

        // 代理到vm对象上,可以实现vm.value
        value: '', 

        //value的订阅器用来收集订阅者 
        valueWatchers:[] 
    }

           

遍历其data上的属性 进行改造 这里我们还是只举一个例子

// 利用 Object.defineProperty 定义一个属性 (eg:value) 描述符为存取描述符的属性
  Object.defineProperty(vm._data, 'value', {
      enumerable: true, //是否可枚举
      configurable: true, //是否可配置
      set: function (newValue) { //set 派发watchers
        vm.data.value = newValue; 
        vm.valueWatchers.map(fn => fn(newValue));
      },
      get: function () { 
          
          // 收集wachter vue中会在compile解析器中通过 显示调用 (this.xxx) 来触发get进行收集
          vm.valueWatchers.length = 0; 
          vm.valueWatchers.push(watcher); 
          return vm.data.value; 
      }
  })

    <!--直接通过显示调用来触发get进行绑定 vue中是在compile解析器中来进行这一步-->
    vm._data.value 

           

进行到这儿也已经实现了绑定,但是我们平时使用vue ,都是可以直接通过 this.xxx来获取和定义数据

那么我们还需要进行一步Proxy 代理

Object.defineProperty(vm, 'value', {
      enumerable: true,
      configurable: true,
      set: function (newValue) {
          this._data.value = newValue; //借助
      },
      get: function () {
          return this._data.value; 
      }
  })

           

这样我们就把vm._data.value 代理到vm.value上了,可以通过其直接操作了。

那么按照官方的写法

function proxy (target, sourceKey, key) {
      Object.defineProperty(target, key, {
          enumerable: true,
          configurable: true,
          get() {
              return this[sourceKey][key];
          },
          set(val) {
              this[sourceKey][key] = val;
          }
      });
  }
    
  proxy(vm, '_data', 'value');

           

完善后的完整代码

以下为整个页面,可以直接运行

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>双向绑定简单实现</title>
</head>
<body>
<input type="text" id="inp" oninput="inputFn(this.value)">
<br>
<input type="text" id="inp2" oninput="inputFn(this.value)">
<div id='div'></div>
<script>
    var inp = document.getElementById('inp');
    var inp2 = document.getElementById('inp2');
    var div = document.getElementById('div');

    
    function inputFn(value) {
        div.innerText = vm.value = value;
    }

    function watcher(params) {
        console.log(1)
        div.innerText = inp.value = params; // 派发watcher
    }

    function watcher2(params) {
        console.log(2)

        div.innerText = inp2.value = params; // 派发watcher
    }

    function proxy (target, sourceKey, key) {
        Object.defineProperty(target, key, {
            enumerable: true,
            configurable: true,
            get() {
                return this[sourceKey][key];
            },
            set(val) {
                this[sourceKey][key] = val;
            }
        });
    }

	let handler = {
        enumerable: true,
        configurable: true,
        set: function (newValue) {
            vm.data.value = newValue; 
            vm.valueWatchers.map(fn => fn(newValue));
        },
        get: function () {
            vm.valueWatchers = []; //防止重复添加, 
            vm.valueWatchers.push(watcher); 
            vm.valueWatchers.push(watcher2); 
            return vm.data.value; 
        }
    }

    var vm = {
        data: {},
        _data: {},
        value: '', 
        valueWatchers: [] 
    }
    
    Object.defineProperty(vm._data, 'value', handler)

    proxy(vm, '_data', 'value');

    vm.value;  //显示调用绑定

</script>
</body>
</html>
           

解释

再多讲一点。实际上vue在初始化的时候是用解析器解析过程中将wathcer进行绑定的。

它会利用一个全局的Dep.target = watcher

然后在get收集中,只收集全局上Dep.target, 添加完毕后会重新初始化全局Dep.target = null;

类似如下操作

Dep.target = watcher;
    vm.value;    // 触发get => Dep.target && valueWatchers.push(Dep.target);
    Dep.target = null;


           

这样也会防止我们在调用时触发get重复去添加watcher。

而我们的例子中只是每次都初始化为[]. 实际订阅器也不只是一个watcher数组。

此例跟官方实现还是有很多差距,只是简单模拟。

vue3.0 使用 Proxy

在vue3.0中,使用proxy这个功能更加强大的函数,它可以定义对象的基本操作的自定义行为。对比defineProperty只能拦截对象的某一属性,proxy的功能更方便。所提供的可自定义的操作也更多。

上面,我用defineProperty实现了vue的双向绑定,接下来我们用proxy来实现。

首先我们可以先了解一下proxy的作用和用法

首先

defineProperty

的用法是

Object.defineProperty(obj, prop, descriptor)

proxy的用法如下:

我们用proxy来实现一下双向绑定:

核心代码就像这样,在我们这个需求下分析

  1. set

    函数中
    1. target

      为所拦截的对象
    2. key

      为属性名
    3. newValue

      为所赋予的值
    4. set中需要

      return true

      代表设置成功,返回flase在严格模式下报TypeError (代表该值与期望值类型不同)
  2. get

    函数中
    1. target

      为所拦截的对象
    2. key

      为属性名
    3. get可返回任意值
let data = {value: 0}
const vm = new Proxy({value: 0 }, {
	set: function(target, key, newValue){
		console.log(key + '被赋值为' + newValue)
		target[key] = newValue
		return true
	},
	get: function(target, key) {
		console.log(target[key])
        return target[key]
    }
})

vm.value = 1 // 0; value被赋值为1
           

proxy双向绑定具体实现

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Document</title>
</head>
<body>
    <h1 id="content"></h1>
    <p><input type="text" id="enter" value=""></p>
</body>
<script>
    let content = document.getElementById("content")
    let enter_input = document.getElementById('enter')

    let data = {
        enter_input: '',
        enter_input_watchers: []
    }
    let watcher = function watcherFn(value) {
        content.innerText = value
    }
    let watcher2 = function watcher2Fn(value) {
        enter_input.value = value
    }
    let handler = {
        set: function(target, key, value) {
            if (key === 'enter_input') {
                target[key] = value;
                target[key + "_watchers"].map(function (watcher) {
                    watcher(value)
                })
            }
        },
        get: function(target, key) {
            target[key + "_watchers"] = [watcher, watcher2];
            return target[key]
        }
    }

    let db = new Proxy(data, handler);
    db.enter_input; //收集监听
    enter_input.addEventListener('input', function(e){
        db.enter_input = e.target.value;
    })
</script>
</html>
           

双向绑定总结

  1. vue2.x版本使用了

    Object.defineProperty

    来实现双向绑定,由于其功能的限制,只能绑定对象的某个属性,vue需要

    递归遍历对象的所有属性

    挨个进行绑定,功能上不是很完美。
  2. vue3.0版本使用

    proxy

    进行双向绑定,proxy提供了可以定义对象基本操作的自定义行为的功能(如

    属性查找、赋值

    、枚举、函数调用),可以直接

    拦截整个对象

    ,不需要再进行递归。本例中我们只使用到了proxy提供自定义

    set

    get

    的能力。

错误类型扩展

平时我们常见的错误类型分为

ReferenceError

TypeError

SyntaxError

这三种。

一、 ReferenceError 代表我们的作用域查找错误。
let b = 1;
console.log(b)
console.log(a) //ReferenceError
           
  1. 我们在全局定义了

    b

    ,所以

    console.log(b)为1

    ,但是我们没有定义

    a

    ,所以我们在全局作用域下找不到a,就会报

    ReferenceError

  2. 如果是在函数中定义,则在函数中查找不到时,会去父作用域查找,一直到全局,都找不到,才会报

    ReferenceError

二、 TypeError代表数据类型与预期不符。
let b = 1;
b() //TypeError
           
  1. 我们在全局定义了

    b

    ,其类型为Number,但是我们用()来执行它,把它当作了函数用,所以就会报

    TypeError

三、 SyntaxError代表语法错误。
let b > 1;//SyntaxError
//or
let let b//SyntaxError
           
  1. 很明显,我们不可以这么使用let,语法就错误了,所以就会报

    SyntaxError

错误类型总结

ReferenceError

TypeError

SyntaxError

分别代表

作用域,预期类型,语法

错误。

我们其实经常看到这几种错误,但是平时不会太注意这个错误类型,只关注在哪错误了。倘若我们知道了这几种错误类型代表的涵义,对我们排除错误也是非常有帮助的。

继续阅读