欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

Vue 2.0 侦听器 watch属性代码详解

程序员文章站 2022-04-28 21:05:45
用法 --------------------------------------------------------------------------------...

用法

--------------------------------------------------------------------------------

先来看看官网的介绍:

官网介绍的很好理解了,也就是监听一个数据的变化,当该数据变化时执行我们的watch方法,watch选项是一个对象,键为需要观察的表达式(函数),还可以是一个对象,可以包含如下几个属性:

            handler          ;对应的函数                              ;可以带两个参数,分别是新的值和旧的值,上下文为当前vue实例
            immediate      ;侦听开始之后是否立即调用     ;默认为false
            sync           ;波尔值,是否同步执行,默认false     ;如果设置了这个属性,当数据有变化时就会立即执行了,否则放到下一个tick中排队执行

例如:

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <script src="https://cdn.bootcss.com/vue/2.5.16/vue.js"></script>
  <title>document</title>
</head>
<body>
  <div id="app">
    <p>{{message}}</p>
    <button @click="test">测试</button> 
  </div>
  <script>
    var app = new vue({
      el:'#app',
      data:{message:'hello world!'},
      watch:{
        message:function(newval,val){
          console.log(newval,val)
        }
      },
      methods:{
        test:()=>app.message="hello vue!"
      }
    })
  </script>
</body>
</html>

dom渲染如下:

Vue 2.0 侦听器 watch属性代码详解

点击测试按钮后dom变成了:

Vue 2.0 侦听器 watch属性代码详解

同时控制台输出:hello vue! hello world!

 源码分析

--------------------------------------------------------------------------------

  vue实例后会先执行_init()进行初始化(4579行)时,会执行initstate()进行初始化,如下:

function initstate (vm) {   //第3303行
 vm._watchers = [];
 var opts = vm.$options;
 if (opts.props) { initprops(vm, opts.props); }
 if (opts.methods) { initmethods(vm, opts.methods); }
 if (opts.data) {
  initdata(vm);
 } else {
  observe(vm._data = {}, true /* asrootdata */);
 }
 if (opts.computed) { initcomputed(vm, opts.computed); }
 if (opts.watch && opts.watch !== nativewatch) {      //如果传入了watch 且 watch不等于nativewatch(细节处理,在firefox浏览器下object的原型上含有一个watch函数)
  initwatch(vm, opts.watch);                 //调用initwatch()函数初始化watch
 }
}

function initwatch (vm, watch) {  //第3541行
 for (var key in watch) {            //遍历watch里的每个元素
  var handler = watch[key];
  if (array.isarray(handler)) {          
   for (var i = 0; i < handler.length; i++) {
    createwatcher(vm, key, handler[i]);
   }
  } else {
   createwatcher(vm, key, handler);        //调用createwatcher
  }
 }
}

function createwatcher (             //创建用户watcher
 vm,
 exporfn,
 handler,
 options
) {
 if (isplainobject(handler)) {           //如果handler是个对象,则将该对象的hanler属性保存到handler里面 从这里看到值可以是个对象
  options = handler;
  handler = handler.handler;          
 }
 if (typeof handler === 'string') {        
  handler = vm[handler];
 }
 return vm.$watch(exporfn, handler, options)     //最后创建一个用户watch
}

vue原型上的$watch构造函数如下:

vue.prototype.$watch = function (   //第3596行
  exporfn,                   //监听的属性,例如例子里的message
  cb,                      //对应的函数
  options                    //选项
 ) {
  var vm = this;
  if (isplainobject(cb)) {
   return createwatcher(vm, exporfn, cb, options)
  }
  options = options || {};
  options.user = true;                   //设置options.user为true,表示这是一个用户watch
  var watcher = new watcher(vm, exporfn, cb, options);   //创建一个watcher对象
  if (options.immediate) {                    //如果有immediate选项,则直接运行
   cb.call(vm, watcher.value);
  }
  return function unwatchfn () {
   watcher.teardown();
  }
 };
}

侦听器对应的用户watch的user选项是true的,全局watcher如下:

var watcher = function watcher ( //第3082行
 vm,
 exporfn,               //侦听的属性:message
 cb,                  //对应的函数
 options,
 isrenderwatcher
) {
 this.vm = vm;
 if (isrenderwatcher) {
  vm._watcher = this;
 }
 vm._watchers.push(this);
 // options
 if (options) {
  this.deep = !!options.deep;
  this.user = !!options.user;               //用户watch这里的user属性为true
  this.lazy = !!options.lazy;
  this.sync = !!options.sync;
 } else {
  this.deep = this.user = this.lazy = this.sync = false;
 }
 this.cb = cb;
 this.id = ++uid$1; // uid for batching
 this.active = true;
 this.dirty = this.lazy; // for lazy watchers
 this.deps = [];
 this.newdeps = [];
 this.depids = new _set();
 this.newdepids = new _set();
 this.expression = exporfn.tostring();
 // parse expression for getter
 if (typeof exporfn === 'function') {         
  this.getter = exporfn; 
 } else {                         //侦听器执行到这里,
  this.getter = parsepath(exporfn);            //get对应的是parsepath()返回的匿名函数
  if (!this.getter) {
   this.getter = function () {};
   "development" !== 'production' && warn(
    "failed watching path: \"" + exporfn + "\" " +
    'watcher only accepts simple dot-delimited paths. ' +
    'for full control, use a function instead.',
    vm
   );
  }
 }
 this.value = this.lazy
  ? undefined
  : this.get();                      //最后会执行get()方法
}; 
function parsepath (path) {       //解析路劲
 if (bailre.test(path)) { 
  return
 }
 var segments = path.split('.');
 return function (obj) {        //返回一个函数,参数是一个对象
  for (var i = 0; i < segments.length; i++) {
   if (!obj) { return }
   obj = obj[segments[i]];
  }
  return obj
 }
}

执行watcher的get()方法时就将监听的元素也就是例子里的message对应的deps将当前watcher(用户watcher)作为订阅者,如下:

watcher.prototype.get = function get () {   //第3135行
 pushtarget(this);                 //将当前用户watch保存到dep.target总=中
 var value;
 var vm = this.vm;
 try {
  value = this.getter.call(vm, vm);        //执行用户wathcer的getter()方法,此方法会将当前用户watcher作为订阅者订阅起来
 } catch (e) {
  if (this.user) {
   handleerror(e, vm, ("getter for watcher \"" + (this.expression) + "\""));
  } else {
   throw e
  }
 } finally {
  // "touch" every property so they are all tracked as
  // dependencies for deep watching
  if (this.deep) {
   traverse(value);
  }
  poptarget();                  //恢复之前的watcher
  this.cleanupdeps();
 }
 return value
};

当我们点击按钮了修改了app.message时就会执行app.message对应的访问控制器的set()方法,就会执行这个用户watcher的update()方法,如下:

watcher.prototype.update = function update () {  //第3200行 更新watcher
 /* istanbul ignore else */
 if (this.lazy) {
  this.dirty = true;
 } else if (this.sync) {              //如果$this.sync为true,则直接运行this.run获取结果
  this.run();                   
 } else {
  queuewatcher(this);               //否则调用queuewatcher()函数把所有要执行update()的watch push到队列中
 }
};

watcher.prototype.run = function run () {   //第3215行 执行,会调用get()获取对应的值 
 if (this.active) {    
  var value = this.get();
  if (
   value !== this.value ||
   // deep watchers and watchers on object/arrays should fire even
   // when the value is the same, because the value may
   // have mutated.
   isobject(value) ||
   this.deep
  ) {
   // set new value
   var oldvalue = this.value;
   this.value = value;
   if (this.user) {            //如果是个用户 watcher
    try {
     this.cb.call(this.vm, value, oldvalue);    //执行这个回调函数 vm作为上下文 参数1为新值 参数2为旧值     也就是最后我们自己定义的function(newval,val){ console.log(newval,val) }函数
    } catch (e) { 
     handleerror(e, this.vm, ("callback for watcher \"" + (this.expression) + "\""));
    }
   } else {
    this.cb.call(this.vm, value, oldvalue);
   }
  }
 }
};

对于侦听器来说,vue内部的流程就是这样子

总结

以上所述是小编给大家介绍的vue 2.0 侦听器 watch属性代码详解,希望对大家有所帮助