dva 首先是一个基于 redux 和 redux-saga 的数据流方案,而后为了简化开发体验,dva 还额外内置了 react-router 和 fetch,因此也能够理解为一个轻量级的应用框架。
dva官网地址:https://dvajs.com/html
import dva from 'dva'; // 1. Initialize const app = dva(); // 2. Plugins app.use({}); // 3. Model app.model(require('./models/example').default); // 4. Router app.router(require('./router').default); // 5. Start app.start('#root');
dva仅有6个api,以下介绍:node
建立应用,返回dva实例react
options中包含:web
(1) history:默认为hashHistory,若是要配置history为browserHistory,则redux
import createHistory from 'history/createBrowserHistory'; const app = dva({ history: createHistory(), });
(2) initialState: 指定初始数据,优先级高于model中的state,默认为{}react-native
(3) onError: 管理全局出错状态,以下:api
const app = dva({ onError(e){ console.log(e); } });
(4) onAction(fn | fn[]): 在action被dispatch时触发,用于注册redux中间件,支持函数格式或者函数数组格式,以下经过redux-logger答应日志,如:数组
import createLogger from 'redux-logger'; const app = dva({ onAction: createLogger(opts), });
(5) onStateChange(fn): state改变时触发,可用于同步state 到 localStorage,服务器端等服务器
(6) onReducer(fn): 封装 reducer 执行。好比借助 redux-undo 实现 redo/undo :babel
import undoable from 'redux-undo'; const app = dva({ onReducer: reducer => { return (state, action) => { const undoOpts = {}; const newState = undoable(reducer, undoOpts)(state, action); // 因为 dva 同步了 routing 数据,因此须要把这部分还原 return { ...newState, routing: newState.present.routing }; }, }, });
(7) onEffect(fn): 封装 effect 执行。好比 dva-loading 基于此实现了自动处理 loading 状态。
(8) onHmr(fn): 热替换相关,目前用于 babel-plugin-dva-hmr
(9) extraReducers: 指定额外的 reducer,好比 redux-form 须要指定额外的 form reducer
import { reducer as formReducer } from 'redux-form' const app = dva({ extraReducers: { form: formReducer, }, });
(10) extraEnhancers: 指定额外的 StoreEnhancer ,好比结合 redux-persist 的使用
import { persistStore, autoRehydrate } from 'redux-persist'; const app = dva({ extraEnhancers: [autoRehydrate()], }); persistStore(app._store);
配置 hooks 或者注册插件。(插件最终返回的是 hooks )
好比注册 dva-loading 插件的例子:
import createLoading from 'dva-loading'; ... app.use(createLoading(opts));
hooks 包含2中(3)到(10)
注册model
model 是 dva 中最重要的概念,如下是典型的例子:
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,以下:
const app = dva({ initialState: { count: 1 }, }); app.model({ namespace: 'count', state: 0, });
此时,在 app.start() 后 state.count 为 1
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 }]。
subscriptions: 以 key/value 格式定义 subscription。subscription 是订阅,用于订阅一个数据源,而后根据须要 dispatch 相应的 action。在 app.start() 时被执行,数据源能够是当前的时间、服务器的 websocket 链接、keyboard 输入、geolocation 变化、history 路由变化等等。格式为 ({ dispatch, history }, done) => unlistenFunction。注意:若是要使用 app.unmodel(),subscription 必须返回 unlisten 方法,用于取消数据订阅。
取消 model 注册,清理 reducers, effects 和 subscriptions。subscription 若是没有返回 unlisten 函数,使用 app.unmodel 会给予警告
注册路由表。一般是这样的:
import { Router, Route } from 'dva/router'; app.router(({ history }) => { return ( <Router history={history}> <Route path="/" component={App} /> <Router> ); });
推荐把路由信息抽成一个单独的文件,这样结合 babel-plugin-dva-hmr 可实现路由和组件的热加载,好比:
app.router(require('./router'));
而有些场景可能不使用路由,好比多页应用,因此也能够传入返回 JSX 元素的函数。好比:
app.router(() => <App />);
启动应用。selector 可选,若是没有 selector 参数,会返回一个返回 JSX 元素的函数。
app.start('#root');
那么何时不加 selector?常见场景有测试、node 端、react-native 和 i18n 国际化支持。
好比经过 react-intl 支持国际化的例子:
import { IntlProvider } from 'react-intl'; ... const App = app.start(); ReactDOM.render(<IntlProvider><App /></IntlProvider>, htmlElement);