Mobx4X状态管理入门

共计 13253 个字符，预计需要花费 34 分钟才能阅读完成。

原本说接下来会专注学 nodejs, 但是最新工作又学习了一些有意思的库, 於是就再写下来做个简单的入门, 之前我写过一篇文章, 这个也算是作為一个补充吧.

这次无非就是类似笔记, 把认为的一些关键点记下来, 有些地方还没用到就衹是描述一下, 代码有些自己写的, 有些文档写的很好就搬下来, 想瞭解更多可看官网
Mobx 中文文档
Mobx 英文文档
Github 仓库

PS：
2018/06/11 发现中文版有些关键地方没翻译，补充一下 observable({})/observable.object(props, decorators?, options?)部分

通过透明的响应式编程使状态管理变得简单和可扩展, 背后哲学是任何源自应用状态的东西都应自动获得,(包括 UI, 数据序列化, 服务器通讯等)

React 通过提供机制把应用状态转换成可渲染组件树并对其渲染, 优化 UI 渲染, 就是通过使用虚拟 DOM 减少昂贵的 DOM 变化数量.
Mobx 提供机制来存储和更新应用状态供 React 使用, 优化应用状态和 React 组件同步, 通过使用响应式的虚拟依赖状态图表, 让其在需要的时候才更新并且保持最新.

个人感觉与 Redux 相比除了目的一致是管理应用状态之外. 不管是写法还是思想都截然不同. 因為才刚入门, 这裡只说用法不讲区别.

我们先看看这段代码做了什麼, 再分开详细讲解一下对应知识点

observable(组件): 转成响应式组件, 会自动转换应用状态和更新;
get 函数: 计算值, 根据现有的状态或其它计算值衍生出的值;
autorun 函数: 类似 get, 依赖关系改变时触发;
action: 改变状态, 严格模式下所有修改操作都应该在 action 裡面执行;

import {observable, autorun} from 'mobx';

var todoStore = observable({
  /* 一些观察的状态 */
  todos: [],

  /* 推导值 */
  get completedCount() {return this.todos.filter(todo => todo.completed).length;
  },
});

/* 观察状态改变的函数 */
autorun(function() {
  console.log(
    'Completed %d of %d items',
    todoStore.completedCount,
    todoStore.todos.length
  );
});

/* .. 以及一些改变状态的动作 */
todoStore.todos[0] = {
  title: 'Take a walk',
  completed: false,
};
// -> 同步打印 'Completed 0 of 1 items'

todoStore.todos[0].completed = true;
// -> 同步打印 'Completed 1 of 1 items'

官方流程图:

// 标準用法
observable(value)
// 装饰器用法
@observable classProperty = value

Observable 值可以是 JS 基本数据类型、引用类型、普通对象、类实例、数组和映射. 匹配类型应用了以下转换规则，但可以通过使用调节器进行微调.

Map: 返回一个新的 Observable Map, 不但对一个特定项的更改做出反应，而且对添加或删除该项也做出反应;
数组: 会返回一个 Observable Array;
没有原型的对象: 那么对象会被克隆并且所有的属性都会被转换成可观察的;
有原型的对象: JavaSript 原始数据类型或者函数，observable 会拋出错误, 如果你想要创建一个独立的

observable 引用例如值可以使用 Boxed Observable observables.MobX 不会将一个有原型的对象自动转换成可观察的，因为这是它构造函数的职责. 可以在 constructor 使用 extendObservable 或者类型定义使用 decorate 替代.

values: 可以是对象、数组或者字符串键的 ES6 map;
options:

deep: 决定分配给 observable 映射的值会否通过 observable 来传递使其转变成可观察的;
name: 调试名称，用于 spy 或者 MobX 开发者工具;

const map = observable.map(new Map());

以下是 MobX 提供方法:

toJS(): 将 observable 映射转换成普通映射;
toJSON(): 返回此映射的浅式普通对象表示.(想要深拷贝，请使用 mobx.toJS(map));
intercept(interceptor): 可以用来在任何变化作用于映射前将其拦截;
observe(listener, fireImmediately?): 注册侦听器，在映射中的每个更改时触发;
merge(values): 把提供对象的所有项拷贝到映射中.values 可以是普通对象、entries 数组或者 ES6 字符串键的映射;
replace(values): 用提供值替换映射全部内容. 是 .clear().merge(values) 的简写形式;

这是递归的，所以数组中的所有 (未来的) 值都会是可观察的.
options:

deep: 决定分配给 observable 映射的值会否通过 observable 来传递使其转变成可观察的;
name: 调试名称，用于 spy 或者 MobX 开发者工具;

const ary = observable.array([1, 2, 4]);

注意:
observable.array 会创建一个人造数组 (类数组对象) 来代替真正的数组. 支持所有的原生方法，包括从索引的分配到包含数组长度.

验证类型方法的话返回不是数组. 可以通过使用 array.slice() 在 observable 数组传递给外部库或者内置方法前创建一份浅拷贝;
sort 和 reverse 函数实现不会改变数组本身，而是返回一个排序过 / 反转过的拷贝;

以下是 MobX 提供方法:

intercept(interceptor): 可以用来在任何变化作用于数组前将其拦截;
observe(listener, fireImmediately? = false): 监听数组的变化. 回调函数将接收表示数组拼接或数组更改的参数，它符合 ES7 提议. 它返回一个清理函数以用来停止监听器;
clear(): 从数组中删除所有项;
replace(newItems): 用新项替换数组中所有已存在的项;
find(predicate: (item, index, array) => boolean, thisArg?): 基本上等同于 ES7 的 Array.find 提议;
findIndex(predicate: (item, index, array) => boolean, thisArg?): 基本上等同于 ES7 的 Array.findIndex 提议;
remove(value): 通过值从数组中移除一个单个的项. 如果项被找到并移除的话，返回 true ;
peek(): 和 slice() 类似, 返回一个有所有值的数组并且数组可以放心的传递给其它库, 但是不创建保护性拷贝;

一个普通的 JavaScript 对象 (指不是使用构造函数创建出来的对象，而是以 Object 作为其原型，或者根本没有原型)传递给 observable 方法，对象的所有属性都将被拷贝至一个克隆对象并将克隆对象转变成可观察的.
这是递归应用的，所以如果对象的某个值是一个对象或数组，那么该值也将通过 observable 传递.
options:

deep: 决定分配给 observable 映射的值会否通过 observable 来传递使其转变成可观察的;
name: 调试名称，用于 spy 或者 MobX 开发者工具;

const obj = observable.object({key: "value"});

注意:

[MobX 4 及以下]当通过 observable 传递对象时，只有在把对象转变 observable 时存在的属性才会是可观察的. 稍后添加到对象的属性不会变为可观察的，除非使用 set 或 extendObservable;
只有普通的对象可以转变成 observable . 对于非普通对象，构造函数负责初始化 observable 属性. 要么使用 @observable 注解[color=#b1b1b1](annotation, 这个解释不太懂??)，要么使用 extendObservable 函数;
属性的 getter 会自动转变成衍生属性，就像 @computed 所做的;
observable 是自动递归到整个对象的. 在实例化过程中和将来分配给 observable 属性的任何新值的时候.Observable 不会递归到非普通对象中;
更细粒度的控制，比如哪些属性应该转变成可观察的和如何变成可观察的，请参见装饰器;

JavaScript 中的所有原始类型值都是不可变的，因此它们都是不可观察的,box 创建一个基于 ref 装饰器的箱子. 这意味着箱子里的任何 (将来) 值都不会自动地转换成 observable .
options:
1) name: 调试名称，用于 spy 或者 MobX 开发者工具;

const box = observable.box('box');
box.observe(function(change) {console.log(change.oldValue, '->', change.newValue);
});

以下是 box 提供方法:

get(): 返回当前值;
set(value): 替换当前存储的值并通知所有观察者;
intercept(interceptor): 可以用来在任何变化应用前将其拦截;
observe(callback: (change) => void, fireImmediately = false): 注册一个观察者函数，每次存储值被替换时触发. 返回一个函数以取消观察者.change 是一个对象，其中包含 observable 的 newValue 和 oldValue .

定义 observable 属性的行为, 默认为对任意键值对使用 observable.deep，对 getters 使用 computed .

observable: observable.deep 的别名
observable.deep: 任何 observable 都使用的默认的调节器. 它将任何 (尚未成为 observable) 数组，映射或纯对象克隆并转换为 observable 对象，并将其赋值给给定属性
observable.ref: 禁用自动的 observable 转换，只是创建一个 observable 引用
observable.shallow: 只能与集合组合使用. 将任何分配的集合转换为 observable，但该集合的值将按原样处理
observable.struct: 就像 ref, 但会忽略结构上等于当前值的新值
computed: 创建一个衍生属性, 参见 computed
computed(options): 同 computed , 可设置选项
computed.struct: 与 computed 相同，但是只有当视图产生的值与之前的值结构上有不同时，才通知它的观察者
action: 创建一个动作, 参见 action
action(name): 创建一个动作，重载了名称
action.bound: 创建一个动作, 并将 this 绑定到了实例

class Person {name = 'John';}
// 使用 decorate 时，所有字段都应该指定 (毕竟，类里的非 observable 字段可能会更多)
decorate(Person, {name: observable,});

任何源自状态并且不会再有任何进一步的相互作用的东西就是衍生, 衍生以多种形式存在:

用户界面
衍生数据，比如剩下的待办事项的数量.
后端集成，比如把变化发送到服务器端.

MobX 区分两种类型的衍生:

Computed values(计算值): 它们是永远可以使用纯函数 (pure function) 从当前可观察状态中衍生出的值;
Reactions(反应): Reactions 是当状态改变时需要自动发生的副作用. 需要有一个桥梁来连接命令式编程 (imperative programming) 和响应式编程(reactive programming). 或者说得更明确一些，它们最终都需要实现 I / O 操作;

计算值 (computed values) 是可以根据现有的状态或其它计算值衍生出的值. 如果你想响应式的产生一个可以被其它 observer 使用的值，请使用 @computed. 计算值在大多数情况下可以被 MobX 优化的, 例如:

前一个计算中使用的数据没有更改，计算属性将不会重新运行;
某个其它计算属性或 reaction 未使用该计算属性，也不会重新运行. 在这种情况下，它将被暂停;
一个计算值不再被观察了，例如使用它的 UI 不复存在了，MobX 可以自动地将其垃圾回收;

注意:

计算属性是不可枚举的，它们也不能在继承链中被覆盖;
可以使用 observe 或 keepAlive 来强制保持计算值总是处于唤醒状态;
observable.object 和 extendObservable 都会自动将 getter 属性推导成计算属性;
如果计算值在其计算期间抛出异常，则此异常将捕获并在读取其值时重新抛出. 强烈建议始终抛出“错误”，以便保留原始堆栈跟踪. 抛出异常不会中断跟踪，所有计算值可以从异常中恢复.

计算值的 setter:

不能用来直接改变计算属性的值，但是它们可以用来作“逆向”衍生. 就是反向计算;
必须在 getter 之后定义 setter，一些 TypeScript 版本会知道声明了两个具有相同名称的属性;
这是一个自动的动作，只需要直接使用 set xx(){};

class Test {
    @observable num = 0;

    @computed get total() {return this.num * 10;}

    set total(value) {this.num = value / 10;}
}
//OR
const Test = observable.object({
    num: 0;

    get total() {return this.num * 10;}

    set total(value) {this.num = value / 10;}
})

某些情况下，你需要传递一个“在 box 中”的计算值时，它可能是有用的.
options:

name: 调试名称，用于 spy 或者 MobX 开发者工具;
context: 在提供的表达式中使用的 this;
set: 要使用的 setter 函数. 没有 setter 的话无法为计算值分配新值. 如果传递给 computed 的第二个参数是一个函数，那么就把会这个函数作为 setter;
equals: 默认值是 comparer.default . 它充当比较函数. 如果前后值相等，那么观察者就不会重新评估;
requiresReaction: 对于非常昂贵的计算值，推荐设置成 true . 如果你尝试读取它的值，但某些观察者没有跟踪该值（在这种情况下，MobX 不会缓存该值），则会导致计算结果丢失，而不是进行昂贵的重新评估;
keepAlive: 如果没有任何人观察到，则不要使用此计算值. 请注意，这很容易导致内存泄漏，因为它会导致此计算值使用的每个 observable，并将计算值保存在内存中;

MobX 提供了三个内置 comparer (比较器) :

comparer.identity: 使用恒等 (===) 运算符来判定两个值是否相同;
comparer.default: 等同于 comparer.identity，但还认为 NaN 等于 NaN ;
comparer.structural: 执行深层结构比较以确定两个值是否相同;

const box = observable('box'),
  upperCaseName = computed(() => name.get().toUpperCase()),
  disposer = upperCaseName.observe(change => console.log(change.newValue));
box.set('Dave');

创建一个响应式函数，而该函数本身永远不会有观察者, 调用后将接收一个参数，即当前 reaction(autorun)，可用于在执行期间清理 autorun. 当使用 autorun 时，所提供的函数总是立即被触发一次，然后每次它的依赖关系改变时会再次被触发, 相比之下 computed(function)创建的函数只有当它有自己的观察者时才会重新计算，否则它的值会被认为是不相关的;
options:

delay: 可用于对效果函数进行去抖动的数字(以毫秒为单位). 如果是 0(默认值) 的话，那么不会进行去抖.
name: 调试名称，用于 spy 或者 MobX 开发者工具;
onError: 用来处理 reaction 的错误，而不是传播它们;
scheduler: 设置自定义调度器以决定如何调度 autorun 函数的重新运行;

var numbers = observable([1, 2, 3]);
var sum = computed(() => numbers.reduce((a, b) => a + b, 0));

var disposer = autorun(() => console.log(sum.get()));
// 输出 '6'
numbers.push(4);
// 输出 '10'

disposer();
// 清理 autorun
numbers.push(5);
// 不会再输出任何值.`sum` 不会再重新计算.

when 观察并运行给定的 predicate，直到返回 true. 一旦返回 true，给定的 effect 就会被执行，然后 autorunner(自动运行程序) 会被清理. 该函数返回一个清理器以提前取消自动运行程序.

class MyResource {constructor() {
        when(
            // 一旦...
            () => !this.isVisible,
            // ... 然后
            () => this.dispose()
        );
    }

    @computed get isVisible() {// 标识此项是否可见}

    dispose() {// 清理}
}

如果没提供 effect 函数，when 会返回一个 Promise . 它与 async / await 可以完美结合.

async function() {await when(() => that.isVisible)
    // 等等..
}

第一个数据函数是用来追踪并返回数据作为第二个作用函数的入参. 不同于 autorun 的是当创建时函数不会直接运行，只有在数据表达式首次返回一个新值后才会运行. 在执行作用函数时访问的任何 observable 都不会被追踪.
reaction 返回一个清理函数, 接收两个参数，即当前的 reaction，可以用来在执行期间清理 reaction .

options:

fireImmediately: 布尔值，用来标识效果函数是否在数据函数第一次运行后立即触发. 默认值是 false，如果一个布尔值作为传给 reaction 的第三个参数，那么它会被解释为 fireImmediately 选项;
delay: 可用于对效果函数进行去抖动的数字(以毫秒为单位). 如果是 0(默认值) 的话，那么不会进行去抖;
equals: 默认值是 comparer.default . 它充当比较函数. 如果前后值相等，那么观察者就不会重新评估;
name: 调试名称，用于 spy 或者 MobX 开发者工具;
onError: 用来处理 reaction 的错误，而不是传播它们;
scheduler: 设置自定义调度器以决定如何调度 autorun 函数的重新运行:

const todos = observable([
    {title: "test1"}, {title: "test2"}
]);

// 会对长度变化作出反应
reaction(() => todos.length, length => console.log("reaction 1:", todos.map(todo => todo.title).join(",")));
// 会对某个 todo 的 title 变化作出反应
reaction(() => todos.map(todo => todo.title), titles => console.log("reaction 2:", titles.join(",")));

// autorun 对它函数中使用的任何东西作出反应
autorun(() => console.log("autorun:", todos.map(todo => todo.title).join(",")));
// 输出:
// autorun: test1

action(() => {todos.push({title: "test3"});
})()
// 输出:
// autorun: test1, test2, test3
// reaction 2: test1, test2, test3
// reaction 1: test1, test2, test3

action(() => {todos[1].title = 'test4';
})()
// 输出:
// autorun: test1, test4, test3
// reaction 2: test1, test4, test3

observer 函数 / 装饰器可以用来将 React 组件 / 无状态函数组件转变成响应式组件. 它用 mobx.autorun 包装了组件的 render 函数以确保任何组件渲染中使用的数据变化时都可以强制刷新组件.

observer 是由单独的 mobx-react 包提供的. 确保 observer 是最深处 (第一个应用) 的装饰器，否则它可能什么都不做;
如果传递给组件的数据是响应式的,observer 还可以防止当组件的 props 只是浅改变时的重新渲染, 这个行为与 React PureComponent 相似，不同在于这里的 state 的更改仍然会被处理. 如果一个组件提供了它自己的 shouldComponentUpdate，这个方法会被优先调用;

import {observer} from "mobx-react";
var timerData = observable({secondsPassed: 0});

setInterval(() => {timerData.secondsPassed++;}, 1000);

@observer class Timer extends React.Component {render() {return (<span>Seconds passed: { this.props.timerData.secondsPassed} </span> )
    }
};
//OR
const Timer = observer(({timerData}) =>
    <span>Seconds passed: {timerData.secondsPassed} </span>
);

@observer class Timer extends React.Component {
    @observable secondsPassed = 0

    componentWillMount() {setInterval(() => {this.secondsPassed++}, 1000)
    }

    render() {return (<span>Seconds passed: { this.secondsPassed} </span> )
    }
}

在 React 组件上引入可观察属性. 这意味着你可以在组件中拥有功能同样强大的本地状态(local state)，而不需要通过 React 的冗长和强制性的 setState 机制来管理. 响应式状态会被 render 提取调用，但不会调用其它 React 的生命周期方法，除了 componentWillUpdate 和 componentDidUpdate . 如果你需要用到其他 React 生命周期方法，只需使用基于 state 的常规 React API 即可.

const App = () =>
  <Provider colors={colors}>
     <app stuff... />
  </Provider>;

const Button = inject("colors")(observer(({ colors, label}) =>
  <button style={{color: colors.foreground}}
  >{label}<button>
));

当组件重新渲染时被触发, 这使得它很容易追溯渲染并找到导致渲染的操作(action).

不接收参数;
初始化渲染前不会触发 (使用 componentWillMount 替代);
对于 mobx-react@4+, 当接收新的 props 时并在 setState 调用后会触发此钩子;

action(fn)
action(name, fn)
@action classMethod() {}
@action(name) classMethod () {}
@action boundClassMethod = (args) => {body}
@action(name) boundClassMethod = (args) => {body}
@action.bound classMethod() {}

action 可以是任何用来修改状态的东西, 只执行查找，过滤器等函数不应该被标记为 action，以允许 MobX 跟踪它们的调用. 可以有助于更好的组织代码.

自动地将动作绑定到目标对象. 与 action 不同的是不需要一个 name 参数，名称将始终基于动作绑定的属性.
因為箭头函数已经是绑定过的并且不能重新绑定, 所以不能一起使用

class Ticker {
    @observable tick = 0

    @action.bound
    increment() {this.tick++ // 'this' 永远都是正确的}
}

action 包装 / 装饰器只会对当前运行的函数作出反应，而不会对当前运行函数所调用的函数（不包含在当前函数之内）作出反应！这意味着如果 action 中存在 setTimeout、promise 的 then 或 async 语句，并且在回调函数中某些状态改变了，那么这些回调函数也应该包装在 action 中.

错误写法, 抛出异常

class TrafficLight {
    @observable status = "yellow" // "red" / "green" / "yellow"

    @action
    fetchProjects() {
        this.status = "yellow"
        toggleLight().then(
            res => {this.status = "green"},
            err => {this.status = "red"}
        )
    }
}

// 包装修復在 action

class TrafficLight {
    @observable status = "yellow" // "red" / "green" / "yellow"

    @action
    handleAjax() {
        this.status = "yellow"
        toggleLight().then(
            this.handleSuc,
            this.handleErr
        )
    }

    @action.bound
    handleSuc(res){this.status = "green"}

    @action.bound
    handleErr(err){this.status = "red"}

}

// 另一种内嵌写法

class TrafficLight {
    @observable status = "yellow" // "red" / "green" / "yellow"

    @action
    handleAjax() {
        this.status = "yellow"
        toggleLight().then(
            action('handleSuc',res => {this.status = "green"}),
            action('handleErr',res => {this.status = "red"})
        )
    }
}

runInAction(name?, thunk)
runInAction 是个简单的工具函数，它接收代码块并在 (异步的) 动作中执行. 这对于即时创建和执行动作非常有用.

class TrafficLight {
    @observable status = "yellow" // "red" / "green" / "yellow"

    @action
    handleAjax() {
        this.status = "yellow"
        toggleLight().then(
            runInAction(res => {this.status = "green"}),
            runInAction(res => {this.status = "red"})
        )
    }
}

async / await
async / await 只是围绕基于 promise 过程的语法糖. 结果是 @action 仅应用于代码块，直到第一个 await . 在每个 await 之后，一个新的异步函数将启动，所以在每个 await 之后，状态修改代码应该被包装成动作.

class TrafficLight {
    @observable status = "yellow" // "red" / "green" / "yellow"

    @action
    async handleAjax() {
        this.status = "yellow"
        toggleLight().then(
            try{const result = await dosometings();
                runInAction(res => {this.status = result;}),
            }catch(err){
                runInAction(res => {this.status = "red";})
            }
        )
    }
}

flow 内置概念
优点是它在语法上基本与 async / await 是相同的 (只是关键字不同)，并且不需要手动用 @action 来包装异步代码，这样代码更简洁.

class TrafficLight {
    @observable status = "yellow" // "red" / "green" / "yellow"

    @action
    handleAjax = flow(function* () {
        this.status = "yellow"
        toggleLight().then(
            try{const result = yield dosometings();
                this.status = result;
            }catch(err){this.status = "red";}
        )
    })
}

这些 API 都是响应式的，这意味着如果使用 set 进行添加，使用 values 或 keys 进行迭代，即便是新属性的声明都可以被 MobX 检测到.

values(thing): 将集合中的所有值作为数组返回;
keys(thing): 将集合中的所有键作为数组返回;
set(thing, key, value)/set(thing, { key: value}): 使用提供的键值对来更新给定的集合;
remove(thing, key): 从集合中移除指定的项. 用于数组拼接;
has(thing, key): 如果集合中存在指定的 observable 属性就返回 true;
get(thing, key): 返回指定键下的子项;

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

const twitterUrls = observable.object({"John": "twitter.com/johnny"})

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

autorun(() => {console.log("All urls:" + values(twitterUrls).join(","))
})

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

不想摘抄了, 看文档吧 …
Mobx 工具函数

不想摘抄了, 看文档吧 …
Mobx 贴士与技巧

(更多内容请自行查阅, 本节到此为止了.)

前言

Mobx4.X

官方代码

State(状态)

observable

observable(new Map())/observable.map(values, options)

observable([])/observable.array(values, options)

observable({})/observable.object(props, decorators?, options?)

observable.box(value)

装饰器

Derivations(衍生)

(@)computed

computed(expression,options) 函数用法

Autorun(expression,options)

when(predicate: () => boolean, effect?: () => void, options?)

when-promise

reaction(() => data, (data, reaction) => {sideEffect}, options?)

@observer

可观察的局部组件状态

inject 组件连接 stores

提供生命週期 componentWillReact

action (动作)

action.bound

编写异步 Actions

工具 API

Mobx 工具函数

Mobx 技巧与问题

Just My Socks（注册教程内含优惠码）