资讯专栏INFORMATION COLUMN

Vue响应式数据: Observer模块实现

shinezejian / 1971人阅读

摘要:响应式数据是在模块中实现的我们可以看看是如何实现的。早期代码使用是进行单元测试,是事件模型的单元测试文件。模块实际上采用采用组合继承借用构造函数原型继承方式继承了其目的就是继承的,等方法。

前言

  首先欢迎大家关注我的Github博客,也算是对我的一点鼓励,毕竟写东西没法获得变现,能坚持下去也是靠的是自己的热情和大家的鼓励。接下来的日子我应该会着力写一系列关于Vue与React内部原理的文章,感兴趣的同学点个关注或者Star。
  之前的两篇文章响应式数据与数据依赖基本原理和从Vue数组响应化所引发的思考我们介绍了响应式数据相关的内容,没有看的同学可以点击上面的链接了解一下。如果大家都阅读过上面两篇文章的话,肯定对这方面内容有了足够的知识储备,想来是时候来看看Vue内部是如何实现数据响应化。目前Vue的代码非常庞大,但其中包含了例如:服务器渲染等我们不关心的内容,为了能集中于我们想学习的部分,我们这次阅读的是Vue的早期代码,大家可以checkout到这里查看对应的代码。
  之前零零碎碎的看过React的部分源码,当我看到Vue的源码,觉得真的是非常优秀,各个模块之间解耦的非常好,可读性也很高。Vue响应式数据是在Observer模块中实现的,我们可以看看Observer是如何实现的。
  

发布-订阅模式  

  如果看过上两篇文章的同学应该会发现一个问题:数据响应化的代码与其他的代码耦合太强了,比如说:
  

</>复制代码

  1. //代码来源于文章:响应式数据与数据依赖基本原理
  2. //定义对象的单个响应式属性
  3. function defineReactive(obj, key, value){
  4. observify(value);
  5. Object.defineProperty(obj, key, {
  6. configurable: true,
  7. enumerable: true,
  8. set: function(newValue){
  9. var oldValue = value;
  10. value = newValue;
  11. //可以在修改数据时触发其他的操作
  12. console.log("newValue: ", newValue, " oldValue: ", oldValue);
  13. },
  14. get: function(){
  15. return value;
  16. }
  17. });
  18. }

  比如上面的代码,set内部的处理的代码就与整个数据响应化相耦合,如果下次我们想要在set中做其他的操作,就必须要修改set函数内部的内容,这是非常不友好的,不符合开闭原则(OCP: Open Close Principle)。当然Vue不会采用这种方式去设计,为了解决这个问题,Vue引入了发布-订阅模式。其实发布-订阅模式是前端工程师非常熟悉的一种模式,又叫做观察者模式,它是一种定义对象间一种一对多的依赖关系,当一个对象的状态发生改变的时候,其他观察它的对象都会得到通知。我们最常见的DOM事件就是一种发布-订阅模式。比如:
  

</>复制代码

  1. document.body.addEventListener("click", function(){
  2. console.log("click event");
  3. });

  在上面的代码中我们监听了bodyclick事件,虽然我们不知道click事件什么时候会发生,但是我们一定能保证,如果发生了bodyclick事件,我们一定能得到通知,即回调函数被调用。在JavaScript中因为函数是一等公民,我们很少使用传统的发布-订阅模式,多采用的是事件模型的方式实现。在Vue中也实现了一个事件模型,我们可以看一下。因为Vue的模块之间解耦的非常好,因此在看代码之前,其实我们可以先来看看对应的单元测试文件,你就知道这个模块要实现什么功能,甚至如果你愿意的话,也可以自己实现一个类似的模块放进Vue的源码中运行。

  Vue早期代码使用是jasmine进行单元测试,emitter_spec.js是事件模型的单元测试文件。首先简单介绍一下jasmine用到的函数,可以对照下面的代码了解具体的功能:

describe是一个测试单元集合

it是一个测试用例

beforeEach会在每一个测试用例it执行前执行

expect期望函数,用作对期望值和实际值之间执行逻辑比较

createSpy用来创建spy,而spy的作用是监测函数的调用相关信息和函数执行参数

  

</>复制代码

  1. var Emitter = require("../../../src/emitter")
  2. var u = undefined
  3. // 代码有删减
  4. describe("Emitter", function () {
  5. var e, spy
  6. beforeEach(function () {
  7. e = new Emitter()
  8. spy = jasmine.createSpy("emitter")
  9. })
  10. it("on", function () {
  11. e.on("test", spy)
  12. e.emit("test", 1, 2 ,3)
  13. expect(spy.calls.count()).toBe(1)
  14. expect(spy).toHaveBeenCalledWith(1, 2, 3)
  15. })
  16. it("once", function () {
  17. e.once("test", spy)
  18. e.emit("test", 1, 2 ,3)
  19. e.emit("test", 2, 3, 4)
  20. expect(spy.calls.count()).toBe(1)
  21. expect(spy).toHaveBeenCalledWith(1, 2, 3)
  22. })
  23. it("off", function () {
  24. e.on("test1", spy)
  25. e.on("test2", spy)
  26. e.off()
  27. e.emit("test1")
  28. e.emit("test2")
  29. expect(spy.calls.count()).toBe(0)
  30. })
  31. it("apply emit", function () {
  32. e.on("test", spy)
  33. e.applyEmit("test", 1)
  34. e.applyEmit("test", 1, 2, 3, 4, 5)
  35. expect(spy).toHaveBeenCalledWith(1)
  36. expect(spy).toHaveBeenCalledWith(1, 2, 3, 4, 5)
  37. })
  38. })

  可以看出Emitter对象实例对外提供以下接口:

on: 注册监听接口,参数分别是事件名监听函数

emit: 触发事件函数,参数是事件名

off: 取消对应事件的注册函数,参数分别是事件名监听函数

once: 与on类似,仅会在第一次时通知监听函数,随后监听函数会被移除。

  看完了上面的单元测试代码,我们现在已经基本了解了这个模块要干什么,现在让我们看看对应的代码:

</>复制代码

  1. // 删去了注释并且对代码顺序有调整
  2. // ctx是监听回调函数的执行作用域(this)
  3. function Emitter (ctx) {
  4. this._ctx = ctx || this
  5. }
  6. var p = Emitter.prototype
  7. p.on = function (event, fn) {
  8. this._cbs = this._cbs || {}
  9. ;(this._cbs[event] || (this._cbs[event] = []))
  10. .push(fn)
  11. return this
  12. }
  13. // 三种模式
  14. // 不传参情况清空所有监听函数
  15. // 仅传事件名则清除该事件的所有监听函数
  16. // 传递事件名和回调函数,则对应仅删除对应的监听事件
  17. p.off = function (event, fn) {
  18. this._cbs = this._cbs || {}
  19. // all
  20. if (!arguments.length) {
  21. this._cbs = {}
  22. return this
  23. }
  24. // specific event
  25. var callbacks = this._cbs[event]
  26. if (!callbacks) return this
  27. // remove all handlers
  28. if (arguments.length === 1) {
  29. delete this._cbs[event]
  30. return this
  31. }
  32. // remove specific handler
  33. var cb
  34. for (var i = 0; i < callbacks.length; i++) {
  35. cb = callbacks[i]
  36. // 这边的代码之所以会有cb.fn === fn要结合once函数去看
  37. // 给once传递的监听函数其实已经被wrapped过
  38. // 但是仍然可以通过原来的监听函数去off
  39. if (cb === fn || cb.fn === fn) {
  40. callbacks.splice(i, 1)
  41. break
  42. }
  43. }
  44. return this
  45. }
  46. // 触发对应事件的所有监听函数,注意最多只能用给监听函数传递三个参数(采用call)
  47. p.emit = function (event, a, b, c) {
  48. this._cbs = this._cbs || {}
  49. var callbacks = this._cbs[event]
  50. if (callbacks) {
  51. callbacks = callbacks.slice(0)
  52. for (var i = 0, len = callbacks.length; i < len; i++) {
  53. callbacks[i].call(this._ctx, a, b, c)
  54. }
  55. }
  56. return this
  57. }
  58. // 触发对应事件的所有监听函数,传递参数个数不受限制(采用apply)
  59. p.applyEmit = function (event) {
  60. this._cbs = this._cbs || {}
  61. var callbacks = this._cbs[event], args
  62. if (callbacks) {
  63. callbacks = callbacks.slice(0)
  64. args = callbacks.slice.call(arguments, 1)
  65. for (var i = 0, len = callbacks.length; i < len; i++) {
  66. callbacks[i].apply(this._ctx, args)
  67. }
  68. }
  69. return this
  70. }
  71. // 通过调用onoff事件事件,在第一次触发之后就`off`对应的监听事件
  72. p.once = function (event, fn) {
  73. var self = this
  74. this._cbs = this._cbs || {}
  75. function on () {
  76. self.off(event, on)
  77. fn.apply(this, arguments)
  78. }
  79. on.fn = fn
  80. this.on(event, on)
  81. return this
  82. }

  我们可以看到上面的代码采用了原型模式创建了一个Emitter类。配合Karma跑一下这个模块 ,测试用例全部通过,到现在我们已经阅读完Emitter了,这算是一个小小的热身吧,接下来让我们正式看一下Observer模块。
  

Observer 对外功能

  按照上面的思路我们先看看Observer对应的测试用例observer_spec.js,由于Observer的测试用例非常长,我会在代码注释中做解释,并尽量精简测试用例,能让我们了解模块对应功能即可,希望你能有耐心阅读下来。
 

</>复制代码

  1. //测试用例是精简版,否则太冗长
  2. var Observer = require("../../../src/observe/observer")
  3. var _ = require("../../../src/util") //Vue内部使用工具方法
  4. var u = undefined
  5. Observer.pathDelimiter = "." //配置Observer路径分隔符
  6. describe("Observer", function () {
  7. var spy
  8. beforeEach(function () {
  9. spy = jasmine.createSpy("observer")
  10. })
  11. //我们可以看到我们通过Observer.create函数可以将数据变为可响应化,
  12. //然后我们监听get事件可以在属性被读取时触发对应事件,注意对象嵌套的情况(例如b.c)
  13. it("get", function () {
  14. Observer.emitGet = true
  15. var obj = {
  16. a: 1,
  17. b: {
  18. c: 2
  19. }
  20. }
  21. var ob = Observer.create(obj)
  22. ob.on("get", spy)
  23. var t = obj.b.c
  24. expect(spy).toHaveBeenCalledWith("b", u, u)
  25. expect(spy).toHaveBeenCalledWith("b.c", u, u)
  26. Observer.emitGet = false
  27. })
  28. //我们可以监听响应式数据的set事件,当响应式数据修改的时候,会触发对应的时间
  29. it("set", function () {
  30. var obj = {
  31. a: 1,
  32. b: {
  33. c: 2
  34. }
  35. }
  36. var ob = Observer.create(obj)
  37. ob.on("set", spy)
  38. obj.b.c = 4
  39. expect(spy).toHaveBeenCalledWith("b.c", 4, u)
  40. })
  41. //带有$与_开头的属性都不会被处理
  42. it("ignore prefix", function () {
  43. var obj = {
  44. _test: 123,
  45. $test: 234
  46. }
  47. var ob = Observer.create(obj)
  48. ob.on("set", spy)
  49. obj._test = 234
  50. obj.$test = 345
  51. expect(spy.calls.count()).toBe(0)
  52. })
  53. //访问器属性也不会被处理
  54. it("ignore accessors", function () {
  55. var obj = {
  56. a: 123,
  57. get b () {
  58. return this.a
  59. }
  60. }
  61. var ob = Observer.create(obj)
  62. obj.a = 234
  63. expect(obj.b).toBe(234)
  64. })
  65. // 对数属性的get监听,注意嵌套的情况
  66. it("array get", function () {
  67. Observer.emitGet = true
  68. var obj = {
  69. arr: [{a:1}, {a:2}]
  70. }
  71. var ob = Observer.create(obj)
  72. ob.on("get", spy)
  73. var t = obj.arr[0].a
  74. expect(spy).toHaveBeenCalledWith("arr", u, u)
  75. expect(spy).toHaveBeenCalledWith("arr.0.a", u, u)
  76. expect(spy.calls.count()).toBe(2)
  77. Observer.emitGet = false
  78. })
  79. // 对数属性的get监听,注意嵌套的情况
  80. it("array set", function () {
  81. var obj = {
  82. arr: [{a:1}, {a:2}]
  83. }
  84. var ob = Observer.create(obj)
  85. ob.on("set", spy)
  86. obj.arr[0].a = 2
  87. expect(spy).toHaveBeenCalledWith("arr.0.a", 2, u)
  88. })
  89. // 我们看到可以通过监听mutate事件,在push调用的时候对应触发事件
  90. // 触发事件第一个参数是"",代表的是路径名,具体源码可以看出,对于数组变异方法都是空字符串
  91. // 触发事件第二个参数是数组本身
  92. // 触发事件第三个参数比较复杂,其中:
  93. // method属性: 代表触发的方法名称
  94. // args属性: 代表触发方法传递参数
  95. // result属性: 代表触发变异方法之后数组的结果
  96. // index属性: 代表变异方法对数组发生变化的最开始元素
  97. // inserted属性: 代表数组新增的元素
  98. // remove属性: 代表数组删除的元素
  99. // 其他的变异方法: popshiftunshiftsplicesortreverse内容都是非常相似的
  100. // 具体我们就不一一列举的了,如果有疑问可以自己看到全部的单元测试代码
  101. it("array push", function () {
  102. var arr = [{a:1}, {a:2}]
  103. var ob = Observer.create(arr)
  104. ob.on("mutate", spy)
  105. arr.push({a:3})
  106. expect(spy.calls.mostRecent().args[0]).toBe("")
  107. expect(spy.calls.mostRecent().args[1]).toBe(arr)
  108. var mutation = spy.calls.mostRecent().args[2]
  109. expect(mutation).toBeDefined()
  110. expect(mutation.method).toBe("push")
  111. expect(mutation.index).toBe(2)
  112. expect(mutation.removed.length).toBe(0)
  113. expect(mutation.inserted.length).toBe(1)
  114. expect(mutation.inserted[0]).toBe(arr[2])
  115. })
  116. // 我们可以看到响应式数据中存在$add方法,类似于Vue.set,可以监听add事件
  117. // 可以向响应式对象中添加新一个属性,如果之前存在该属性则操作会被忽略
  118. // 并且新赋值的对象也必须被响应化
  119. // 我们省略了对象数据$delete方法的单元测试,功能类似于Vue.delete,与$add方法相反,可以用于删除对象的属性
  120. // 我们省略了数组的$set方法的单元测试,功能也类似与Vue.set,可以用于设置数组对应数字下标的值
  121. // 我们省略了数组的$remove方法的单元测试,功能用于移除数组给定下标的值或者给定的值,例如:
  122. // var arr = [{a:1}, {a:2}]
  123. // var ob = Observer.create(arr)
  124. // arr.$remove(0) => 移除对应下标的值 或者
  125. // arr.$remove(arr[0]) => 移除给定的值
  126. it("object.$add", function () {
  127. var obj = {a:{b:1}}
  128. var ob = Observer.create(obj)
  129. ob.on("add", spy)
  130. // ignore existing keys
  131. obj.$add("a", 123)
  132. expect(spy.calls.count()).toBe(0)
  133. // add event
  134. var add = {d:2}
  135. obj.a.$add("c", add)
  136. expect(spy).toHaveBeenCalledWith("a.c", add, u)
  137. // check if add object is properly observed
  138. ob.on("set", spy)
  139. obj.a.c.d = 3
  140. expect(spy).toHaveBeenCalledWith("a.c.d", 3, u)
  141. })
  142. // 下面的测试用例用来表示如果两个不同对象parentA、parentB的属性指向同一个对象obj,那么该对象obj改变时会分别parentA与parentB的监听事件
  143. it("shared observe", function () {
  144. var obj = { a: 1 }
  145. var parentA = { child1: obj }
  146. var parentB = { child2: obj }
  147. var obA = Observer.create(parentA)
  148. var obB = Observer.create(parentB)
  149. obA.on("set", spy)
  150. obB.on("set", spy)
  151. obj.a = 2
  152. expect(spy.calls.count()).toBe(2)
  153. expect(spy).toHaveBeenCalledWith("child1.a", 2, u)
  154. expect(spy).toHaveBeenCalledWith("child2.a", 2, u)
  155. // test unobserve
  156. parentA.child1 = null
  157. obj.a = 3
  158. expect(spy.calls.count()).toBe(4)
  159. expect(spy).toHaveBeenCalledWith("child1", null, u)
  160. expect(spy).toHaveBeenCalledWith("child2.a", 3, u)
  161. })
  162. })
源码实现 数组

  能坚持看到这里,我们的长征路就走过了一半了,我们已经知道了Oberver对外提供的功能了,现在我们就来了解一下Oberver内部的实现原理。
  
  Oberver模块实际上采用采用组合继承(借用构造函数+原型继承)方式继承了Emitter,其目的就是继承Emitteron, offemit等方法。我们在上面的测试用例发现,我们并没有用new方法直接创建一个Oberver的对象实例,而是采用一个工厂方法Oberver.create方法来创建的,我们接下来看源码,由于代码比较多我会尽量去拆分成一个个小块来讲:
  

</>复制代码

  1. // 代码出自于observe.js
  2. // 为了方便讲解我对代码顺序做了改变,要了解详细的情况可以查看具体的源码
  3. var _ = require("../util")
  4. var Emitter = require("../emitter")
  5. var arrayAugmentations = require("./array-augmentations")
  6. var objectAugmentations = require("./object-augmentations")
  7. var uid = 0
  8. /**
  9. * Type enums
  10. */
  11. var ARRAY = 0
  12. var OBJECT = 1
  13. function Observer (value, type, options) {
  14. Emitter.call(this, options && options.callbackContext)
  15. this.id = ++uid
  16. this.value = value
  17. this.type = type
  18. this.parents = null
  19. if (value) {
  20. _.define(value, "$observer", this)
  21. if (type === ARRAY) {
  22. _.augment(value, arrayAugmentations)
  23. this.link(value)
  24. } else if (type === OBJECT) {
  25. if (options && options.doNotAlterProto) {
  26. _.deepMixin(value, objectAugmentations)
  27. } else {
  28. _.augment(value, objectAugmentations)
  29. }
  30. this.walk(value)
  31. }
  32. }
  33. }
  34. var p = Observer.prototype = Object.create(Emitter.prototype)
  35. Observer.pathDelimiter = ""
  36. Observer.emitGet = false
  37. Observer.create = function (value, options) {
  38. if (value &&
  39. value.hasOwnProperty("$observer") &&
  40. value.$observer instanceof Observer) {
  41. return value.$observer
  42. } if (_.isArray(value)) {
  43. return new Observer(value, ARRAY, options)
  44. } else if (
  45. _.isObject(value) &&
  46. !value.$scope // avoid Vue instance
  47. ) {
  48. return new Observer(value, OBJECT, options)
  49. }
  50. }

  我们首先从Observer.create看起,如果value值没有响应化过(通过是否含有$observer属性去判断),则使用new操作符创建Obsever实例(区分对象OBJECT与数组ARRAY)。接下来我们看Observer的构造函数是怎么定义的,首先借用Emitter构造函数:
  

</>复制代码

  1. Emitter.call(this, options && options.callbackContext)

配合原型继承

</>复制代码

  1. var p = Observer.prototype = Object.create(Emitter.prototype)

从而实现了组合继承Emitter,因此Observer继承了Emitter的属性(ctx)和方法(on,emit等)。我们可以看到Observer有以下属性:

id: 响应式数据的唯一标识

value: 原始数据

type: 标识是数组还是对象

parents: 标识响应式数据的父级,可能存在多个,比如var obj = { a : { b: 1}},在处理{b: 1}的响应化过程中parents中某个属性指向的就是obj$observer

  我们接着看首先给该数据赋值$observer属性,指向的是实例对象本身。_.define内部是通过defineProperty实现的:

</>复制代码

  1. define = function (obj, key, val, enumerable) {
  2. Object.defineProperty(obj, key, {
  3. value : val,
  4. enumerable : !!enumerable,
  5. writable : true,
  6. configurable : true
  7. })
  8. }

  下面我们首先看看是怎么处理数组类型的数据的

</>复制代码

  1. if (type === ARRAY) {
  2. _.augment(value, arrayAugmentations)
  3. this.link(value)
  4. }

  如果看过我前两篇文章的同学,其实还记得我们对数组响应化当时还做了一个着重的原理讲解,大概原理就是我们通过给数组对象设置新的原型对象,从而遮蔽掉原生数组的变异方法,大概的原理可以是:
  

</>复制代码

  1. function observifyArray(array){
  2. var aryMethods = ["push", "pop", "shift", "unshift", "splice", "sort", "reverse"];
  3. var arrayAugmentations = Object.create(Array.prototype);
  4. aryMethods.forEach((method)=> {
  5. let original = Array.prototype[method];
  6. arrayAugmentations[method] = function () {
  7. // 调用对应的原生方法并返回结果
  8. // do everything you what do !
  9. return original.apply(this, arguments);
  10. };
  11. });
  12. array.__proto__ = arrayAugmentations;
  13. }

  回到Vue的源码,虽然我们知道基本原理肯定是相同的,但是我们仍然需要看看arrayAugmentations是什么?下面arrayAugmentations代码比较长。我们会在注释里面解释基本原理:
  

</>复制代码

  1. // 代码来自于array-augmentations.js
  2. var _ = require("../util")
  3. var arrayAugmentations = Object.create(Array.prototype)
  4. // 这边操作和我们之前的实现方式非常相似
  5. // 创建arrayAugmentations原型继承`Array.prototype`从而可以调用数组的原生方法
  6. // 然后通过arrayAugmentations覆盖数组的变异方法,基本逻辑大致相同
  7. ["push","pop","shift","unshift","splice","sort","reverse"].forEach(function (method) {
  8. var original = Array.prototype[method]
  9. // 覆盖arrayAugmentations中的变异方法
  10. _.define(arrayAugmentations, method, function () {
  11. var args = _.toArray(arguments)
  12. // 这里调用了原生的数组变异方法,并获得结果
  13. var result = original.apply(this, args)
  14. var ob = this.$observer
  15. var inserted, removed, index
  16. // 下面switch这一部分代码看起来很长,其实目的就是针对于不同的变异方法生成:
  17. // insert removed inserted 具体的含义对照之前的解释,了解即可
  18. switch (method) {
  19. case "push":
  20. inserted = args
  21. index = this.length - args.length
  22. break
  23. case "unshift":
  24. inserted = args
  25. index = 0
  26. break
  27. case "pop":
  28. removed = [result]
  29. index = this.length
  30. break
  31. case "shift":
  32. removed = [result]
  33. index = 0
  34. break
  35. case "splice":
  36. inserted = args.slice(2)
  37. removed = result
  38. index = args[0]
  39. break
  40. }
  41. // 如果给数组中插入新的数据,则需要调用ob.link
  42. // link函数其实在上面的_.augment(value, arrayAugmentations)之后也被调用了
  43. // 具体的实现我们可以先不管
  44. // 我们只要知道其目的就是分别对插入的数据执行响应化
  45. if (inserted) ob.link(inserted, index)
  46. // 其实从link我们就可以猜出unlink是干什么的
  47. // 主要就是对删除的数据解除响应化,具体实现逻辑后面解释
  48. if (removed) ob.unlink(removed)
  49. // updateIndices我们也先不讲是怎么实现的,
  50. // 目的就是更新子元素在parents的key
  51. // 因为pushpop是不会改变现有元素的位置,因此不需要调用
  52. // 而诸如splce shift unshift等变异方法会改变对应下标值,因此需要调用
  53. if (method !== "push" && method !== "pop") {
  54. ob.updateIndices()
  55. }
  56. // 同样我们先不考虑propagate内部实现,我们只要propagate函数的目的就是
  57. // 触发自身及其递归触发父级的事件
  58. // 如果数组中的数据有插入或者删除,则需要对外触发"length"被改变
  59. if (inserted || removed) {
  60. ob.propagate("set", "length", this.length)
  61. }
  62. // 对外触发mutate事件
  63. // 可以对照我们之前讲的测试用例"array push",就是在这里触发的,回头看看吧
  64. ob.propagate("mutate", "", this, {
  65. method : method,
  66. args : args,
  67. result : result,
  68. index : index,
  69. inserted : inserted || [],
  70. removed : removed || []
  71. })
  72. return result
  73. })
  74. })
  75. // 可以回看一下测试用例 array set,目的就是设置对应下标的值
  76. // 其实就是调用了splice变异方法, 其实我们在Vue中国想要改变某个下标的值的时候
  77. // 官网给出的建议无非是Vue.set或者就是splice,都是相同的原理
  78. // 注意这里的代码忽略了超出下标范围的值
  79. _.define(arrayAugmentations, "$set", function (index, val) {
  80. if (index >= this.length) {
  81. this.length = index + 1
  82. }
  83. return this.splice(index, 1, val)[0]
  84. })
  85. // $remove与$add都是一个道理,都是调用的是`splice`函数
  86. _.define(arrayAugmentations, "$remove", function (index) {
  87. if (typeof index !== "number") {
  88. index = this.indexOf(index)
  89. }
  90. if (index > -1) {
  91. return this.splice(index, 1)[0]
  92. }
  93. })
  94. module.exports = arrayAugmentations

  上面的代码相对比较长,具体的解释我们在代码中已经注释。到这里我们已经了解完arrayAugmentations了,我们接着看看_.augment做了什么。我们在文章从Vue数组响应化所引发的思考中讲过Vue是通过__proto__来实现数组响应化的,但是由于__proto__是个非标准属性,虽然广泛的浏览器厂商基本都实现了这个属性,但是还是存在部分的安卓版本并不支持该属性,Vue必须对此做相关的处理,_.augment就负责这个部分:
  

</>复制代码

  1. exports.augment = "__proto__" in {}
  2. ? function (target, proto) {
  3. target.__proto__ = proto
  4. }
  5. : exports.deepMixin
  6. exports.deepMixin = function (to, from) {
  7. Object.getOwnPropertyNames(from).forEach(function (key) {
  8. var desc =Object.getOwnPropertyDescriptor(from, key)
  9. Object.defineProperty(to, key, desc)
  10. })
  11. }

  我们看到如果浏览器不支持__proto__话调用deepMixin函数。而deepMixin的实现也是非常的简单,就是使用Object.defineProperty将原对象的属性描述符赋值给目标对象。接着调用了函数:
  

</>复制代码

  1. this.link(value)

  关于link函数在上面的备注中我们已经见过了:

</>复制代码

  1. if (inserted) ob.link(inserted, index)

  当时我们的解释是将新插入的数据响应化,知道了功能我们看看代码的实现:
  

</>复制代码

  1. // p === Observer.prototype
  2. p.link = function (items, index) {
  3. index = index || 0
  4. for (var i = 0, l = items.length; i < l; i++) {
  5. this.observe(i + index, items[i])
  6. }
  7. }
  8. p.observe = function (key, val) {
  9. var ob = Observer.create(val)
  10. if (ob) {
  11. // register self as a parent of the child observer.
  12. var parents = ob.parents
  13. if (!parents) {
  14. ob.parents = parents = Object.create(null)
  15. }
  16. if (parents[this.id]) {
  17. _.warn("Observing duplicate key: " + key)
  18. return
  19. }
  20. parents[this.id] = {
  21. ob: this,
  22. key: key
  23. }
  24. }
  25. }

  其实代码逻辑非常简单,link函数会对给定数组index(默认为0)之后的元素调用this.observe, 而observe其实也就是对给定的val值递归调用Observer.create,将数据响应化,并建立父级的Observer与当前实例的对应关系。前面其实我们发现Vue不仅仅会对插入的数据响应化,并且也会对删除的元素调用unlink,具体的调用代码是:

</>复制代码

  1. if (removed) ob.unlink(removed)

  之前我们大致讲过其用作就是对删除的数据解除响应化,我们来看看具体的实现:

</>复制代码

  1. p.unlink = function (items) {
  2. for (var i = 0, l = items.length; i < l; i++) {
  3. this.unobserve(items[i])
  4. }
  5. }
  6. p.unobserve = function (val) {
  7. if (val && val.$observer) {
  8. val.$observer.parents[this.id] = null
  9. }
  10. }

  代码非常简单,就是对数据调用unobserve,而unobserve函数的主要目的就是解除父级observer与当前数据的关系并且不再保留引用,让浏览器内核必要的时候能够回收内存空间。

  在arrayAugmentations中其实还调用过Observer的两个原型方法,一个是:

</>复制代码

  1. ob.updateIndices()

  另一个是:

</>复制代码

  1. ob.propagate("set", "length", this.length)

  首先看看updateIndices函数,当时的函数的作用是更新子元素在parents的key,来看看具体实现:
  

</>复制代码

  1. p.updateIndices = function () {
  2. var arr = this.value
  3. var i = arr.length
  4. var ob
  5. while (i--) {
  6. ob = arr[i] && arr[i].$observer
  7. if (ob) {
  8. ob.parents[this.id].key = i
  9. }
  10. }
  11. }

  接着看函数propagate:
  

</>复制代码

  1. p.propagate = function (event, path, val, mutation) {
  2. this.emit(event, path, val, mutation)
  3. if (!this.parents) return
  4. for (var id in this.parents) {
  5. var parent = this.parents[id]
  6. if (!parent) continue
  7. var key = parent.key
  8. var parentPath = path
  9. ? key + Observer.pathDelimiter + path
  10. : key
  11. parent.ob.propagate(event, parentPath, val, mutation)
  12. }
  13. }

  我们之前说过propagate函数的作用的就是触发自身及其递归触发父级的事件,首先调用emit函数对外触发时间,其参数分别是:事件名、路径、值、mutatin对象。然后接着递归调用父级的事件,并且对应改变触发的path参数。parentPath等于parents[id].key + Observer.pathDelimiter + path

  到此为止我们已经学习完了Vue是如何处理数组的响应化的,现在需要来看看是如何处理对象的响应化的。
  

对象  

  
  在Observer的构造函数中关于对象处理的代码是:

</>复制代码

  1. if (type === OBJECT) {
  2. if (options && options.doNotAlterProto) {
  3. _.deepMixin(value, objectAugmentations)
  4. } else {
  5. _.augment(value, objectAugmentations)
  6. }
  7. this.walk(value)
  8. }

  和数组一样,我们首先要了解一下objectAugmentations的内部实现:

</>复制代码

  1. var _ = require("../util")
  2. var objectAgumentations = Object.create(Object.prototype)
  3. _.define(objectAgumentations, "$add", function (key, val) {
  4. if (this.hasOwnProperty(key)) return
  5. _.define(this, key, val, true)
  6. var ob = this.$observer
  7. ob.observe(key, val)
  8. ob.convert(key, val)
  9. ob.emit("add:self", key, val)
  10. ob.propagate("add", key, val)
  11. })
  12. _.define(objectAgumentations, "$delete", function (key) {
  13. if (!this.hasOwnProperty(key)) return
  14. delete this[key]
  15. var ob = this.$observer
  16. ob.emit("delete:self", key)
  17. ob.propagate("delete", key)
  18. })

  相比于arrayAugmentationsobjectAgumentations内部实现则简单的多,objectAgumentations添加了两个方法: $add$delete

  $add用于给对象添加新的属性,如果该对象之前就存在键值为key的属性则不做任何操作,否则首先使用_.define赋值该属性,然后调用ob.observe目的是递归调用使得val值响应化。而convert函数的作用是将该属性转换成访问器属性getter/setter使得属性被访问或者被改变的时候我们能够监听到,具体我可以看一下convert函数的内部实现:
  

</>复制代码

  1. p.convert = function (key, val) {
  2. var ob = this
  3. Object.defineProperty(ob.value, key, {
  4. enumerable: true,
  5. configurable: true,
  6. get: function () {
  7. if (Observer.emitGet) {
  8. ob.propagate("get", key)
  9. }
  10. return val
  11. },
  12. set: function (newVal) {
  13. if (newVal === val) return
  14. ob.unobserve(val)
  15. val = newVal
  16. ob.observe(key, newVal)
  17. ob.emit("set:self", key, newVal)
  18. ob.propagate("set", key, newVal)
  19. }
  20. })
  21. }

  convert函数的内部实现也不复杂,在get函数中,如果开启了全局的Observer.emitGet开关,在该属性被访问的时候,会对调用propagate触发本身以及父级的对应get事件。在set函数中,首先调用unobserve对之间的值接触响应化,接着调用ob.observe使得新赋值的数据响应化。最后首先触发本身的set:self事件,接着调用propagate触发本身以及父级的对应set事件。

  $delete用于给删除对象的属性,如果不存在该属性则直接退出,否则先用delete操作符删除对象的属性,然后对外触发本身的delete:self事件,接着调用delete触发本身以及父级对应的delete事件。

  看完了objectAgumentations之后,我们在Observer构造函数中知道,如果传入的参数中存在op.doNotAlterProto意味着不要改变对象的原型,则采用deepMixin函数将$add$delete函数添加到对象中,否则采用函数arguments函数将$add$delete添加到对象的原型中。最后调用了walk函数,让我们看看walk是内部是怎么实现的:
  

</>复制代码

  1. p.walk = function (obj) {
  2. var key, val, descriptor, prefix
  3. for (key in obj) {
  4. prefix = key.charCodeAt(0)
  5. if (
  6. prefix === 0x24 || // $
  7. prefix === 0x5F // _
  8. ) {
  9. continue
  10. }
  11. descriptor = Object.getOwnPropertyDescriptor(obj, key)
  12. // only process own non-accessor properties
  13. if (descriptor && !descriptor.get) {
  14. val = obj[key]
  15. this.observe(key, val)
  16. this.convert(key, val)
  17. }
  18. }
  19. }

  首先遍历obj中的各个属性,如果是以$或者_开头的属性名,则不做处理。接着获取该属性的描述符,如果不存在get函数,则对该属性值调用observe函数,使得数据响应化,然后调用convert函数将该属性转换成访问器属性getter/setter使得属性被访问或者被改变的时候能被够监听。
  

总结

  到此为止,我们已经看完了整个Observer模块的所有代码,其实基本原理和我们之前设想都是差不多的,只不过Vue代码中各个函数分解粒度非常小,使得代码逻辑非常清晰。看到这里,我推荐你也clone一份Vue源码,checkout到对应的版本号,自己阅读一遍,跑跑测试用例,打个断点试着调试一下,应该会对你理解这个模块有所帮助。

  最后如果对这个系列的文章感兴趣欢迎大家关注我的Github博客算是对我鼓励,感谢大家的支持!
  
  

文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。

转载请注明本文地址:https://www.ucloud.cn/yun/95842.html

相关文章

  • Vue: Binding与Watcher

    摘要:当数据改变时,我们不需要直接触发所有的回调函数,而是去通知对应的数据的,然后由去执行相应的逻辑。对于其逻辑可能是一个指令用于连接与响应式数据或者是一个侦听器的回调函数,这样就能符合单一职责原则,解除模块之间的耦合度,让程序更易维护。 前言   首先欢迎大家关注我的Github博客,也算是对我的一点鼓励,毕竟写东西没法获得变现,能坚持下去也是靠的是自己的热情和大家的鼓励。接下来的日子我应...

    tyheist 评论0 收藏0
  • 浅析Vue响应原理(二)

    摘要:响应式原理之之前简单介绍了和类的代码和作用,现在来介绍一下类和。对于数组,响应式的实现稍有不同。不存在时,说明不是响应式数据,直接更新。如果对象是响应式的,确保删除能触发更新视图。 Vue响应式原理之Observer 之前简单介绍了Dep和Watcher类的代码和作用,现在来介绍一下Observer类和set/get。在Vue实例后再添加响应式数据时需要借助Vue.set/vm.$se...

    rockswang 评论0 收藏0
  • 预计今年发布的Vue3.0到底有什么不一样的地方?

    摘要:模板语法的将保持不变。基于的观察者机制目前,的反应系统是使用的和。为了继续支持,将发布一个支持旧观察者机制和新版本的构建。 showImg(https://segmentfault.com/img/remote/1460000017862774?w=1898&h=796); 还有几个月距离vue2的首次发布就满3年了,而vue的作者尤雨溪也在去年年末发布了关于vue3.0的计划,如果不...

    fnngj 评论0 收藏0
  • Vue 数据响应原理

    摘要:接下来,我们就一起深入了解的数据响应式原理,搞清楚响应式的实现机制。回调函数只是打印出新的得到的新的值,由执行后生成。及异步更新相信读过前文,你应该对响应式原理有基本的认识。 前言 Vue.js 的核心包括一套响应式系统。 响应式,是指当数据改变后,Vue 会通知到使用该数据的代码。例如,视图渲染中使用了数据,数据改变后,视图也会自动更新。 举个简单的例子,对于模板: {{ name ...

    Mike617 评论0 收藏0

发表评论

0条评论

最新活动
阅读需要支付1元查看
<