使用dva改造旧项目的数据流方案
韩子卢 人气:0前言
最近在给自己的脚手架项目转到TypeScript时,遇到了一些麻烦。
项目之前采用的是react + react-redux + redux-thunk + redux-actions +redux-promise的体系。
当项目转TypeScript时,react和react-redux这种完美转换。
redux-actions转换也初步完成,但是各种为了适应TypeScript的声明很奇怪, 并且有些类型推断错误。
百度了一下,用typesafe-actions去替换,然后与redux-thunk 和redux-promise结合后,各种TypeScript类型错误。
这些类型推断稀奇古怪,网上也没有这个技术体系的相关文章,下班后调试代码,内心逐渐崩溃。
于是有了接下来的举措,用dva去替换react-redux + redux-thunk + redux-actions +redux-promise的数据流方案。
关于dva
关于dva的介绍咱们就不说了,这里给个链接:dva指南。
明白它是基于 redux + react-router + redux-saga 的封装就够了。
我之前的脚手架是将action,reducer+initialState 分成了不同的文件来处理。
而dva将 reducer, initialState, action, saga 这些数据流相关的都放在model中一起处理。
安装dva
网上很多都是安装dva-cli,然后再用 dva-quickstart。
然而我们是旧项目,我们现在只想用dva的数据流方案,所以不可能这么做。
使用dva,我们只需要安装dva就好了:
npm i --save dva
我的dva版本是最新稳定版:2.4.1。
先看一下改造前的代码
在dva中,数据流相关的操作都是放在model中的,下面给一个示例:
在改造之前我们看一下原有的代码入口js的代码:
import React, { Suspense } from 'react';
import { createStore, applyMiddleware } from 'redux';
import { Provider } from 'react-redux';
import thunk from 'redux-thunk';
import createLogger from 'redux-logger';
import promiseMiddleware from 'redux-promise';
import ReactDOM from 'react-dom';
import { HashRouter as Router, Route, Switch } from 'react-router-dom';
import reducer from 'store/reducers';
import './app.less';
import Frame from 'modules/layout/Frame'
function Loading() {
return <div>Loading...</div>;
}
const PageMain = React.lazy(() => import('modules/pageMain'));
const store = createStore(reducer, applyMiddleware(thunk, createLogger, promiseMiddleware));
const App = () => (
<Provider store={store}>
<Router>
<Suspense fallback={<Loading />}>
<Frame>
<Switch>
<Route path='/' component={PageMain} />
</Switch>
</Frame>
</Suspense>
</Router>
</Provider >
);
ReactDOM.render(<App />, document.getElementById('app'));
改造入口js
先贴上改造后的代码:
import createLogger from 'redux-logger';
import dva from 'dva'
import routerConfig from './route/index'
import pageMainModel from 'modules/pageMain/model'
import { createHashHistory } from 'history';
const app = dva({
history: createHashHistory(),
onAction: createLogger
});
app.model(pageMainModel)
app.router(routerConfig)
app.start('#app')
首先我们新建了一个dva对象,这个dva对象设置了路由为hash路由,并且集成了createLogger这个redux中间件。
更多参数配置可以查看:API文档。
然后我们调用
app.model(pageMainModel)
这一步主要是设置了数据流中数据的初始化和如何进行处理,具体后面会讲。
接着调用
app.router(routerConfig)
这一步dva设置了应用的路由,这是因为dva中集成了react-router-dom,所以可以进行路由设置。
当然接一下
app.start('#app')
也很好理解,对应原有代码中的 ReactDOM.render 。
接一下我们再讲一下具体的代码。
改造路由部分
上面的代码比原有代码看起来精简很多,有一大半原因是我没有将route的配置提取出去。
所以我们先讲一下改造后路由 /route/index :
import React, { Suspense } from 'react'
import { Router, Switch, Route } from 'dva/router'
import Frame from 'modules/layout/Frame'
function Loading() {
return <div>Loading...</div>;
}
const PageMain = React.lazy(() => import('modules/pageMain'));
const RouterConfig = (({ history }) => (
<Router history={history}>
<Suspense fallback={<Loading />}>
<Frame>
<Switch>
<Route path="/" >
<PageMain />
</Route>
</Switch>
</Frame>
</Suspense>
</Router>
));
export default RouterConfig;
因为集成的是react-router-dom,所以基本上不需要改变,只需要按照dva.router的格式修改即可。
这里需要注意的是dva集成的react-router-dom是v4.1.2版本,还不能识别这种React.lazy这种最新的懒加载方式。
所以要将配置在Route组件的component参数上的懒加载组件PageMain,修改为Route组件的子组件,否则会报错。
改造reducer
首先看下咱们原有的代码:
import { handleActions } from 'redux-actions';
import * as T from './actionTypes';
const initialState = {
fundDatas: []
};
const pageMainReducer = handleActions({
[T.GET_DATA_LIST]:
{
next(state, action) {
if (!action.payload.data.Data) {
return {
...state,
fundDatas: []
}
}
return {
...state,
fundDatas: action.payload.data.Data.LSJZList.reverse().map(l => ({
netValueDate: l.FSRQ,
netValue: l.DWJZ,
totalNetValue: l.LJJZ,
dayOfGrowth: l.JZZZL
}))
}
},
throw(state) {
return state;
},
}
}, initialState);
export default pageMainReducer;
这里T.GET_DATA_LIST是action的type的文本。
然后看下改造后的代码
import { getFundData } from 'services/fundService'
export default {
namespace: 'pageMainModel',
state: {
fundDatas: []
},
effects: {
*getDatas({ payload }, { call, put }) {
const { data } = yield call(getFundData, payload);
const fundDatas = data.Data.LSJZList.reverse().map((l) => ({
netValueDate: l.FSRQ,
netValue: l.DWJZ,
totalNetValue: l.LJJZ,
dayOfGrowth: l.JZZZL
}))
yield put({ type: 'refreshDatas', payload: fundDatas });
},
},
reducers: {
refreshDatas(state, { payload }) {
return {
...state,
fundDatas: payload
}
},
},
};
dva集成的是redux-saga,所以有使用经验的应该比较懂。
namespace是命名空间,用作各个model的key。
state是初始化值。
effects主要用来处理异步操作。
reducer部分和原有reducer类似。
另外getFundData的格式如下:
export const getFundData = (params: IGetFundParams) => {
const { fundCode, startDate, endDate, pageSize } = params
return axios.get(`http://localhost:8011/getList?fundCode=${fundCode}&startDate=${startDate}&endDate=${endDate}&pageSize=${pageSize}`)
};
改造action
下面是原有action
import { createAction } from 'redux-actions';
import axios from 'axios'
import * as T from './actionTypes';
/**
* 获取基金数据
*/
export const getDataList = createAction(T.GET_DATA_LIST, (fundCode, startDate, endDate, pageSize) => {
return axios.get(`http://localhost:8011/getList?fundCode=${fundCode}&startDate=${startDate}&endDate=${endDate}&pageSize=${pageSize}`)
});
connect到相应组件后的调用方式为:
this.props.getDataList(fundCode, startDate, endDate, pageSize)
然后我们经过之前的改造已经没有了不再需要action这个文件,使用的时候直接使用以下方式:
this.props.dispatch({
type: 'pageMainModel/getDatas',
payload: { fundCode, startDate, endDate, pageSize }
})
这里的dispacth是dva的connect直接封装传递到组件的。
改造容器组件
先给改造后的代码:
import React from 'react';
import { connect } from 'dva';
const mapStateToProps = ({ pageMainModel }) => {
return {
fundDatas: pageMainModel.fundDatas
};
}
/**
* 首页
*/
@connect(mapStateToProps)
export default class PageMain extends React.Component {
componentDidMount() {
this.getList()
}
// 获取基金数据
getList = () => {
// ...
this.props.dispatch({
type: 'pageMainModel/getDatas',
payload: { fundCode, startDate, endDate, pageSize }
})
}
render() {
//...
}
}
改造前的代码就不给了,因为涉及的改动比较少,只需要注意dva的conenct只需要将redux的state传到组件,不需要将调用action的函数传入即可。
总结
最开始改造的目的是为了ts,但是等改造完成再去看dva的相关示例时,发现dva官网推荐的项目示例umi-dva-antd-mobile中的model文件中都加了
// @ts-ignore
来隐藏文件中的ts报错。(感觉有点囧啊,不过整个改造的过程还是蛮多收获的)
不过我自己的方案是将model.js的后缀不修改为ts,项目会避开对js文件的转换和检测。
总的来说,我只是对自己做的脚手架项目进行了一个改造,如果旧项目较大的话,改造起来还是挺费劲的。
博客中的代码都或多或少进行了删减,具体的项目代码可以查看我的Github项目:脚手架项目。
加载全部内容