Vue 中 $set() 与 Vue.set() 原理及使用

2,535 阅读2分钟

这是我参与更文挑战的第 20 天,活动详情查看:更文挑战

1. 前言

问题: 在使用 vue 进行开发的过程中,可能会遇到一种情况:当生成vue实例后,再次给数据赋值时,有时候并不会自动更新到视图上去。也就是 如果在实例创建之后添加新的属性到实例上,它不会触发视图更新。

案例:

<template>
  <div class="home">
    <div>{{student}}</div>
    <div v-for="(item,index) in items" :key="index">{{item}}</div>
	  <button @click="btn()">修改</button>
  </div>
</template>

<script>
export default {
  name: 'Home',
  data(){
    return{
      student:{
        name:'张三',
      },
	  items:[1, 2, 3],
    }
  },
  methods:{
	btn(){
      this.student.age = 18;
      this.items[1] = 'two';
	  console.log(this.student,this.items);
	}
  }
}
</script>

当点击按钮后页面:

在这里插入图片描述

当点击按钮后控制台:

在这里插入图片描述

原因:

受 ES5 的限制,Vue.js 不能检测到对象属性的添加或删除。因为 Vue.js 在初始化实例时将属性转为 getter/setter,所以 属性必须在 data 对象上才能让 Vue.js 转换它,才能让它是响应的。

因此:

Vue 不能检测以下变动的数组:

当你利用索引直接设置一个项时,例如:vm.items[indexOfItem] = newValue

当你修改数组的长度时,例如:vm.items.length = newLength

eg:

使用 this.arr[0] 去更新 array 的内容,视图没有刷新

使用 Vue.set(this.arr, 0, !this.arr[0]) 去更新 array 的内容,视图被刷新

使用 this.arr[0] = !this.arr[0] 和 this.obj.a = !this.obj.a 同时更新,视图被刷新

结论:

如果方法里面单纯的更新数组 Array 的话,要使用 Vue.set();

如果方法里面同时有数组和对象的更新,直接操作 data 即可;

2. 原理

每个组件实例都有相应的 watcher 实例对象,它会在组件渲染的过程中把属性记录为依赖,之后当依赖项的 setter 被调用时,会通知 watcher 重新计算,从而致使它关联的组件得以更新。

在这里插入图片描述

受现代 JavaScript 的限制 (而且 Object.observe 也已经被废弃),Vue 不能检测到对象属性的添加或删除。由于 Vue 会在初始化实例时对属性执行 getter/setter 转化过程,所以属性必须在 data 对象上存在才能让 Vue 转换它,这样才能让它是响应的。

3. $set() 与 Vue.set() 的使用

3.1 通过 Vue.set() 改写

语法:

Vue.set( target, propertyName/index, value )
参数:
{Object | Array} target
{string | number} propertyName/index
{any} value
返回值:设置的值。
用法:
向响应式对象中添加一个 property,并确保这个新 property 同样是响应式的,且触发视图更新。
它必须用于向响应式对象上添加新 property,因为 Vue 无法探测普通的新增 property 
(比如 this.myObject.newProperty = 'hi')
注意:
对象不能是 Vue 实例,或者 Vue 实例的根数据对象。
<template>
  <div class="home">
    <div>{{student}}</div>
    <div v-for="(item,index) in items" :key="index">{{item}}</div>
	<button @click="btn()">修改</button>
  </div>
</template>

<script>
import Vue from 'vue' // 别忘了引入
export default {
  name: 'Home',
  data(){
    return{
      student:{
        name:'张三',
      },
	  items:[1, 2, 3],
    }
  },
  methods:{
	btn(){
      Vue.set(this.student, 'age', 18);
      Vue.set(this.items, 1, 'two');
	  console.log(this.student,this.items);
	}
  }
}
</script>

当点击按钮后页面:

在这里插入图片描述

当点击按钮后控制台:

在这里插入图片描述

3.2 通过 $set() 改写

语法:

vm.$set( target, propertyName/index, value )
参数:
{Object | Array} target
{string | number} propertyName/index
{any} value
返回值:设置的值。
用法:
这是全局 Vue.set 的别名。
参考:Vue.set
<template>
  <div class="home">
    <div>{{student}}</div>
    <div v-for="(item,index) in items" :key="index">{{item}}</div>
	<button @click="btn()">修改</button>
  </div>
</template>

<script>
export default {
  name: 'Home',
  data(){
    return{
      student:{
        name:'张三',
      },
	  items:[1, 2, 3],
    }
  },
  methods:{
	btn(){
      this.$set(this.student, 'age', 18);
      this.$set(this.items, 1, 'two');
	  console.log(this.student,this.items);
	}
  }
}
</script>

当点击按钮后页面:

在这里插入图片描述

当点击按钮后控制台:

在这里插入图片描述

3.3 Vue.set() 和 this.$set() 的区别

Vue.set() 源码:

import { set } from '../observer/index'
...
Vue.set = set
...

this.$set() 源码

import { set } from '../observer/index'
...
Vue.prototype.$set = set
...

可以发现 Vue.set() 和 this.$set() 这两个 api 的实现原理基本一模一样,都是使用了set函数。
set 函数是从 …/observer/index 文件中导出的。
区别: Vue.set( ) 是将 set 函数绑定在 Vue 构造函数上,this.$set() 是将 set 函数绑定在 Vue原型上。