跳到主要内容

理解响应性

Mobx 通常会像你所期待的那样对确定的一些事物做出响应,这意味着在 90% 的用例中 Mobx 都应该能正常工作。 但是在不确定的某个时间,你可能会遇到一些情况,Mobx 并没有在这些情况下做出你所预想的响应。 面对这些情况,理解 Mobx 如何确定要对哪些事物做出响应是十分重要的。

Mobx 会对跟踪函数执行时读取的任何 存在的 可观察的 属性 做出响应。

  • “读取” 使用一个对象的属性, “读取”有两种方式。一种是点访问(dotting into),例如 user.name 。另一种是方括号访问,例如 user['name']todos[3]
  • “跟踪函数” 其可以是 computed 的表达式、作为 observer 的 React 函数式组件的渲染(rendering)、作为 observer 的 React 类组件的 render() 方法,也可以是作为第一个参数传递给 autorunreactionwhen 的函数。
  • “跟踪函数执行时” 这意味着只有那些在跟踪函数执行时读取的可观察对象才会被跟踪。这些值在跟踪函数中是直接使用还是间接使用并不重要。但是从函数“引发”出来的东西将不会被跟踪(例如, setTimeout promise.thenawait 等)。

换句话说,MobX 将不会对下面的情况做出响应:

  • 从可观察对象中获取到,但是并没有在跟踪函数中使用的值
  • 在异步调用的代码块中读取的可观察值

MobX 跟踪属性的访问,而不是属性的值本身

为了用一个例子详细说明上述规则,我们假设你有以下可观察的实例:

class Message {
title
author
likes
constructor(title, author, likes) {
makeAutoObservable(this)
this.title = title
this.author = author
this.likes = likes
}

updateTitle(title) {
this.title = title
}
}

let message = new Message("Foo", { name: "Michel" }, ["Joe", "Sara"])

在内存中这个例子将会像下图所示的这样,绿色的块代表的是 可观察的 属性,注意 值本身 并不是可观察的!

MobX reacts to changing references

简单来说,MobX 所做的就是记录下你在跟踪函数中所使用的属性的箭头指向(就像上图中的箭头那样)。在此之后,当这些箭头中的任何一个发生变化(比如该箭头从一个值指向另一个值)时,MobX 都会响应变化,并重新执行相应的跟踪函数。

实例

让我们通过一组实例来说明上述的内容(会继续使用到上面定义的 message 变量):

正确的做法:在跟踪函数中使用某个对象的属性

autorun(() => {
console.log(message.title)
})
message.updateTitle("Bar")

这个例子将会产生符合期待的响应。 .title 属性被 autorun 函数使用,并且该属性在后面发生了改变,因此这个变化会被捕捉到。

你可以通过在跟踪函数中调用 trace() 来验证 MobX 进行了跟踪,在上面函数所示的情况下,它将输出以下内容:

import { trace } from "mobx"

const disposer = autorun(() => {
console.log(message.title)
trace()
})
// 打印出:
// [mobx.trace] 'Autorun@2' tracing enabled

message.updateTitle("Hello")
// 打印出:
// [mobx.trace] 'Autorun@2' is invalidated due to a change in: 'Message@1.title'
Hello

也可以使用 getDependencyTree 获取内部依赖(或观察者)树:

import { getDependencyTree } from "mobx"

// 打印耦合到 disposer 中的响应的依赖树
console.log(getDependencyTree(disposer))
// 打印出:
// { name: 'Autorun@2', dependencies: [ { name: 'Message@1.title' } ] }

不正确的做法:更改一个不可观察引用的值

autorun(() => {
console.log(message.title)
})
message = new Message("Bar", { name: "Martijn" }, ["Felicia", "Marcus"])

不会 使 MobX 响应。message 发生了改变,但是 message 本身并不是可观察的,它仅仅是一个 指向 一个可观察对象的变量,但是其变量(引用)本身是不可观察的。

不正确的做法:在跟踪函数外部使用可观察属性

let title = message.title
autorun(() => {
console.log(title)
})
message.updateMessage("Bar")

不会 使 MobX 响应。message.titleautorun 函数的外面被引用,并且在被引用时只是 message.title 的值(字符串 "Foo"),title 不是一个可观察对象,因此 autorun 永远不会对 title 的变化做出响应。

正确的做法:在跟踪函数内部使用可观察属性

autorun(() => {
console.log(message.author.name)
})

runInAction(() => {
message.author.name = "Sara"
})
runInAction(() => {
message.author = { name: "Joe" }
})

这些变化都将引发 MobX 的响应,authorauthor.name 都被使用了,这使得 MobX 可以跟踪它们。

注意,我们必须在这里使用 runInAction 才能在 action 之外进行更改。

不正确的做法:在不跟踪的情况下保留一个可观察对象的局部引用

const author = message.author
autorun(() => {
console.log(author.name)
})

runInAction(() => {
message.author.name = "Sara"
})
runInAction(() => {
message.author = { name: "Joe" }
})

第一个改变将会被捕捉,message.authorauthor 是同一个对象,属性 .name 在 autorun 中被使用了,可以触发响应。 但是,第二个改变并 不会 被捕捉,因为 message.author 并没有被 autorun 跟踪,autorun 跟踪的是 author.name,autorun 依然会继续使用之前定义的“老的” author

常见陷阱:console.log

autorun(() => {
console.log(message)
})

// 这不会引发 autorun 的重新执行
message.updateTitle("你好,世界!")

在上面的例子中,更新的信息的标题并不会被打印出来,因为他没有在 autorun 中被使用。 autorun 只会依赖于 messagemessage 不是一个可观察对象,它只是一个变量。换句话说,MobX 所关心的 title 并没有被 autorun 使用。

如果你在 web 浏览器调试工具中测试该实例,你可能会发现 title 更新后的值,但其实这是一种误导 —— autorun 在第一次调用时只运行了一次。之所以会这样是因为 console.log 是一个异步函数,对象只是在稍后格式化。这意味着,如果按照调试工具栏中的标题进行操作,则可以找到更新的值。但 autorun 不会跟踪任何更新。

使其能够被正常跟踪的方法是确保将不可变数据或者保护性副本传递给 console.log。因此下面的所有方法都能使 message.title 的变化被响应:

autorun(() => {
console.log(message.title) // 很明显,可观察的 .title 被使用了。
})

autorun(() => {
console.log(mobx.toJS(message)) // toJS 创建一个深拷贝的对象,也因此 message.title 被使用
})

autorun(() => {
console.log({ ...message }) // 创建一个浅拷贝,展开时 message.title 也会被使用
})

autorun(() => {
console.log(JSON.stringify(message)) // JSON 序列化,也会使用 message.title
})

正确的做法:在跟踪函数中访问数组的属性

autorun(() => {
console.log(message.likes.length)
})
message.likes.push("Jennifer")

这将会引发符合预期的响应。.length 也会被认为是一个属性。 注意:发生在该数组中的 任何 变化都会引发响应。 数组不是按索引或属性(如可观察对象和 maps)跟踪的,而是作为一个整体跟踪的。

不正确的做法:在跟踪函数中的访问越界的索引

autorun(() => {
console.log(message.likes[0])
})
message.likes.push("Jennifer")

这个实例将会对上面的示例数据作出响应,因为数组索引算作属性访问。但 前提 是提供的 index < length。 MobX 不跟踪尚未存在的数组索引。 因此,请始终使用 .length 检查(数组越界检查)来保护基于数组索引的访问。

正确的做法:在跟踪函数中访问数组的方法

autorun(() => {
console.log(message.likes.join(", "))
})
message.likes.push("Jennifer")

这将会引发符合预期的响应。所有不改变数组的数组函数都会被自动跟踪。


autorun(() => {
console.log(message.likes.join(", "))
})
message.likes[2] = "Jennifer"

这将会引发符合预期的响应。所有的数组索引赋值都会被检测到,但只有在 index <= length 的情况下。

不正确的做法:“使用”可观察对象但是没有访问其任何的属性

autorun(() => {
message.likes
})
message.likes.push("Jennifer")

这将 不会 引发响应,仅仅是因为 likes 数组本身并没有被 autorun 使用,使用的仅仅是该数组的引用。 相比之下,messages.likes = ['Jennifer'] 将会被捕捉并响应,该语句不修改 likes 数组,修改的是 likes 属性本身。

正确的做法:使用尚不存在的字典的键

const twitterUrls = observable.map({
Joe: "twitter.com/joey"
})

autorun(() => {
console.log(twitterUrls.get("Sara"))
})

runInAction(() => {
twitterUrls.set("Sara", "twitter.com/horsejs")
})

会引发 响应。可观察字典(map)支持跟踪可能还不存在键值对。 请注意,这将在最初打印出 undefined。 你可以通过使用 twitterUrls.has("Sara") 检查键值对在字典中是否存在。 所以在没有代理(Proxy)支持的环境下,动态的键值对集合总是使用可观察字典来实现。如果你有代理(Proxy)支持,也可以使用可观察字典, 当然你也可以选择使用普通对象。

MobX 不跟踪异步访问的数据

function upperCaseAuthorName(author) {
const baseName = author.name
return baseName.toUpperCase()
}
autorun(() => {
console.log(upperCaseAuthorName(message.author))
})

runInAction(() => {
message.author.name = "Chesterton"
})

这将会引发响应。尽管 author.name 并没有被接收了 upperCaseAuthorNameautorun 函数直接引用,MobX 依然会跟踪发生在 upperCaseAuthorName 中的引用,因为这个引用发生在 autorun 的 执行过程 中。


autorun(() => {
setTimeout(() => console.log(message.likes.join(", ")), 10)
})

runInAction(() => {
message.likes.push("Jennifer")
})

不会 引发响应。因为在 autorun 的执行过程中,没有任何的可观察对象被访问使用了,只是在 setTimeout 中使用了可观察对象,但是 setTimeout 是异步函数,它不是可跟踪的。

看看 异步行为 章节获得更多理解。

使用不可观察的对象属性

autorun(() => {
console.log(message.author.age)
})

runInAction(() => {
message.author.age = 10
})

当你在一个支持代理(Proxy)的环境中运行 React 时,这 会引发 响应。 请注意,这仅适用于使用 observableobservable.object 创建的对象。类实例对象上后续增加的新属性将不会自动成为可观察的。

不支持代理(Proxy)的环境

这将 不会 引发响应,MobX 只能跟踪可观察属性,上面实例中的 age 并没有被定义为可观察属性。

但是,可以通过使用 MobX 暴露出的 getset 方法解决这个问题:

import { get, set } from "mobx"

autorun(() => {
console.log(get(message.author, "age"))
})
set(message.author, "age", 10)

[无代理支持] 不正确的做法:使用尚不存在的对象属性

autorun(() => {
console.log(message.author.age)
})
extendObservable(message.author, {
age: 10
})

这将 不会 引发响应,MobX 不会在跟踪开始时对不存在的可观察属性做出响应。 如果这两个语句被交换,或者任何其他可观察的语句导致 autorun 重新运行,autorun 也将开始跟踪 age

[无代理支持] 正确的做法:使用 MobX 实用工具读/写对象

如果你的环境不支持代理(Proxy),但是仍然希望将可观察对象用作一个动态集合,那么可以使用 MobX 的 getset API 来解决这个问题。

下面的例子也将会引发响应:

import { get, set, observable } from "mobx"

const twitterUrls = observable.object({
Joe: "twitter.com/joey"
})

autorun(() => {
console.log(get(twitterUrls, "Sara")) // `get` 可以跟踪尚不存在的属性
})

runInAction(() => {
set(twitterUrls, { Sara: "twitter.com/horsejs" })
})

看看 集合工具API 获取更多细节。

摘要

Mobx 会对跟踪函数执行时读取的任何 存在的 可观测的 属性 做出响应。