什么是 dva？

dva 首先是一个基于 redux 和 redux-saga 的数据流方案，然后为了简化开发体验，dva 还额外内置了 react-router 和 fetch，所以也可以理解为一个轻量级的应用框架。

特性

  • 易学易用，仅有 6 个 api，对 redux 用户尤其友好，配合 umi 使用后更是降低为 0 API
  • elm 概念，通过 reducers, effects 和 subscriptions 组织 model
  • 插件机制，比如 dva-loading 可以自动处理 loading 状态，不用一遍遍地写 showLoading 和 hideLoading
  • 支持 HMR，基于 babel-plugin-dva-hmr 实现 components、routes 和 models 的 HMR

API

app = dva(opts)

创建应用，返回 dva 实例。(注：dva 支持多实例)
opts 包含：

  • history：指定给路由用的 history，默认是 hashHistory
  • initialState：指定初始数据，优先级高于 model 中的 state，默认是 {}
1
2
3
4
5
import createBrowserHistroy from "history/createHistroy";
const app = dva({
  // 替换history为browserHisotry
  history: createBroserHistroy(),
});

app.use(hooks)

配置 hooks 或者注册插件。（插件最终返回的是 hooks ）

app.model(model)

model 是 dva 中最重要的概念。以下是典型的例子：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
app.model({
  namespace: "todo",
  state: [],
  reducers: {
    add(state, { payload: todo }) {
      // 保存数据到 state
      return [...state, todo];
    },
  },
  effects: {
    *save({ payload: todo }, { put, call }) {
      // 调用 saveTodoToServer，成功后触发 `add` action 保存到 state
      yield call(saveTodoToServer, todo);
      yield put({ type: "add", payload: todo });
    },
  },
  subscriptions: {
    setup({ history, dispatch }) {
      // 监听 history 变化，当进入 `/` 时触发 `load` action
      return history.listen(({ pathname }) => {
        if (pathname === "/") {
          dispatch({ type: "load" });
        }
      });
    },
  },
});

model 包含 5 个属性：

namespace

model 的命名空间，同时也是他在全局 state 上的属性，只能用字符串，不支持通过 . 的方式创建多层命名空间。

state

初始值，优先级低于传给 dva() 的 opts.initialState。

reducers

以 key/value 格式定义 reducer。用于处理同步操作，唯一可以修改 state 的地方。由 action 触发。
格式为 (state, action) => newState 或 [(state, action) => newState, enhancer]。

effects

以 key/value 格式定义 effect。用于处理异步操作和业务逻辑，不直接修改 state。由 action 触发，可以触发 action，可以和服务器交互，可以获取全局 state 的数据等等。
格式为 (action, effects) => void 或 [(action, effects) => void, { type }]。
type 类型有：

  • takeEvery
  • takeLatest
  • throttle
  • watcher

subscriptions

以 key/value 格式定义 subscription。subscription 是订阅，用于订阅一个数据源，然后根据需要 dispatch 相应的 action。在 app.start() 时被执行，数据源可以是当前的时间、服务器的 websocket 连接、keyboard 输入、geolocation 变化、history 路由变化等等。格式为 ({ dispatch, history }, done) => unlistenFunction。注意：如果要使用 app.unmodel()，subscription 必须返回 unlisten 方法，用于取消数据订阅。

app.unmodel(namespace)

取消 model 注册，清理 reducers, effects 和 subscriptions。subscription 如果没有返回 unlisten 函数，使用 app.unmodel 会给予警告 ⚠️。

app.replaceModel(model)

替换 model 为新 model，清理旧 model 的 reducers, effects 和 subscriptions，但会保留旧的 state 状态，对于 HMR 非常有用。subscription 如果没有返回 unlisten 函数，使用 app.unmodel 会给予警告 ⚠️。
如果原来不存在相同 namespace 的 model，那么执行 app.model 操作

app.router(({ history, app }) => RouterConfig)

注册路由表。
通常是这样的：

1
2
3
4
5
6
7
8
import { Router, Route } from "dva/router";
app.router(({ history }) => {
  return (
    <Router history={history}>
      <Route path="/" component={App} />
    </Router>
  );
});

推荐把路由信息抽成一个单独的文件，这样结合 babel-plugin-dva-hmr 可实现路由和组件的热加载，比如：

1
app.router(require("./router"));

app.start(selector?)

启动应用。selector 可选，如果没有 selector 参数，会返回一个返回 JSX 元素的函数

1
app.start("#root");

那么什么时候不加 selector？常见场景有测试、node 端、react-native 和 i18n 国际化支持。
比如通过 react-intl 支持国际化的例子：

1
2
3
4
import { IntlProvider } from 'react-intl';
...
const App = app.start();
ReactDOM.render(<IntlProvider><App /></IntlProvider>, htmlElement);