手抄Vue(五)—— 实现Vue.set

Vue.js 中, Vue.setvm.$set 是一回事,其中 vm.$setVue.set 的别名,二者在 Vue.js 源码当中指向的是同一个函数。

Vue.set 可以向响应式对象中添加一个属性,并确保这个新属性同样是响应式的,且触发视图更新。它必须用于向响应式对象上添加新属性,因为 Vue 无法探测普通的新增属性 (比如 this.myObject.newProperty = 'hi')。但对象不能是 Vue 实例,或者 Vue 实例的根数据对象。

这个方法接收三个参数:

  • {Object | Array} target 目标对象
  • {string | number} key 添加的键名
  • {any} value 添加的值

返回值为开发者所设置的值。

那要实现一个功能相同的 mySet 方法的话,其实只要将新添加的属性转化为响应式属性即可:

function mySet(target, key, val) {
  defineReactive(target, key)
  return val
}

首先使用 Vue数据响应原理(四)—— 封装Observer类 中定义好的方法 defineReactive 将属性转化为响应式属性,再将对应添加的值返回。

但很容易看出来这里存在一个问题,defineReactive 确实是将属性转化成了响应式属性,但是,它没有像期望的那样同时为属性设置一个初始值,这样的话,只有在属性值发生变化时才会借由 defineReactive 中的 setter 为属性设置上新的值,否则它一直都是 undefined。那么,可以将 defineReactive 方法改造一下以解决这个问题:

这是原来的 defineReactive 方法:

function defineReactive(obj, key) {
  const dep = []

  const property = Object.getOwnPropertyDescriptor(obj, key)
  if (property && !property.configurable) {
    return
  }

  const getter = property && property.get
  const setter = property && property.set

  let value = obj[key]
  observe(value)
  Object.defineProperty(obj, key, {
    get () {
      getter && (value = getter.call(obj))
      dep.push(target)
      return value
    },
    set (newVal) {
      getter && (value = getter.call(obj))
      if (newVal === value || (newVal !== newVal && value !== value)) {
        return
      }
      if (setter) {
        setter.call(obj, newVal)
      } else {
        value = newVal
      }
      observe(newVal)
      dep.forEach(f => {
        f()
      })
    }
  })
}

这是改造后的 defineReactive 方法:

function defineReactive(obj, key, value) {
  const dep = []

  const property = Object.getOwnPropertyDescriptor(obj, key)
  if (property && !property.configurable) {
    return
  }

  const getter = property && property.get
  const setter = property && property.set

  // 一
  if (arguments.length === 2) {
    value = obj[key]
  }

  observe(value)
  Object.defineProperty(obj, key, {
    get () {
      getter && (value = getter.call(obj))
      dep.push(target)
      return value
    },
    set (newVal) {
      getter && (value = getter.call(obj))
      if (newVal === value || (newVal !== newVal && value !== value)) {
        return
      }
      if (setter) {
        setter.call(obj, newVal)
      } else {
        value = newVal
      }
      observe(newVal)
      dep.forEach(f => {
        f()
      })
    }
  })
}

注释一的地方改造之前是这样:

let value = obj[key]

现在增加一个判断:

arguments.length === 2

如果只传进来了两个参数,也就是说没有第三个参数 value,那么再去给 value 取值:

value = obj[key]

否则,value 就是传进来的那个值。

那么相应的,mySet 方法里调用 defineReactive 时也将属性值传入:

function mySet(target, key, val) {
  defineReactive(target, key, val)
  return val
}

这样一来,新添加的属性已经是响应式属性并且拥有了初始值,只要在需要的时候再使用myWatch 方法为之添加相应的依赖即可。

将上述代码和上一篇的最终代码放在一起并添加如下测试代码:

const data = {
  name: 'kobe bryant',
  otherInfo: {
    height: 198,
    numbers: [8, 24]
  },
  teammates: [
    'paul gasol',
    {
      name: 'shaq',
      numbers: [32, 34, 33]
    }
  ]
}

mySet(data, 'age', 40)

function render() {
  document.body.innerText = `我最喜欢的NBA球员是${data.name},${data.age}岁,身高${data.otherInfo.height}cm,穿过${data.otherInfo.numbers.length}个球衣号码,${data.otherInfo.numbers[0]}和${data.otherInfo.numbers[1]},他的队友有${data.teammates[0]}和${data.teammates[1].name},其中,${data.teammates[1].name}在湖人时期穿的球衣号码为${data.teammates[1].numbers[1]}号`
}

observe(data)

myWatch(render, render)

测试结果和期望是一致的,通过 mySet 方法后来添加给 data 的属性 —— age 正确 "render" 到了页面并且可以响应对于它的修改操作。

实现 mySet 方法的思路大概就是这样。

和之前一样,方法实现了以后还要再去考虑对于边界情况与异常情况的兼容:

  • 如果传进来的 target 对象不存在(undefinednull)?

顺便封装一个用来判断 undefinednull 的公共方法:

function isUndef(value) {
  return value === undefined || value === null
}

那么只要在 mySet 中加句判断就好:

function mySet(target, key, val) {
  if (isUndef(target)) {
    console.error('不能给 undefined 设置响应式属性!')
    return val
  }
  defineReactive(target, key, val)
  return val
}

如果目标对象 target 不存在,那么打印错误信息,并将 val 返回。

  • 如果传进来的 target 对象是原始类型?

同样,封装一个用来判断原始类型值的公共方法:

function isPrimitive(value) {
  return (
    typeof value === 'string' ||
    typeof value === 'number' ||
    typeof value === 'boolean' ||
    typeof value === 'symbol'
  )
}

那么,接着在 mySet 方法中添加判断:

function mySet(target, key, val) {
  if (isUndef(target)) {
    console.error('不能给 undefined 和 null 设置响应式属性!')
    return val
  }
  if (isPrimitive(target)) {
    console.error('不能给原始类型的值设置响应式属性!')
    return val
  }
  defineReactive(target, key, val)
  return val
}
  • 如果传进来的目标对象是一个数组?

如果目标对象是数组的话,参数 key 相应的就是数组索引了,那么有必要先封装一个验证数组索引有效性的方法:

function isValidArrayIndex(index) {
  return index >= 0 && Math.floor(index) == index && isFinite(index)
}

只要 index 是一个大于等于零的整数,并且是有限的,那就可以断定它是一个有效的数组索引。

但,它其实还是有问题的:

isValidArrayIndex([]) // true

这显然是不对的,出现错误是因为:

Number([]) // 0

那么经过隐式类型转换:

[] >= 0 // true
Math.floor([]) == [] // true
isFinite([]) // true

所以,传入空数组时 isValidArrayIndex 方法的返回值也就是 true 了。

Vue.js 里是这样写的:

function isValidArrayIndex(index) {
  const n = parseFloat(String(index))
  return n >= 0 && Math.floor(n) === n && isFinite(index)
}

这就解决了我写出来的问题,parseFloat(String(index))index 转为数值类型的同时,又不会像 Number(index) 一样将空数组转为 0

String([]) // ""
parseFloat("") // NaN

有了 isValidArrayIndex 方法之后,mySet 中接着添加以下代码:

function mySet(target, key, val) {
  if (isUndef(target)) {
    console.error('不能给 undefined 和 null 设置响应式属性!')
    return val
  }
  if (isPrimitive(target)) {
    console.error('不能给原始类型的值设置响应式属性!')
    return val
  }
  if (Array.isArray(target) && isValidArrayIndex(key)) {
    target.length = Math.max(target.length, key)
    target.splice(key, 1, val)
    return val
  }
  defineReactive(target, key, val)
  return val
}

判断如果 target 为数组,并且 key 是一个有效的数组索引,就进行以下操作:

首先将数组 target 的长度修改为 target.lengthkey 中较大的那一个,这是为了防止如果 key 大于原 target.length 的话,后面对 targetsplice 操作(target.splice(key, 1, val))会报错。

再然后对数组指定元素进行替换操作,即:

target.splice(key, 1, val)

替换的同时数组的变异方法 splice 本身也是能够触发响应的。

最后将 val 返回。

  • 如果新增的 key 本来就在目标对象 target 中?

这种情况兼容起来非常容易:

function mySet(target, key, val) {
  if (isUndef(target)) {
    console.error('不能给 undefined 和 null 设置响应式属性!')
    return val
  }
  if (isPrimitive(target)) {
    console.error('不能给原始类型的值设置响应式属性!')
    return val
  }
  if (Array.isArray(target) && isValidArrayIndex(key)) {
    target.length = Math.max(target.length, key)
    target.splice(key, 1, val)
    return val
  }
  if (target.hasOwnProperty(key)) {
    target[key] = val
    return val
  }
  defineReactive(target, key, val)
  return val
}

如果新增的 key 本来就在目标对象 target 中,那么直接修改该属性值即可:target[key] = valtarget 中已有的属性本来就是响应式的。

但使用 target.hasOwnProperty(key) 来判断其实是有点问题的。

比如我有一个 Model 类如下:

class Model {
  constructor() {
    this.foo = 1
    this._bar = 2
  }
  get bar() {
    return this._bar;
  }
  set bar(newvalue) {
    this._bar = newvalue;
  }
}

如果我的 data 是通过 Model 类初始化的:

const data = new Model()

这时候 data 其实就是这个样子:

{
  foo: 1,
  _bar: 2,
  __proto__: {
    get bar: function() {
      return this._bar
    },
    set bar: function(newvalue) {
      return this._bar = newvalue
    }
  }
}

bar 并不是实例的私有属性。

但使用 target.hasOwnProperty(key) 进行判断时条件就不成立了,这就会导致走到下面这段代码:

defineReactive(target, key, val)
return val

进而,这段代码又会为 data 实例重新定义了一个私有属性 bar,但这显然不是我们期望的结果,开发者是把 bar 写在原型上的。

所以最好是使用 in 操作符进行判断:

key in target && !(key in Object.prototype)

这个时候判断条件就是成立的了,也就不会走到最后 defineReactivedata 实例重新定义私有属性 bar 的地方去了。

那么最终,代码就成了这个样子:

function mySet(target, key, val) {
  if (isUndef(target)) {
    console.error('不能给 undefined 和 null 设置响应式属性!')
    return val
  }
  if (isPrimitive(target)) {
    console.error('不能给原始类型的值设置响应式属性!')
    return val
  }
  if (Array.isArray(target) && isValidArrayIndex(key)) {
    target.length = Math.max(target.length, key)
    target.splice(key, 1, val)
    return val
  }
  if (key in target && !(key in Object.prototype)) {
    target[key] = val
    return val
  }
  defineReactive(target, key, val)
  return val
}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 225,015评论 6 522
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 96,373评论 3 404
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 172,253评论 0 368
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 61,069评论 1 300
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 70,079评论 6 400
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 53,550评论 1 314
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 41,911评论 3 429
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 40,892评论 0 279
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 47,435评论 1 324
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 39,465评论 3 346
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 41,586评论 1 355
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 37,178评论 5 351
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 42,920评论 3 340
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 33,356评论 0 25
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 34,493评论 1 277
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 50,151评论 3 381
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 46,663评论 2 366

推荐阅读更多精彩内容

  • 国家电网公司企业标准(Q/GDW)- 面向对象的用电信息数据交换协议 - 报批稿:20170802 前言: 排版 ...
    庭说阅读 11,029评论 6 13
  • Swift1> Swift和OC的区别1.1> Swift没有地址/指针的概念1.2> 泛型1.3> 类型严谨 对...
    cosWriter阅读 11,120评论 1 32
  • 1.ios高性能编程 (1).内层 最小的内层平均值和峰值(2).耗电量 高效的算法和数据结构(3).初始化时...
    欧辰_OSR阅读 29,437评论 8 265
  • 几年前,微信、微博都在写爱情和婚姻不是一回事儿。大意是爱情是浪漫的,美好的,而生活是琐碎的,是埋葬爱情的坟墓。而且...
    16诗社阅读 211评论 0 0
  • 秋语 加班作 春来心漠漠,秋雨随处凉。 寒衾人情薄,对沐明月光。 戍鼓关山落,征雁羁旧乡。 青女煮雏叶,素娥泪凝霜...
    张玉涛阅读 284评论 0 0