MobX 简易上手指南

本文不详细介绍 MobX 相关的所有内容,但已经可以覆盖开发中 99% 的场景。不讲其他内容是为了避免干扰我们的思路,需要更高阶内容可查看官方文档。

本文基于 MobX 4.x 来介绍

目录

  • Mobx
  • mobx-react

MobX

概念

简单来说,MobX 是状态管理工具。当应用状态更新时,任何源自应用状态的东西都将自动地获得。

Observable state 可观察状态

import { observable } from "mobx";

class Todo {
    id = Math.random();
    @observable title = "";
    @observable finished = false;
}

通过@observable注解来标记一个属性为可观察。底层是通过把该属性转化成getter/setter来实现的。虽然名字叫做可观察状态,但并不需要使用者主动观察(例如调用addListener),具体看下方介绍

Computed values 计算值

class TodoList {
    @observable todos = [];
    @computed get unfinishedTodoCount() {
        return this.todos.filter(todo => !todo.finished).length;
    }
}

如上 @computed 所示即为计算值,是相关状态变化时自动更新的值。计算值只有在被使用时才会自动更新。

Reactions 反应

前面提到可观察状态发生变化时,无需主动监听特定的可观察状态或计算值。这当中用到的就是Reactions 反应反应使用特定的方法把使用到可观察状态的代码包裹起来。反应和计算值类似,在反应内部使用到的状态发生变化时,会自动重新运行。和计算值不同在于,计算值用于计算新值,不应该有副作用,而反应的目的是对外界做出影响,例如更新UI、发送网络请求、打印日志等。

反应的作用机制是,在执行入参中的方法时,通过可观察状态计算值getter 搜集该反应的依赖,在依赖发生变化时,重新运行该反应中定义的方法。

@observer
class TodoView extends React.Component {
    render() {
        return <div>{this.props.todo.title}</div>
    }
}

上面例子中的组件经过@observer注解包装后,其render方法会被包裹进一个reaction中。在第一次render执行过后,其使用到的todo.title若发生变化,会重新执行render。

Actions 动作

如果每次修改一个可观察状态就重新运行一次反应,在某些场景下会显得过于频繁。动作这个概念可以理解为批量操作,或理解为事务。一个动作内部包含的多次对可观察状态的修改只会在动作执行完毕后,一次性重新计算计算值和执行反应。

action@action可以把一个函数包装成动作,而@action.boundaction的语义之上添加了绑定this到当前对象中的功能。使用场景如:

class Ticker {
    @observable tick = 0

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

const ticker = new Ticker()
setInterval(ticker.increment, 1000)

runInAction(fn)可以简单的认为是action(fn)()的语法糖。把参数 fn 包装成一个 action 后马上执行。

import { runInAction } from "mobx";
runInAction(() => {
    todos.push(new Todo());
    todos[0].finished = true;
})

使用动作的另外一个好处是明确表示其内部包含对可观察状态的修改,提醒开发者注意。

可以通过配置使项目中对状态的修改都限定在action中,方法如下:

import { configure } from "mobx";
configure({ enforceActions: true });

异步 actions 和 flows

@action 只会对当前运行的函数做出反应,对于一些不在当前函数中调用的回调是无效的,例如 setTimeout 回调、Promisethenasync 语句。这些回调如果修改了状态,也应该用 action 包裹起来。以下两种方法均可处理该问题:

  1. 修改状态的语句用 runInAction 包裹起来
  2. 使用 flow 函数。注意 flow 不能作为装饰器
class Store {
    @observable githubProjects = []
    @observable state = "pending" // "pending" / "done" / "error"

    @action
    async fetchProjects() {
        this.githubProjects = []
        this.state = "pending"
        try {
            const projects = await fetchGithubProjectsSomehow()
            const filteredProjects = somePreprocessing(projects)
            // await 之后,再次修改状态需要动作:
            runInAction(() => {
                this.state = "done"
                this.githubProjects = filteredProjects
            })
        } catch (error) {
            runInAction(() => {
                this.state = "error"
            })
        }
    }
}

关于flow的用法,由于涉及到generator,此处暂不介绍。

mobx-react

mobx-react是连接MobXreact的桥梁,主要是通过把render包裹在Reactions中,使得状态变化时能自动重新渲染。

observer

import React, {Component} from 'react';
import ReactDOM from 'react-dom';
import {observer} from 'mobx-react';

@observer
class TodoListView extends Component {
    render() {
        return (
            <div>
                <ul>
                    {this.props.todoList.todos.map(todo =>
                        <TodoView todo={todo} key={todo.id} />
                    )}
                </ul>
                Tasks left: {this.props.todoList.unfinishedTodoCount}
            </div>
        )
    }
}

const TodoView = observer(({todo}) =>
    <li>
        <input
            type="checkbox"
            checked={todo.finished}
            onClick={() => todo.finished = !todo.finished}
        />{todo.title}
    </li>
)

const store = new TodoList();
ReactDOM.render(<TodoListView todoList={store} />, document.getElementById('mount'));

如上所示,store是可观察状态,由于TodoListViewTodoView通过@observerobserver包裹起来,在状态发生变化时会自动更新UI。

类形式的Component多使用装饰器@observer,函数形式的Component多使用函数observer

Observer

由于每次 store 改变都需要重新执行 render 方法,若render方法太复杂或要渲染的东西太多,则可能会引起性能问题。对此,官方推荐的是使用大量的小组件并且使用独立的组件渲染列表。基于的原则是动静分离,使需要重新渲染的区域范围尽量少。

但每个小区域都需要写成一个组件的话显得太繁琐。<Observer> 组件就是为了减少模板代码而引入的。<Observer> 接受一个无参函数作为 children,该函数返回要渲染的内容。当其中的状态发生变化时,该函数会重新执行,更新UI。

class App extends React.Component {
    render() {
        return (
            <div>
                {/* 一大段内容 */}
                <Observer>{() => <div>{this.props.person.name}</div>}</Observer>
                {/* 一大段内容 */}
            </div>
        )
    }
}

const person = observable({ name: "John" })

React.render(<App person={person} />, document.body)
person.name = "Mike"

上面的例子中,当 person.name 发生变化时,只有 <Observer> 当中的内容会自动更新,外部的render函数不会重新执行。

一般情况下,使用 @observer 已经足够,当需要优化性能时再考虑使用 <Observer>

贴士

不要拷贝 observables 属性并存储在本地

由于 mobx 是基于 getter 来搜集依赖的,所以在 reaction 中需要有 读取属性 的操作才能被记录下。以下是错误示范,因为 @observer 包装的组件,只有 render 方法被包装进 reaction 中:

class User {
  @observable name
}
@observer
class Profile extends React.Component {
  name
  componentWillMount() {
    // 错误的,这会间接引用 user.name 并只拷贝值一次!
    // 未来的更新不会被追踪,因为生命周期钩子不是响应的
    // 像这样的赋值会创建冗余数据
    this.name = this.props.user.name
  }
  render() {
    return <div>{this.name}</div>;
    // 应该使用
    // return <div>{this.props.user.name}</div>;
    // 或使用计算属性
  }
}

间接引用值尽可能晚的使用

@observer
class Profile extends React.Component {
  render() {
    // 不合适,若user.name被修改,则整个Profile组件会被重新render
    return (
        <div><Header name={this.props.user.name}/></div>
    );
    // 性能更优。传递user到Header,若user.name被修改,只有Header组件会被更新
    // return (
    //     <div><Header user={this.props.user}/></div>
    // );
  }
}

使用slice获取真正的数组

Observable 数组实际上是对象,在需要真正数组的场合可以使用 .slice() 方法。

进阶

需要更进一步了解 mobx 可参考官方文档

其中两个章节较为重要:

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

推荐阅读更多精彩内容

  • 1. 介绍 1.1. 原理 React的render是 状态 转化为树状结构的渲染组件的方法而MobX提供了一种存...
    三月懒驴阅读 12,847评论 1 28
  • 本文首发于:CSDN「前端开发者说」公众号。CSDN「前端开发者说」公众号(ID:bigfrontend),专注前...
    RachelQG阅读 4,789评论 2 20
  • 总希望真心相待这个世界,真诚对待每一个人,这样就不会换来虚假和心机..到头来却是自欺欺人,总希望自己找一片所谓的净...
    潼乐阅读 256评论 0 0
  • 既想发现新的东西,又想留有自己固定习惯,这就是我的上网习惯,想必也有很多人跟我一样,毕竟网络世界是一个不断变化...
    b5ef34b1e5a5阅读 17,868评论 1 3
  • 不知不觉2016就这样悄然离去,G恍如隔世般在脑海中搜索2016逝去的痕迹。匆匆一年,身心疲惫。 01 伴随着...
    懿芝熊阅读 231评论 0 0