手写一个Redux,深入理解其原理
Redux可是一个大名鼎鼎的库,很多地方都在用,我也用了几年了,今天这篇文章就是自己来实现一个Redux,以便于深入理解他的原理。我们还是老套路,从基本的用法入手,然后自己实现一个Redux来替代源码的NPM包,但是功能保持不变。本文只会实现Redux的核心库,跟其他库的配合使用,比如ReactRedux准备后面单独写一篇文章来讲。有时候我们过于关注使用,只记住了各种使用方式,反而忽略了他们的核心原理,但是如果我们想真正的提高技术,最好还是一个一个搞清楚,比如Redux和ReactRedux看起来很像,但是他们的核心理念和关注点是不同的,Redux其实只是一个单纯状态管理库,没有任何界面相关的东西,ReactRedux关注的是怎么将Redux跟React结合起来,用到了一些React的API。基本概念
Redux的概念有很多文章都讲过,想必大家都看过很多了,我这里不再展开,只是简单提一下。Redux基本概念主要有以下几个:Store
人如其名,Store就是一个仓库,它存储了所有的状态(State),还提供了一些操作他的API,我们后续的操作其实都是在操作这个仓库。假如我们的仓库是用来放牛奶的,初始情况下,我们的仓库里面一箱牛奶都没有,那Store的状态(State)就是:{milk:0}Actions
一个Action就是一个动作,这个动作的目的是更改Store中的某个状态,Store还是上面的那个仓库,现在我想往仓库放一箱牛奶,那我想往仓库放一箱牛奶就是一个Action,代码就是这样:{type:PUTMILK,count:1}Reducers
前面我想往仓库放一箱牛奶只是想了,还没操作,具体操作要靠Reducer,Reducer就是根据接收的Action来改变Store中的状态,比如我接收了一个PUTMILK,同时数量count是1,那放进去的结果就是milk增加了1,从0变成了1,代码就是这样:constinitState{milk:0}functionreducer(stateinitState,action){switch(action。type){casePUTMILK:return{。。。state,milk:state。milkaction。count}default:returnstate}}
可以看到Redux本身就是一个单纯的状态机,Store存放了所有的状态,Action是一个改变状态的通知,Reducer接收到通知就更改Store中对应的状态。简单例子
下面我们来看一个简单的例子,包含了前面提到的Store,Action和Reducer这几个概念:import{createStore}fromredux;constinitState{milk:0};functionreducer(stateinitState,action){switch(action。type){casePUTMILK:return{。。。state,milk:state。milkaction。count};caseTAKEMILK:return{。。。state,milk:state。milkaction。count};default:returnstate;}}letstorecreateStore(reducer);subscribe其实就是订阅store的变化,一旦store发生了变化,传入的回调函数就会被调用如果是结合页面更新,更新的操作就是在这里执行store。subscribe(()console。log(store。getState()));将action发出去要用dispatchstore。dispatch({type:PUTMILK});milk:1store。dispatch({type:PUTMILK});milk:2store。dispatch({type:TAKEMILK});milk:1自己实现
前面我们那个例子虽然短小,但是已经包含了Redux的核心功能了,所以我们手写的第一个目标就是替换这个例子中的Redux。要替换这个Redux,我们得先知道他里面都有什么东西,仔细一看,我们好像只用到了他的一个API:
createStore:这个API接受reducer方法作为参数,返回一个store,主要功能都在这个store上。
看看store上我们都用到了啥:store。subscribe:订阅state的变化,当state变化的时候执行回调,可以有多个subscribe,里面的回调会依次执行。
store。dispatch:发出action的方法,每次dispatchaction都会执行reducer生成新的state,然后执行subscribe注册的回调。
store。getState:一个简单的方法,返回当前的state。
看到subscribe注册回调,dispatch触发回调,想到了什么,这不就是发布订阅模式吗?我之前有一篇文章详细讲过发布订阅模式了,这里直接仿写一个。functioncreateStore(){letstate;state记录所有状态letlisteners〔〕;保存所有注册的回调functionsubscribe(callback){listeners。push(callback);subscribe就是将回调保存下来}dispatch就是将所有的回调拿出来依次执行就行functiondispatch(){for(leti0;ilisteners。length;i){constlistenerlisteners〔i〕;listener();}}getState直接返回statefunctiongetState(){returnstate;}store包装一下前面的方法直接返回conststore{subscribe,dispatch,getState}returnstore;}
上述代码是不是很简单嘛,Redux核心也是一个发布订阅模式,就是这么简单!等等,好像漏了啥,reducer呢?reducer的作用是在发布事件的时候改变state,所以我们的dispatch在执行回调前应该先执行reducer,用reducer的返回值重新给state赋值,dispatch改写如下:functiondispatch(action){statereducer(state,action);for(leti0;ilisteners。length;i){constlistenerlisteners〔i〕;listener();}}
到这里,前面例子用到的所有API我们都自己实现了,我们用自己的Redux来替换下官方的Redux试试:import{createStore}fromredux;import{createStore}from。myRedux;
可以看到输出结果是一样的,说明我们自己写的Redux没有问题:
了解了Redux的核心原理,我们再去看他的源码应该就没有问题了,createStore的源码传送门。
最后我们再来梳理下Redux的核心流程,注意单纯的Redux只是个状态机,是没有View层的哦。
除了这个核心逻辑外,Redux里面还有些API也很有意思,我们也来手写下。手写combineReducers
combineReducers也是使用非常广泛的API,当我们应用越来越复杂,如果将所有逻辑都写在一个reducer里面,最终这个文件可能会有成千上万行,所以Redux提供了combineReducers,可以让我们为不同的模块写自己的reducer,最终将他们组合起来。比如我们最开始那个牛奶仓库,由于我们的业务发展很好,我们又增加了一个放大米的仓库,我们可以为这两个仓库创建自己的reducer,然后将他们组合起来,使用方法如下:import{createStore,combineReducers}fromredux;constinitMilkState{milk:0};functionmilkReducer(stateinitMilkState,action){switch(action。type){casePUTMILK:return{。。。state,milk:state。milkaction。count};caseTAKEMILK:return{。。。state,milk:state。milkaction。count};default:returnstate;}}constinitRiceState{rice:0};functionriceReducer(stateinitRiceState,action){switch(action。type){casePUTRICE:return{。。。state,rice:state。riceaction。count};caseTAKERICE:return{。。。state,rice:state。riceaction。count};default:returnstate;}}使用combineReducers组合两个reducerconstreducercombineReducers({milkState:milkReducer,riceState:riceReducer});letstorecreateStore(reducer);store。subscribe(()console。log(store。getState()));操作的actionstore。dispatch({type:PUTMILK,count:1});milk:1store。dispatch({type:PUTMILK,count:1});milk:2store。dispatch({type:TAKEMILK,count:1});milk:1操作大米的actionstore。dispatch({type:PUTRICE,count:1});rice:1store。dispatch({type:PUTRICE,count:1});rice:2store。dispatch({type:TAKERICE,count:1});rice:1
上面代码我们将大的state分成了两个小的milkState和riceState,最终运行结果如下:
知道了用法,我们尝试自己来写下呢!要手写combineReducers,我们先来分析下他干了啥,首先它的返回值是一个reducer,这个reducer同样会作为createStore的参数传进去,说明这个返回值是一个跟我们之前普通reducer结构一样的函数。这个函数同样接收state和action然后返回新的state,只是这个新的state要符合combineReducers参数的数据结构。我们尝试来写下:functioncombineReducers(reducerMap){constreducerKeysObject。keys(reducerMap);先把参数里面所有的键值拿出来返回值是一个普通结构的reducer函数constreducer(state{},action){constnewState{};for(leti0;ireducerKeys。length;i){reducerMap里面每个键的值都是一个reducer,我们把它拿出来运行下就可以得到对应键新的state值然后将所有reducer返回的state按照参数里面的key组装好最后再返回组装好的newState就行constkeyreducerKeys〔i〕;constcurrentReducerreducerMap〔key〕;constprevStatestate〔key〕;newState〔key〕currentReducer(prevState,action);}returnnewState;};returnreducer;}
官方源码的实现原理跟我们的一样,只是他有更多的错误处理,大家可以对照着看下。手写applyMiddleware
middleware是Redux里面很重要的一个概念,Redux的生态主要靠这个API接入,比如我们想写一个logger的中间件可以这样写(这个中间件来自于官方文档):logger是一个中间件,注意返回值嵌了好几层函数我们后面来看看为什么这么设计functionlogger(store){returnfunction(next){returnfunction(action){console。group(action。type);console。info(dispatching,action);letresultnext(action);console。log(nextstate,store。getState());console。groupEnd();returnresult}}}在createStore的时候将applyMiddleware作为第二个参数传进去conststorecreateStore(reducer,applyMiddleware(logger))
可以看到上述代码为了支持中间件,createStore支持了第二个参数,这个参数官方称为enhancer,顾名思义他是一个增强器,用来增强store的能力的。官方对于enhancer的定义如下:typeStoreEnhancer(next:StoreCreator)StoreCreator
上面的结构的意思是说enhancer作为一个函数,他接收StoreCreator函数作为参数,同时返回的也必须是一个StoreCreator函数。注意他的返回值也是一个StoreCreator函数,也就是我们把他的返回值拿出来继续执行应该得到跟之前的createStore一样的返回结构,也就是说我们之前的createStore返回啥结构,他也必须返回结构,也就是这个store:{subscribe,dispatch,getState}createStore支持enhancer
根据他关于enhancer的定义,我们来改写下自己的createStore,让他支持enhancer:functioncreateStore(reducer,enhancer){接收第二个参数enhancer先处理enhancer如果enhancer存在并且是函数我们将createStore作为参数传给他他应该返回一个新的createStore给我我再拿这个新的createStore执行,应该得到一个store直接返回这个store就行if(enhancertypeofenhancerfunction){constnewCreateStoreenhancer(createStore);constnewStorenewCreateStore(reducer);returnnewStore;}如果没有enhancer或者enhancer不是函数,直接执行之前的逻辑下面这些代码都是之前那版省略n行代码。。。。。。。conststore{subscribe,dispatch,getState}returnstore;}
这部分对应的源码看这里。applyMiddleware返回值是一个enhancer
前面我们已经有了enhancer的基本结构,applyMiddleware是作为第二个参数传给createStore的,也就是说他是一个enhancer,准确的说是applyMiddleware的返回值是一个enhancer,因为我们传给createStore的是他的执行结果applyMiddleware():functionapplyMiddleware(middleware){applyMiddleware的返回值应该是一个enhancer按照我们前面说的enhancer的参数是createStorefunctionenhancer(createStore){enhancer应该返回一个新的createStorefunctionnewCreateStore(reducer){我们先写个空的newCreateStore,直接返回createStore的结果conststorecreateStore(reducer);returnstore}returnnewCreateStore;}returnenhancer;}实现applyMiddleware
上面我们已经有了applyMiddleware的基本结构了,但是功能还没实现,要实现他的功能,我们必须先搞清楚一个中间件到底有什么功能,还是以前面的logger中间件为例:functionlogger(store){returnfunction(next){returnfunction(action){console。group(action。type);console。info(dispatching,action);letresultnext(action);console。log(nextstate,store。getState());console。groupEnd();returnresult}}}
这个中间件运行效果如下:
可以看到我们letresultnext(action);这行执行之后state改变了,前面我们说了要改变state只能dispatch(action),所以这里的next(action)就是dispatch(action),只是换了一个名字而已。而且注意最后一层返回值returnfunction(action)的结构,他的参数是action,是不是很像dispatch(action),其实他就是一个新的dispatch(action),这个新的dispatch(action)会调用原始的dispatch,并且在调用的前后加上自己的逻辑。所以到这里一个中间件的结构也清楚了:
一个中间件接收store作为参数,会返回一个函数返回的这个函数接收老的dispatch函数作为参数,会返回一个新的函数返回的新函数就是新的dispatch函数,这个函数里面可以拿到外面两层传进来的store和老dispatch函数
所以说白了,中间件就是加强dispatch的功能,用新的dispatch替换老的dispatch,这不就是个装饰者模式吗?其实前面enhancer也是一个装饰者模式,传入一个createStore,在createStore执行前后加上些代码,最后又返回一个增强版的createStore。可见设计模式在这些优秀的框架中还真是广泛存在,如果你对装饰者模式还不太熟悉,可以看我之前这篇文章。
遵循这个思路,我们的applyMiddleware就可以写出来了:直接把前面的结构拿过来functionapplyMiddleware(middleware){functionenhancer(createStore){functionnewCreateStore(reducer){conststorecreateStore(reducer);将middleware拿过来执行下,传入store得到第一层函数constfuncmiddleware(store);解构出原始的dispatchconst{dispatch}store;将原始的dispatch函数传给func执行得到增强版的dispatchconstnewDispatchfunc(dispatch);返回的时候用增强版的newDispatch替换原始的dispatchreturn{。。。store,dispatch:newDispatch}}returnnewCreateStore;}returnenhancer;}
照例用我们自己的applyMiddleware替换老的,跑起来是一样的效果,说明我们写的没问题,哈哈
支持多个middleware
我们的applyMiddleware还差一个功能,就是支持多个middleware,比如像这样:applyMiddleware(rafScheduler,timeoutScheduler,thunk,vanillaPromise,readyStatePromise,logger,crashReporter)
其实要支持这个也简单,我们返回的newDispatch里面依次的将传入的middleware拿出来执行就行,多个函数的串行执行可以使用辅助函数compose,这个函数定义如下。只是需要注意的是我们这里的compose不能把方法拿来执行就完了,应该返回一个包裹了所有方法的方法。functioncompose(。。。func){returnfuncs。reduce((a,b)(。。。args)a(b(。。。args)));}
这个compose可能比较让人困惑,我这里还是讲解下,比如我们有三个函数,这三个函数都是我们前面接收dispatch返回新dispatch的方法:constfun1dispatchnewDispatch1;constfun2dispatchnewDispatch2;constfun3dispatchnewDispatch3;
当我们使用了compose(fun1,fun2,fun3)后执行顺序是什么样的呢?第一次其实执行的是(func1,func2)(。。。args)func1(fun2(。。。args))这次执行完的返回值是下面这个,用个变量存起来吧consttemp(。。。args)func1(fun2(。。。args))我们下次再循环的时候其实执行的是(temp,func3)(。。。args)temp(func3(。。。args));这个返回值是下面这个,也就是最终的返回值,其实就是从func3开始从右往左执行完了所有函数前面的返回值会作为后面参数(。。。args)temp(func3(。。。args));再看看上面这个方法,如果把dispatch作为参数传进去会是什么效果(dispatch)temp(func3(dispatch));然后func3(dispatch)返回的是newDispatch3,这个又传给了temp(newDispatch3),也就是下面这个会执行(newDispatch3)func1(fun2(newDispatch3))上面这个里面用newDispatch3执行fun2(newDispatch3)会得到newDispatch2然后func1(newDispatch2)会得到newDispatch1注意这时候的newDispatch1其实已经包含了newDispatch3和newDispatch2的逻辑了,将它拿出来执行这三个方法就都执行了
更多关于compose原理的细节可以看我之前这篇文章。
所以我们支持多个middleware的代码就是这样:参数支持多个中间件functionapplyMiddleware(。。。middlewares){functionenhancer(createStore){functionnewCreateStore(reducer){conststorecreateStore(reducer);多个middleware,先解构出dispatchnewDispatch的结构constchainmiddlewares。map(middlewaremiddleware(store));const{dispatch}store;用compose得到一个组合了所有newDispatch的函数constnewDispatchGencompose(。。。chain);执行这个函数得到newDispatchconstnewDispatchnewDispatchGen(dispatch);return{。。。store,dispatch:newDispatch}}returnnewCreateStore;}returnenhancer;}
最后我们再加一个logger2中间件实现效果:functionlogger2(store){returnfunction(next){returnfunction(action){letresultnext(action);console。log(logger2);returnresult}}}letstorecreateStore(reducer,applyMiddleware(logger,logger2));
可以看到logger2也已经打印出来了,大功告成。
现在我们也可以知道他的中间件为什么要包裹几层函数了:第一层:目的是传入store参数
第二层:第二层的结构是dispatchnewDispatch,多个中间件的这层函数可以compose起来,形成一个大的dispatchnewDispatch
第三层:这层就是最终的返回值了,其实就是newDispatch,是增强过的dispatch,是中间件的真正逻辑所在。总结单纯的Redux只是一个状态机,store里面存了所有的状态state,要改变里面的状态state,只能dispatchaction。对于发出来的action需要用reducer来处理,reducer会计算新的state来替代老的state。subscribe方法可以注册回调方法,当dispatchaction的时候会执行里面的回调。Redux其实就是一个发布订阅模式!Redux还支持enhancer,enhancer其实就是一个装饰者模式,传入当前的createStore,返回一个增强的createStore。Redux使用applyMiddleware支持中间件,applyMiddleware的返回值其实就是一个enhancer。Redux的中间件也是一个装饰者模式,传入当前的dispatch,返回一个增强了的dispatch。单纯的Redux是没有View层的,所以他可以跟各种UI库结合使用,比如reactredux,计划下一篇文章就是手写reactredux。