深度剖析Github上15.1k Star项目:Redux-Thunk

时间:2021-11-01 03:03:48

深度剖析Github上15.1k Star项目:Redux-Thunk

日益忙碌的一周又过去了,是时候开始每周一次的总结复盘了,今天笔者就来剖析一下github中star数15.1k的开源项目redux-thunk。

作为一名React方向的前端工程师,不管是被面试还是面试别人,大部分都会说起redux-thunk的实现原理,因为它非常经典且有用,而且代码量少的感人,只有短短12行代码,却能解决React开发中同一个函数支持多dispatch和异步action的问题(虽然这完全依赖于redux的中间件机制(Middleware))。

接下来笔者将从:

  • Redux的工作机制
  • 中间件实现原理
  • redux-thunk源码实现

这三个方面来带大家彻底掌握redux-thunk源码,从而对redux有更深入的了解和应用。如果大家对react-redux-redux-thunk实战感兴趣的,读完之后可以移步笔者的《彻底掌握redux》之开发一个任务管理平台

正文

在解读Redux-thunk源码之前我们需要先掌握redux的基本工作机制和中间件实现原理,这样才能更好的理解源码背后的奥义。长话短说我们先来看看redux的几个核心api及其作用:

深度剖析Github上15.1k Star项目:Redux-Thunk

redux解决的真正问题是React组件间的状态共享和状态管理问题,通过以上的6个核心api我们便能管理复杂的状态,并能监听和追溯状态的改动。机制笔者总结如下:

深度剖析Github上15.1k Star项目:Redux-Thunk

redux工作机理基本了解之后,我们先看看一个实际的例子:

  1. import actionType from './actionType' 
  2.  
  3. class Actions { 
  4.     static start() { 
  5.         return { 
  6.             type: actionType.CREATE_TODO_DOING 
  7.         } 
  8.     } 
  9.  
  10.     static ok(data, cb) { 
  11.         cb && 'function' === typeof cb && cb(data); 
  12.         return { 
  13.             type: actionType.CREATE_TODO_SUCCESS, 
  14.             payload: data 
  15.         } 
  16.     } 
  17.  
  18.     static fail(data, cb) { 
  19.         cb && 'function' === typeof cb && cb(data); 
  20.         return { 
  21.             type: actionType.CREATE_TODO_FAILURE, 
  22.             payload: data 
  23.         } 
  24.     } 

以上代码我们可以发现我们用了一个统一的createAction来创建action,在调用时只需要执行Actions.start()即可,我们也知道action返回的是一个标准的对象,但我们可以在return之前做一些side effect。这里我们并不能在action中处理异步逻辑,这也是redux-thunk的价值之一,即解决异步调用action。

到这一步我们仍然不能直接进入redux-thunk的源码分析,因为我们还是不清楚如何解决上述步骤,因为我们还没有了解redux的中间件机制。

redux中间件机制

说到中间件(middleware),使用过nodejs的人可能会很熟悉,比如说知名的koa中间件,express中间件等,其实中间件笔者的理解是在某个执行流中的某个环节做一些额外的处理的模块。实现中间件的机制也很简单, 就是在框架核心执行流中去遍历外部传入的中间件,并依次执行即可,我们先来看看redux中如何使用中间件的:

  1. import { createStore, applyMiddleware } from 'redux'
  2. import reducers from './reducers'
  3.  
  4. const middlewares = applyMiddleware(middleware1, middleware2); 
  5. const store = createStore(reducers, middlewares); 

所以说redux-thunk是被传入applyMiddleware方法中作为参数使用的,不难猜到applyMiddleware方法中一定有遍历执行参数的逻辑,我们来看看applyMiddleware的核心源码:

  1. export default function applyMiddleware(...middlewares) { 
  2.     return function enhancer(createStore) { 
  3.       return function enhancedCreateStore(...args) { 
  4.         const store = createStore(...args) 
  5.         let dispatch = () => { 
  6.           thrownewError('此处省略n个字...'
  7.         } 
  8.  
  9.         const middlewareAPI = { 
  10.           getState: store.getState, 
  11.           dispatch: (...args) => dispatch(...args) 
  12.         } 
  13.  
  14.         const chain = middlewares.map(function(middleware) { 
  15.           return middleware(middlewareAPI) 
  16.         }) 
  17.  
  18.         dispatch = compose(...chain)(store.dispatch) 
  19.         return { 
  20.           ...store, 
  21.           dispatch, 
  22.         } 
  23.      } 
  24.   } 

由上面的源码可知,在chain这段代码里我们发现其存储的是applyMiddleware方法参数传入getState,dispatch后的调用结果。接下来在dispatch这段代码中出现了compose函数, 熟悉函数式编程的朋友不难猜到其内部肯定是实现批处理chain的函数,并将store.dispatch泵送至其内部。上面源码分析后我们知道每一次执行dispatch时,都会先经过middleware的“洗礼”。

我们再来看看compose函数的内部实现:

  1. export default function compose(...funcs) { 
  2.   if (funcs.length === 0) { 
  3.     return arg => arg 
  4.   } 
  5.    
  6.   if (funcs.length === 1) { 
  7.     return funcs[0] 
  8.   } 
  9.    
  10.   return funcs.reduce(function(a, b) { 
  11.     return function (...args) { 
  12.       return a(b(...args)) 
  13.     } 
  14.   }) 

由上面代码可以看出compose最终返回的是一个函数,如果参数大于一时,我们采用reduce将上一个函数返回的结果传给下一个函数参数,以此来实现之间的参数共享和传递,非常经典的设计。

在掌握了redux中间件实现原理之后, 我们再来看redux-thunk源码就非常容易理解了。

redux-thunk源码分析

我们先看看这个github中star数15.1k的源码长啥子:

  1. function createThunkMiddleware(extraArgument) { 
  2.   return ({ dispatch, getState }) => (next) => (action) => { 
  3.     if (typeof action === 'function') { 
  4.       return action(dispatch, getState, extraArgument); 
  5.     } 
  6.  
  7.     return next(action); 
  8.   }; 
  9.  
  10. const thunk = createThunkMiddleware(); 
  11. thunk.withExtraArgument = createThunkMiddleware; 
  12.  
  13. export default thunk; 

没错, 这就是redux-thunk的全部源码了,是不是很nice~。在上面的介绍中我们了解到redux中间件机制使得我们可以在中间件中拿到必备的dispatch, getState,并且在执行之前已经调用了两层middleware,此时我们可以解剖一下createThunkMiddleware,在第一次调用createThunkMiddleware是在chain阶段,即上面源码分析的:

深度剖析Github上15.1k Star项目:Redux-Thunk

所以这里的next也就是第二次调用时的store.dispatch, 为了实现同一函数内能执行多次dispatch,我们会判断如果action为函数,则执行action本身并把必要参数传递给它,否则则直接触发dispatch,这样我们就实现了支持action为函数并且支持异步多dispatch的功能了,读到这还是非常感叹其设计的优雅和简洁,不经让笔者感叹:学好函数式,走遍天下都不怕!

最后笔者准备了一个基于React+redux+redux-thunk的实战项目,github地址:

https://github.com/MrXujiang/redux_OA

感兴趣的可以学习参考一下。

最后

如果想学习更多H5游戏, webpack,node,gulp,css3,javascript,nodeJS,canvas数据可视化等前端知识和实战,欢迎在公号《趣谈前端》加入我们的技术群一起学习讨论,共同探索前端的边界。

原文链接:https://mp.weixin.qq.com/s/WL7kORMWx1ZbwizohuXPKQ