Redux源码(三) —— applyMiddleware.js

Source Time

function applyMiddleware(...middlewares) {
  return createStore => (...args) => {
    const store = createStore(...args)
    let dispatch = () => {
      throw new Error(
        `Dispatching while constructing your middleware is not allowed. ` +
          `Other middleware would not be applied to this dispatch.`
      )
    }

    const middlewareAPI = {
      getState: store.getState,
      dispatch: (...args) => dispatch(...args)
    }
    const chain = middlewares.map(middleware => middleware(middlewareAPI))
    dispatch = compose(...chain)(store.dispatch)

    return {
      ...store,
      dispatch
    }
  }
}
复制代码

为了便于理解，我将源码中的箭头函数全都改成具名函数(以fn加上数字标记)，以便于对照分析:

function applyMiddleware(...middlewares) {
  return function fn1(createStore) {
    return function fn2(...args) {
      const store = createStore(...args);
      let dispatch = function fun3() {
        throw new Error(
          `Dispatching while constructing your middleware is not allowed. ` +
            `Other middleware would not be applied to this dispatch.`
        );
      };
      const middlewareAPI = {
        getState: store.getState,
        dispatch: function fn4(...args) {
          dispatch(...args);
        },
      };
      const chain = middlewares.map(function fn5(middleware) {
        return middleware(middlewareAPI);
      });
      dispatch = compose(...chain)(store.dispatch);
      return {
        ...store,
        dispatch,
      };
    };
  };
}
复制代码

Analysis

在详细分析applyMiddleware源码以前，咱们须要知道的是，中间件middleware的功能是对redux提供的dispatch进行一些扩展，或者说是加强，好比说最多见的logger中间件，它的任务就是在dispatch的过程当中顺带着实现一下打印日志的任务，那么这样看来，其实applyMiddleware就像名字同样，其做用就是告诉redux怎么处理这些中间件，或者更具体的说，怎么把中间件运用在redux提供的dispatch上。

好了，下面开始逐条分析源码（这里便于定位，实际上是对照改写后的函数）

1. 建立applyMiddle函数

applyMiddleware函数接受一个中间件的散列，并用rest参数收集到middlewares这个数组中，最终会返回一个函数fn1。

2. fn1的做用描述

函数fn1只有两个做用，第一是接受惟一的参数createStore，没错就是redux提供的createStore方法；第二返回一个函数fn2。若是看过前一篇文章compose的应该能够看出，这里运用了柯里化的思想。

3. fn2的做用描述

函数fn2接受一个rest参数（结合createStore方法能够知道其实就是reducer和preloadState），同时在内部详细处理了如何将多个中间件和redux的dispatch有机结合，如下几点逐行描述。

3.1 建立store

利用最基本的createStore建立一个store备用；

const store = createStore(...args);
复制代码

3.2 建立dispatch

本地建立一个dispatch函数fn3，目前这个dispatch很是简单，就是抛出一个错误。

let dispatch = function fun3() {
  throw new Error(
    `Dispatching while constructing your middleware is not allowed. ` +
      `Other middleware would not be applied to this dispatch.`
  );
};
复制代码

3.3 建立中间件须要的入参

建立middlewareAPI，能够看到这个对象中只包含了两个属性：getState和dispatch。getState返回的是上面建立的store的getState方法，以便在中间件中可以获取到state；而dispatch则是一个新的函数fn4，它接受rest参数args，并在内部调用5中提到的本地建立的dispatch（即fn3），注意这里须要传入参数，哪怕定义dispatch的时候并无定义。

const middlewareAPI = {
  getState: store.getState,
  dispatch: function fn4(...args) {
    dispatch(...args);
  },
};
复制代码

3.4 重头戏——组合中间件为一个链

因为这部分嵌套比较多，因此决定引用一个logger中间件来参照：

// logger中间件
// 第一层
const logger = store => {
  // 第二层
  return next => {
    // 第三层
    return action => {
      console.group(action.type);
      console.info('dispatching', action);
      let result = next(action);
      console.log('next state', store.getState());
      console.groupEnd(action.type);
      return result;
    };
  };
}

// source code
const chain = middlewares.map(function fn5(middleware) {
  return middleware(middlewareAPI);
});
dispatch = compose(...chain)(store.dispatch);
复制代码

对applyMiddlewares中接受到的rest参数middlewares使用一个map遍历，处理函数fn5的工做是将middlewareAPI注入到中间件中，以logger为例，这里的middlewareAPI就是logger的入参store，同时返回第二层的函数（以next为入参），因此咱们知道，chain其实就是把全部的中间件都先行注入middlewareAPI后的以next为入参的函数组成的数组，或者能够说，chain中包含了一系列函数，这些函数都被统一注入了middlewareAPI，而且接受next做为入参。

顺带提一下，由middlewareAPI也能够看出，在编写中间件的时候，能拿到的store的api其实就只有两个——getState和dispatch，而且这里的dispatch仍是看上去没什么用的本地建立的西贝货dispatch，只能抛出错误。

接着就用到了上一篇提到的compose函数了，这里是接受chain数组展开的散列做为参数，返回一个由多个中间件嵌套的函数，这个函数接受store.dispatch做为入参，参考logger就是第二层中的next参数，这样咱们就获得了一个处理过的、包含了中间件加强功能的dispatch函数（此时已经将那个只会throw Error的dispatch替换掉了）。

若是看过compose就能够知道，入参的顺序决定执行的顺序，因此咱们通常将logger中间件尽量放在applyMiddleware的后面就能够理解了，为了第一步就执行logger。

4. 收尾

最终返回一个对象做为用户建立的store，和普通的由createStore建立的store不一样的地方在于，这里提供的dispatch是通过了处理的，从这一点上也能很明确看到以前提过的，中间件的做用就是对普通的dispatch进行了加强。

return {
  ...store, // 这个store由createStore在本函数中建立
  dispatch,
};
复制代码

All

• index
• compose
• applyMiddleware
• bindActionCreators
• combineReducers
• createStore