[译] Redux 异步四兄弟

在十分钟内实践 ThunkSagaObservable 以及 Redux Promise Middleware

在上一次的 React Native online meetup 活动中,笔者就 Thunk 、 Saga 以及 Redux Observable 之间的不一样之处作了报告 (点击此处获取幻灯片)javascript

上述函数库都提供了一些方法用以处理 Redux 应用中带有反作用的或者是异步的 action。更多关于为何要用到这些库的介绍,请 点击此处html

相较于仅仅是建立一个仓库,而后查看和测试这些库的实现方法,笔者但愿更进一步,即一步步地弄清这些库是如何解决异步在 Redux 中产生的反作用,并额外增长一种方案 —— Redux Promise Middlewarejava

笔者第一次接触 Redux 的时候,就被这些异步的、带有反作用的函数库搞得“头昏脑胀”。 虽然相关文档还算齐全,但仍是但愿可以结合实际项目去深刻理解这些函数库是如何解决 Redux 中的异步问题。从而快速上手,避免浪费过多时间。react

在本教程中,笔者将应用上述函数库,一步步地实现一个拉取数据并将数据存储在 reducer 中的简单例子。android

如图所示,上述函数库最通用的模式之一就是发起一个 API 请求,显示加载图标,数据返回后展现结果(若是出现错误则展现错误信息)。笔者将依次使用上述 4 个函数库实现该功能。ios

开始

在本例中笔者将使用 React Native,固然使用 React 也是彻底同样的 —— 只须要把 View 替换为 div, 把 Text 替换为 p 便可。 在本节中,笔者将仅仅实现一个简单的 Redux 示例应用,以展现上述 4 个函数库的用法。git

首先运行 react-native init 命令建立一个空项目:github

react-native init redux4ways复制代码

固然也可使用 create-react-app:redux

create-react-app redux4ways复制代码

而后进入项目目录:c#

cd redux4ways复制代码

安装所需依赖:

yarn add redux react-redux redux-thunk redux-observable redux-saga rxjs redux-promise-middleware复制代码

建立将要用到的相关目录和文件:

mkdir reducers复制代码
touch reducers/index.js reducers/dataReducer.js复制代码
touch app.js api.js configureStore.js constants.js actions.js复制代码

至此,全部依赖都已安装完毕,相关文件业已新建稳当,能够着手编码开发了。

首先将 index.ios (ios) 或 index.android.js (android) 中的代码更新以下:

import React from 'react'
import {
  AppRegistry
} from 'react-native'

import { Provider } from 'react-redux'
import configureStore from './configureStore'
import App from './app'

const store = configureStore()

const ReduxApp = () => (
  <Provider store={store}> <App /> </Provider>
)复制代码
  1. react-redux 中引入 Provider
  2. 引入 configureStore,随后将建立该文件。
  3. 引入 App 做为本例应用中的入口组件。
  4. 调用 configureStore() 方法建立 store。
  5. App 包裹在 Provider 中并传入上述 store。

接着建立 actions 和 reducer 所涉及的相关常量,constants.js 文件内容以下:

export const FETCHING_DATA = 'FETCHING_DATA'
export const FETCHING_DATA_SUCCESS = 'FETCHING_DATA_SUCCESS'
export const FETCHING_DATA_FAILURE = 'FETCHING_DATA_FAILURE'复制代码

再接着建立 dataReducerdataReducer.js 文件内容以下:

import { FETCHING_DATA, FETCHING_DATA_SUCCESS, FETCHING_DATA_FAILURE } from '../constants'
const initialState = {
  data: [],
  dataFetched: false,
  isFetching: false,
  error: false
}

export default function dataReducer (state = initialState, action) {
  switch (action.type) {
    case FETCHING_DATA:
      return {
        ...state,
        data: [],
        isFetching: true
      }
    case FETCHING_DATA_SUCCESS:
      return {
        ...state,
        isFetching: false,
        data: action.data
      }
    case FETCHING_DATA_FAILURE:
      return {
        ...state,
        isFetching: false,
        error: true
      }
    default:
      return state
  }
}复制代码
  1. 引入相关常量。
  2. 该 reducer 的初始状态 initialState 是一个对象,该对象由 1 个数组 data 和 3 个布尔类型的变量:dataFetchedisFetching 以及 error 构成。
  3. 该 reducer 负责处理 3 种类型的 actions 并相应地更新状态。例如,若是 action 的类型是 FETCHING_DATA_SUCCESS, 则将新数据添加到状态对象中并将 isFetching 设为 false

接下来须要建立 reducer 的入口文件,在该文件中会对全部的 reducers 调用 combineReducers 方法(在本例中只有一个 reducer,即 dataReducer.js )。

reducers/index.js 文件内容以下:

import { combineReducers } from 'redux'
import appData from './dataReducer'

const rootReducer = combineReducers({
    appData
})

export default rootReducer复制代码

以后则须要建立相应的 actions,actions.js 文件内容以下:

import { FETCHING_DATA, FETCHING_DATA_SUCCESS, FETCHING_DATA_FAILURE } from './constants'

export function getData() {
  return {
    type: FETCHING_DATA
  }
}

export function getDataSuccess(data) {
  return {
    type: FETCHING_DATA_SUCCESS,
    data,
  }
}

export function getDataFailure() {
  return {
    type: FETCHING_DATA_FAILURE
  }
}

export function fetchData() {}复制代码
  1. 引入相关常量。
  2. 定义 4 个函数,其中 3 个 (getDatagetDataSuccessgetDataFailure)会直接返回 action,第 4 个(fetchData)则会更新一个 thunk (具体实现见下文)。

接着定义 configureStore:

import { createStore } from 'redux'
import app from './reducers'

export default function configureStore() {
  let store = createStore(app)
  return store
}复制代码
  1. ./reducers 中引入 root reducer。
  2. 暴露用以建立 store 的函数接口。

最后, 对接页面 UI 并绑定相应 props:

import React from 'react'
import { TouchableHighlight, View, Text, StyleSheet } from 'react-native'

import { connect } from 'react-redux'
import { fetchData } from './actions'

let styles

const App = (props) => {
  const {
    container,
    text,
    button,
    buttonText
  } = styles

  return (
    <View style={container}> <Text style={text}>Redux Examples</Text> <TouchableHighlight style={button}> <Text style={buttonText}>Load Data</Text> </TouchableHighlight> </View>
  )
}

styles = StyleSheet.create({
  container: {
    marginTop: 100
  },
  text: {
    textAlign: 'center'
  },
  button: {
    height: 60,
    margin: 10,
    justifyContent: 'center',
    alignItems: 'center',
    backgroundColor: '#0b7eff'
  },
  buttonText: {
    color: 'white'
  }
})

function mapStateToProps (state) {
  return {
    appData: state.appData
  }
}

function mapDispatchToProps (dispatch) {
  return {
    fetchData: () => dispatch(fetchData())
  }
}

export default connect(
  mapStateToProps,
  mapDispatchToProps
)(App)复制代码

此处代码不言自明 —— connect 方法用于将当前 Redux store 的状态和引入的 actions 做为 props 传入目标展现性组件中,即此例中的 App

最后须要一个模拟的数据接口,该接口返回一个 promise,该 promise 会在 3 秒钟后 reslove,并返回相应数据。对应文件 api.js 内容以下:

const people = [
  { name: 'Nader', age: 36 },
  { name: 'Amanda', age: 24 },
  { name: 'Jason', age: 44 }
]

export default () => {
  return new Promise((resolve, reject) => {
    setTimeout(() => {
      return resolve(people)
    }, 3000)
  })
}复制代码

在该文件中,首先建立一个含有人员信息的数组,而后暴露一个实现了上述模拟接口功能的方法。

Redux Thunk

至此,Redux 已经和 React 链接了起来,接下来引入第一个异步函数库 —— Redux Thunk。(branch

首先须要建立一个 thunk

Redux Thunk middleware 容许 action 建立函数返回一个函数而不是 action。 该中间件能够用于延迟 action 的 dispatch 过程, 或仅当知足特定条件时才 dispatch action;其内部函数接受两个参数:dispatchgetState。 ” —— Redux Thunk 文档

actions.js 文件中,更新函数 fetchData 并引入 api:

import { FETCHING_DATA, FETCHING_DATA_SUCCESS, FETCHING_DATA_FAILURE } from './constants'
import getPeople from './api'

export function getData() {
  return {
    type: FETCHING_DATA
  }
}

export function getDataSuccess(data) {
  return {
    type: FETCHING_DATA_SUCCESS,
    data,
  }
}

export function getDataFailure() {
  return {
    type: FETCHING_DATA_FAILURE
  }
}

export function fetchData() {
  return (dispatch) => {
    dispatch(getData())
    getPeople()
      .then((data) => {
        dispatch(getDataSuccess(data))
      })
      .catch((err) => console.log('err:', err))
  }
}
view raw复制代码

此处 fetchData 函数是一个 thunk。当被调用时,fetchData 会返回一个函数;该函数首先会 dispatch getData action,而后调用 getPeople,在 getPeople 返回的 promise reslove 以后,会 dispatch getDataSuccess action。

接下来,须要更新 configureStore 函数以引入 thunk 中间件:

import { createStore, applyMiddleware } from 'redux'
import app from './reducers'
import thunk from 'redux-thunk'

export default function configureStore() {
  let store = createStore(app, applyMiddleware(thunk))
  return store
}复制代码
  1. redux 引入 applyMiddleware。
  2. redux-thunk 引入 thunk
  3. applyMiddleware 做为第二个参数传递给函数 createStore

最后,更新 app.js 文件来使用上述 thunk:

import React from 'react'
import { TouchableHighlight, View, Text, StyleSheet } from 'react-native'

import { connect } from 'react-redux'
import { fetchData } from './actions'

let styles

const App = (props) => {
  const {
    container,
    text,
    button,
    buttonText,
    mainContent
  } = styles

  return (
    <View style={container}> <Text style={text}>Redux Examples</Text> <TouchableHighlight style={button} onPress={() => props.fetchData()}> <Text style={buttonText}>Load Data</Text> </TouchableHighlight> <View style={mainContent}> { props.appData.isFetching && <Text>Loading</Text> } { props.appData.data.length ? ( props.appData.data.map((person, i) => { return <View key={i} > <Text>Name: {person.name}</Text> <Text>Age: {person.age}</Text> </View> }) ) : null } </View> </View>
  )
}

styles = StyleSheet.create({
  container: {
    marginTop: 100
  },
  text: {
    textAlign: 'center'
  },
  button: {
    height: 60,
    margin: 10,
    justifyContent: 'center',
    alignItems: 'center',
    backgroundColor: '#0b7eff'
  },
  buttonText: {
    color: 'white'
  },
  mainContent: {
    margin: 10,
  }
})

function mapStateToProps (state) {
  return {
    appData: state.appData
  }
}

function mapDispatchToProps (dispatch) {
  return {
    fetchData: () => dispatch(fetchData())
  }
}

export default connect(
  mapStateToProps,
  mapDispatchToProps
)(App)复制代码

此处代码主要有如下几个要点:

  1. 为 TouchableHighlight 组件绑定 onPress 函数,当按压事件触发后调用 props.fetchData()
  2. 检查 props.appData.isFetching 的值是否为 true, 若是是则返回正在加载的文字提示。
  3. 检查 props.appData.data.length,若是该值存在且不为 0,则遍历该数组,展现人员姓名和年龄信息。

至此,当按下按钮 Load Data 后,首先会看到正在加载的提示文字,3 秒后会看到人员信息。

Redux Saga

Redux Saga 组合使用 async await 和 Generators,使其函数接口简单易用。(branch

“经过使用 ES6 的新特性 Generators,涉及异步流程的代码变得易于阅读、编写和测试。(若是你对此特性还不熟悉的话,点击此处获取入门介绍)。基于此,Javascript 的异步代码看起来就和标准的同步代码同样(有点相似于 async/await,但 Generators 另外还有一些咱们所须要的极佳特性)。—— Redux Saga 文档

为了实现 Saga,首先须要更新 actions —— 删除 actions.js 文件中除了以下代码外的其它全部代码:

import { FETCHING_DATA } from './constants'

export function fetchData() {
  return {
    type: FETCHING_DATA
  }
}复制代码

该 action 会触发咱们即将建立的 saga。新建 saga.js 文件,写入以下代码:

import { FETCHING_DATA, FETCHING_DATA_SUCCESS, FETCHING_DATA_FAILURE } from './constants'
import { put, takeEvery } from 'redux-saga/effects'
import getPeople from './api'

function* fetchData (action) {
  try {
    const data = yield getPeople()
    yield put({ type: FETCHING_DATA_SUCCESS, data })
  } catch (e) {
    yield put({ type: FETCHING_DATA_FAILURE })
  }
}

function* dataSaga () {
  yield takeEvery(FETCHING_DATA, fetchData)
}

export default dataSaga复制代码
  1. 引入所需常量。
  2. redux-saga/effects 中引入 puttakeEvery。当调用 put 函数时,Reduc Sage 会指示中间件 dipatch 一个 action。takeEvery 函数则会监听被 dispatch 了的 action(本例中即为 FETCHING_DATA),而后调用回调函数(本例中即为 fetchData)。
  3. fetchData 被调用后,代码会等待函数 getPeople 的返回,若是返回成功则 dispatch FETCHING_DATA_SUCCCESS action。

最后更新 configureStore.js 文件,用 saga 替换 thunk。

import { createStore, applyMiddleware } from 'redux'
import app from './reducers'

import createSagaMiddleware from 'redux-saga'
import dataSaga from './saga'

const sagaMiddleware = createSagaMiddleware()

export default function configureStore() {
  const store = createStore(app, applyMiddleware(sagaMiddleware))
  sagaMiddleware.run(dataSaga)
  return store
}复制代码

在该文件中既引入了上述 saga,又从 redux-saga 中引入了 createSagaMiddleware。在建立 store 时,传入 sagaMiddleware,而后在返回 store 以前调用 sagaMiddleWare.run

至此,能够再次运行该程序并看到和使用 Redux Thunk 是一样的效果!

注意:从 thunk 迁移到 saga 只改变了 3 个文件: saga.jsconfigureStore.js 以及 actions.js

Redux Observable

Redux Observable 使用 RxJS 和 observables 来为 Redux 应用建立异步 action 和异步数据流。(branch

“基于 RxJS 5Redux 中间件。组合撤销异步 actions 以产生反作用等。” —— Redux Observable 文档

首先仍是须要更新 actions.js 文件:

import { FETCHING_DATA, FETCHING_DATA_SUCCESS, FETCHING_DATA_FAILURE } from './constants'

export function fetchData () {
  return {
    type: FETCHING_DATA
  }
}

export function getDataSuccess (data) {
  return {
    type: FETCHING_DATA_SUCCESS,
    data
  }
}

export function getDataFailure (error) {
  return {
    type: FETCHING_DATA_FAILURE,
    errorMessage: error
  }
}复制代码

如上所示,将以前的 actions 更新为最先的 3 个 actions。

接着建立所谓的 epic —— 输入 action stream 并输出 action stream 的函数。

新建 epic.js 文件并加入以下代码:

import { FETCHING_DATA } from './constants'
import { getDataSuccess, getDataFailure } from './actions'
import getPeople from './api'

import 'rxjs'
import { Observable } from 'rxjs/Observable'

const fetchUserEpic = action$ =>
  action$.ofType(FETCHING_DATA)
    .mergeMap(action =>
      Observable.fromPromise(getPeople())
        .map(response => getDataSuccess(response))
        .catch(error => Observable.of(getDataFailure(error)))
      )

export default fetchUserEpic复制代码

通常在 RxJS 中,变量名中的 $ 符号用以表示该变量是某 stream 的引用。

  1. 引入常量 FETCHING_DATA。
  2. 引入 getDataSuccessgetDataFailure 函数。
  3. 从 rxjs 中引入 rxjsObservable
  4. 定义函数 fetchUserEpic
  5. 等到 FETCHING_DATA action 经过该 stream 以后,调用 mergeMap 函数, 从 getPeople 中返回 Observable.fromPromise 并将返回值映射到 getDataSuccess 函数中。

最后,更新 configureStore,应用新中间件 —— epic。

configureStore.js 文件内容以下:

import { createStore, applyMiddleware } from 'redux'
import app from './reducers'

import { createEpicMiddleware } from 'redux-observable'
import fetchUserEpic from './epic'

const epicMiddleware = createEpicMiddleware(fetchUserEpic)

export default function configureStore () {
  const store = createStore(app, applyMiddleware(epicMiddleware))
  return store
}
view raw复制代码

至此,能够再次运行该程序并看到后以前同样的效果!

Redux Promise Middleware

Redux Promise Middleware 是一个用于 reslove 和 reject promise 的轻量级函数库。 (branch)

“Redux Promise Middleware 使得 Redux 中的异步代码更为健壮,并使 optimistic updates 、dispatches pending 、fulfilled 和 rejected actions 成为可能。 它也能够和 redux-thunk 结合使用链式化异步 action” —— Redux Promise Middleware 文档

正如你将要看到的同样,相比于上述几个函数库而言,Redux Promise Middleware 极大地减小了代码量。

它也能够和 Thunk 结合使用 以实现异步 action 的链式化。

相较于上述几个函数库,Redux Promise Middleware 有所不一样 —— 它会接管你的 action 并基于 promise 状态的不一样在 action 类型名称后添加 _PENDING_FULFILLED_REJECTED

例如,若是调用以下函数:

function fetchData() {
  return {
    type: FETCH_DATA,
    payload: getPeople()
  }
}复制代码

那么就会自动地 dispatch FETCH_DATA_PENDING action。

一旦 getPeople promise resolved,基于返回结果的不一样,会 dispatch FETCH_DATA_FULFILLEDFETCH_DATA_REJECTED action。

让咱们经过现有的例子来理解该特性:

首先须要更新 constants.js,以使其匹配咱们将要用到的常量:

export const FETCH_DATA = 'FETCH_DATA'
export const FETCH_DATA_PENDING = 'FETCH_DATA_PENDING'
export const FETCH_DATA_FULFILLED = 'FETCH_DATA_FULFILLED'
export const FETCH_DATA_REJECTED = 'FETCH_DATA_REJECTED'复制代码

接着将 actions.js 文件更新为只有一个 FETCH_DATA 这一个 action。

import { FETCH_DATA } from './constants'
import getPeople from './api'

export function fetchData() {
  return {
    type: FETCH_DATA,
    payload: getPeople()
  }
}复制代码

接着基于上面新定义的常量更新 dataReducer.js 文件:

import { FETCH_DATA_PENDING, FETCH_DATA_FULFILLED, FETCH_DATA_REJECTED } from '../constants'
const initialState = {
  data: [],
  dataFetched: false,
  isFetching: false,
  error: false
}

export default function dataReducer (state = initialState, action) {
  switch (action.type) {
    case FETCH_DATA_PENDING:
      return {
        ...state,
        data: [],
        isFetching: true
      }
    case FETCH_DATA_FULFILLED:
      return {
        ...state,
        isFetching: false,
        data: action.payload
      }
    case FETCH_DATA_REJECTED:
      return {
        ...state,
        isFetching: false,
        error: true
      }
    default:
      return state
   }
}复制代码

最后更新 configureStore,应用 Redux Promise Middleware:

import { createStore, applyMiddleware } from 'redux'
import app from './reducers'
import promiseMiddleware from 'redux-promise-middleware';

export default function configureStore() {
  let store = createStore(app, applyMiddleware(promiseMiddleware()))
  return store
}复制代码

至此,能够再次运行该程序并看到后以前同样的效果!

总结

总的来讲,笔者认为 Saga 更适用于较为复杂的应用,除此以外的其余全部状况 Redux Promise Middleware 都是十分合适的。笔者十分喜欢 Saga 中的 Generators 和 async-await,这些特性颇有趣; 同时笔者也喜欢 Redux Promise Middleware,由于它极大地减小了代码量。

若是对 RxJS 更为熟悉的话,笔者也许会偏向 Redux Observable;但仍是有不少笔者理解不透彻的地方,所以没法自信地将其应用于生产环境中。

笔者 Nader Dabit,是一名专一于 React 和 React Native 开发和培训的软件开发者。

若是你也喜欢 React Native,欢迎查看我和 Gant Laborde Kevin Old Ali NajafizadehPeter PiekarczykDevchat.tv 的 podcast — React Native Radio

同时,也欢迎查看笔者所著的 React Native in Action,该书目前能够在 Manning Publications 购买。

若是你喜欢这篇文章,欢迎推荐和分享!谢谢!

相关文章
相关标签/搜索