故事的开始,是有一天一个带哥问了我redux的applyMiddleware做了什么…
这篇文章,会先从applyMiddleware
的源码开始分析,只讨论核心代码实现。一些琐碎的部分会被略去,最终延伸到redux
异步流处理方案。
准备道具
本着认真负责的态度,我希望阅读这篇文章的人都能有所收获(带哥可以略过)。因此,会先从一些比较基础的东西开始。
闭包
啥是闭包,简单点来讲就是你在一个函数里返回了一个函数,在返回的这个函数内,你具有访问包裹它的函数作用域内的变量的能力。
一般来说在我们声明的函数体内声明变量,只会在函数被调用时在当前函数块的作用域内存在。当函数执行完毕后会垃圾回收。但!如果我们返回的函数中存在对那个变量的引用,那这个变量便不会在函数调用后被销毁。也基于这一特性,延展出很多闭包的应用,如常见的防抖(throttle)、节流(debounce)函数,它们都是不断对内部的一个定时器进行操作;又如一些递归的缓存结果优化,也是设置了一个内部对象去比对结果来跳过一些冗余的递归场景。
1 | function throttle(fn, wait) { |
HOC(高阶函数or组件)与Compose(组合)
啥是高阶函数,其实跟上面的闭包的操作手段有点像,最终都会再返回一个函数。只不过它会根据你实际需求场景进行一些附加的操作来“增强”传入的原始函数的功能。像React
中的一些HOC(高阶组件)的应用其实也是同理,毕竟class
也不过是function
的语法糖。网上的应用场景也很多,这里不赘述了。主要再提一嘴的是compose
函数,它能让我们在进行多层高阶函数嵌套时,书写代码更为清晰。如我们有高阶函数A、B、C ,要实现A(B(C(…args)))的效果,如果没有compose
,就需要不断地将返回结果赋值,调用。而使用compose
,只需要一次赋值let HOC = compose(A, B, C);
,然后调用HOC(...args)
即可。
瞅瞅compose
源码,比较简单,无传参时,返回一个按传入返回的函数;一个入参时,直接返回第一个入参函数;多个则用数组的reduce
方法进行迭代,最终返回组合后的结果:
1 | function compose(...funcs) { |
isPlainObject
这个工具方法比较简单,就是来判断入参是否是由Object
直接构造的且中间没有修改继承关系:
1 | let isObjectLike = obj => { |
庖丁解牛
在聊applyMiddleware
前,我们有必要先分析一波createStore
内做了什么操作,因为他们俩其实是一个相互成就依赖注入的关系。
createStore
1 | function createStore(reducer, preloadedState, enhancer) { |
从源码中的声明可以看到,createStore
接收三个参数,第一个是reducer
,这个在项目中通常我们会用combineReducers
组合成一个大的reducer
传入。
combineReducers
这个combineReducers
使用频率还是很高的,我们先简要看看:
1 | function combineReducers(reducers) { |
首先combineReducers
接收一个对象,里面的key
是每一个小reducer
文件或函数导出的namespace
,value
则是与其对应的reducer
函数实体。然后它会将这些不同的reducer
函数合并到一个reducer
函数中。它会调用每一个合并的子reducer
,并且会将他们的结果放入一个state
中,最后返回一个闭包使我们可以像操作之前的子reducer
一样操作这个大reducer
。
preloadedState
就是我们传入的初始state
,当然源码中的注释里描述还可以向服务端渲染中的应用注入该值or恢复历史用户的session记录,不过没实践过,就不延展了…
最后的入参enhancer
比较关键,字面理解就是用来增强功能的,先看看部分源码:
1 | if (typeof preloadedState === 'function' && typeof enhancer === 'undefined') { |
在这里我们发现其实createStore
可以只接收2个参数,当第二个参数为函数时,会自动初始化state
为undefined
,所以看到一些createStore
只传了2个参数不要觉得奇怪。
applyMiddleware
然后往下看对enhancer
函数的调用,这写法一看就是个高阶函数,接收一个方法createStore
,然后返回一个函数。现在我们可以把applyMiddleware
抬上来了,这个API也是redux
本身唯一提供的用于store enhancer
的。
1 | function applyMiddleware(...middlewares) { |
redux-thunk
我们注意到applyMiddleware
作为enhancer
又把createStore
这个函数作为参数传入并在内部返回函数中调用了,这其实也是依赖注入的理念。然后我们发现内部其实将applyMiddleware
的入参传入的中间件都执行了一次,传参为getState
和dispatch
。这里可能初见者比较懵逼,我们先把早期处理异步action
的中间件redux-thunk
的源码翻出来看一眼:
1 | function createThunkMiddleware(extraArgument) { |
通过代码,我们可以得知一般middleWare
的内部构造都遵从一个({ getState, dispatch }) => next => action => {...}
的范式,并且导出的时候已经被调用了一次,即返回了一个需要接收getState
和dispatch
的函数。
Get到这一点以后,我们再往后看。通过compose
将中间件高阶组合并“增强”传入原store.dispatch
的功能,最后再在返回值内解构覆盖原始store
的dispatch
。
所以这个时候,如果我再问applyMiddleware
做了什么?应该大家都知道答案了吧,就是增强了原始createStore
返回的dispatch
的功能。
那再回到那个如何处理redux
中的异步数据流问题?其实核心解决方案就是引入中间件,而中间件最终达成的目的就是增强我们的原始dispatch
方法。还是以上面的redux-thunk
的middleware
来说,它传入的dispatch
就是它内部的next
,换言之,调用时,如果action
是个普通对象,那就跟往常dispatch
没啥差别,正常走reducer
更新状态;但如果是个函数,那我们就要让action
自己玩了自己去处理内部的异步逻辑了,比如什么网络请求,当Promiseresolved
了dispatch
一个成功action
,rejected
了dispatch
一个失败action
。
redux-devtools-extension
在开发环境中,为了追溯以及定位一些数据流向,我们会引入redux-devtools-extension
,这个模块有2种使用方式,一种是沉浸式,即在开发环境安装对应依赖,然后通过2次增强我们的applyMiddleWare
返回一个传入createStore
中的enhancer
,比如下面这样的:
1 | import { composeWithDevTools } from 'redux-devtools-extension'; |
又或者是插件扩展式的:
1 | const composeEnhancers = typeof window === 'object' && typeof window.__REDUX_DEVTOOLS_EXTENSION_COMPOSE__ !== 'undefined' ? |
更细节定制见官方。
收工漫谈
现在处理异步逻辑的中间件已经不少了,但是原理都是差不多的,只不过说从以前的传function
,到Promise
、Generator
控制之类的;像前文例子的redux-thunk
是比较早的异步中间件了,之后社区中有了更多的方案提供:如redux-promise
、redux-saga
、dvajs
、redux-observable
等等。我们还是需要根据实际团队和业务场景使用最适合我们的方案来组织代码编写。
简单回忆
1. store
本身的dispatch
派发action
更新数据这个动作是同步的;
2. 所谓异步action
,是通过引入中间件的方案增强dispatch
后实现的。具体是applyMiddleware
返回dispatch
覆盖原始store
的dispatch
;
3. 为何会采取这种中间件增强的模式,我个人看来一是集中在一个位置方便统一控制处理,另一个则是减少代码中的冗余判断模板;
课后思考
认真阅读文章的朋友,可能会有一个思考。
在redux-thunk
、redux-saga
这些中间件的编写范式中next
和我们的dispatch
到底有什么关系?
前文中,我们仅使用了redux-thunk
来进行applyMiddleware
能力的阐释,不过既然是中间件,我们大可以再添加一个比较常见的工具中间件redux-logger
来进行结合说明。
可以看到logger
实例的构造函数内,刨除对console
是否存在的判断及是否作为applyMiddleware
唯一参数的判断外,范式也是遵从middlewareAPI
定义的。
那么我们看一个常见应用场景,对我们每一个dispatch
动作进行日志打印:
1 | const store = createStore( |
redux-logger
的使用必须放在中间件的最后一个,原因也很简单,它应该是包裹增强dispatch
最近的一层,即发生调用时,输出日志,这就是它的功效。而根据源码中compose
组合的高阶函数,compose(A,B)(...args) => A(B(...args))
,也确实反应了这一点。
那么我们回归主线,实际上第一层的redux-logger
它返回的就是一个action => { 定制打印能力...; return next(action) }
的箭头函数, 而这第一层的next
实际上就是store.dispatch
。综合来看,第一层中间件(我们这里是logger),就是在执行dispatch
基础职能之上再额外定制了一些打印的能力,然后将这个增强的高阶函数HOC1(1层强化版dispatch),交给下一个中间件的next
使用。最终走完整条中间件链。