npm 包 mobx-state-tree 使用教程

阅读时长 8 分钟读完

简介

Mobx-state-tree 是一个用于构建可扩展、可维护和可测试的应用程序的框架,它结合了 Mobx 和类型系统,使得应用程序在处理复杂数据结构时更加简单和轻松。它提供了一组强大的工具和方法,使得构建应用程序变得更加直观且容易理解。本文将会从安装、依赖、使用以及基本测试方面讲解 npm 包 Mobx-state-tree 的使用方法。

安装

在终端中使用 npm 下载 Mobx-state-tree:

依赖

在项目中使用前,需要在项目中安装以下依赖:

  • mobx
  • mobx-react-lite

使用

Mobx-state-tree 的主要功能是将应用程序的数据模型转换为一个以单一根节点为核心的可观察状态树。 在 Mobx-state-tree 中,可以定义 Models,Views 和 Actions 三个基本概念,它们分别对应应用程序的数据状态、界面和行为。

1. 定义 Models

Model 是应用程序中定义的数据模型,用于描述应用程序的数据状态和状态之间的关系。Models 在 Mobx-state-tree 中由一个包含所有字段和相关状态的 Schema 描述。以下是一个简单的 Model 的示例:

-- -------------------- ---- -------
------ - ----- - ---- ------------------

----- ------- - ---------------------- -
    --- -------------
    ----- ------------
---

----- ---- - ------------------- -
    --- -------------
    --------- ------------
---

----- ---- - --------------------
    --------- ---------------------
    ------ ------------------
---

2. 定义 Views

View 是应用程序中定义的可视化层,用于显示 Model 的某些部分。在 Mobx-state-tree 中,View 是由一个 React 组件描述的。以下是一个简单的 View 的示例:

-- -------------------- ---- -------
------ - -------- - ---- ------------------

----- -------- - ----------- --------- -- -- -
    ------ -
        -----
            ------------------------- -- -
                ------ -
                    -----
                        ----------------------------
                    ------
                --
            ---
            ------------------------------- -- -
                ------ -
                    -----
                        ---------------------------
                    ------
                --
            ---
        ------
    --
---

3. 定义 Actions

Action 是应用程序中的行为,用于封装数据状态的变化。在 Mobx-state-tree 中,Action 是由一个可变方法描述的。以下是一个简单的 Action 的示例:

4. 创建 Model 实例

当 Model 被定义好之后,我们需要创建 Model 的实例,并将其传递给 React 组件。通过调用 types.create() 方法来创建一个 Model 实例:

-- -------------------- ---- -------
------ - ----- - ---- ------------------

----- ------- - ---------------------- -
    --- -------------
    ----- ------------
---

----- ---- - ------------------- -
    --- -------------
    --------- ------------
---

----- ---- - --------------------
    --------- ---------------------
    ------ ------------------
---

----- --------- - -------------
    --------- ---
    ------ --
---

------------------------- --------------------- --- ---------------------------------

5. 对 Model 数据进行修改

在 Mobx-state-tree 中,我们可以通过 Action 对 Model 的数据进行修改:

-- -------------------- ---- -------
----- ----------- - --------- -- --
    ------------- -
        ---------------------------
    --
    ------------------- -
        ---------------------------------
    -
---

----- --------- - -------------
    --------- ---
    ------ --
---

----- ----------- - -----------------------

--------------------- --- -- --------- ------- ---

------------------------ --- -- ----- ------- ------- ---

6. 监听 Model 数据的变化

使用 Mobx-state-tree 实现的 Model 可以通过观察者进行监视,每次数据发生变化时都会触发。

-- -------------------- ---- -------
----- -------- - ----------- --------- -- -- -
    ------ -
        -----
            ------------------------- -- -
                ------ -
                    -----
                        ----------------------------
                    ------
                --
            ---
            ------------------------------- -- -
                ------ -
                    -----
                        ---------------------------
                    ------
                --
            ---
        ------
    --
---

测试

在 Mobx-state-tree 中,我们可以使用 Jest 来进行单元测试,以确保我们的代码在运行时不包含错误。

以下是一个简单的测试示例:

-- -------------------- ---- -------
------ - ----- - ---- ------------------

----- ------- - ---------------------- -
    --- -------------
    ----- ------------
---

----- ---- - ------------------- -
    --- -------------
    --------- ------------
---

----- ---- - --------------------
    --------- ---------------------
    ------ ------------------
---

-------------- ------- -- -- -
    ---------- ------ -- ----- ------ -- -- -
        ----- --------- - -------------
            --------- ---
            ------ --
        ---

        ---------------------------------------
        ------------------------------------------
    ---

    ---------- --- - ------ -- -- -
        ----- --------- - -------------
            --------- ---
            ------ --
        ---

        ------------------- --- -- --------- ------- ---

        ---------------------------------------
    ---
---

结论

Mobx-state-tree 是一个非常有用的工具,它可以帮助我们更轻松地管理应用程序中的复杂数据结构。本文介绍了如何使用 Mobx-state-tree 创建 Models、Views 和 Actions,并对如何在 React 组件中使用 Model 数据进行了简要介绍。另外,我们还演示了如何使用 Jest 进行单元测试来确保代码在运行时不出错。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/mobx-state-tree