使用dva改造React舊項目的數據流方案

前言

最近在給自己的腳手架項目轉到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就好了：

npm i --save dva

博客發布時dva最新穩定版是：2.4.1。

先看一下改造前的代碼

在改造之前我們看一下原有入口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路由，並且集成了redux-logger這個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項目：腳手架項目。