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

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 205,033评论 6赞 478
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 87,725评论 2赞 381
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 151,473评论 0赞 338
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 54,846评论 1赞 277
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 63,848评论 5赞 368
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 48,691评论 1赞 282
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 38,053评论 3赞 399
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 36,700评论 0赞 258
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 42,856评论 1赞 300
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,676评论 2赞 323
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,787评论 1赞 333
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 33,430评论 4赞 321
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 39,034评论 3赞 307
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,990评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,218评论 1赞 260
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 45,174评论 2赞 352
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 42,526评论 2赞 343