vuex源码分析(三)——Module和ModuleCollection

本文参考珠峰架构公开课之vuex实现原理

在使用vuex过程中,如果数据量很大可以用vuexmodules实现模块化。modules实现过程个人认为可以分为数据注册和模块的安装,本篇主要将的是数据注册。

什么是数据注册?

数据注册是将用户传入的options做了一次数据的格式化,转换成模块树状结构,实现父子模块的整合。比如用户传入的options如下:

export default new Vuex.Store({
  state: { state_country: "中国" },
  getters: {},
  mutations: {},
  actions: {},
  modules: {
    city: {
      state: { state_city: "上海" },
      getters: {},
      mutations: {},
      actions: {}
    }
  }
});

转换好的数据结构如下:

{
  root: {
    _rawModule: {
      state: { state_country: "中国" },
      getters: {},
      mutations: {},
      actions: {},
      modules: {
        city: {
          state: { state_city: "上海" },
          getters: {},
          mutations: {},
          actions: {}
        }
      }
    },
    _children: {
      city: {
        _rawModule: {
          state: { state_city: "上海" },
          getters: {},
          mutations: {},
          actions: {}
        },
        _children: {},
        state: { state_city: "上海" }
      }
    },
    state: { state_country: "中国" }
  }
}

可以发现,options传入的数据被处理成了一个新的数据结构。源码中每个模块的生成通过一个module类来转换。

Module

module的代码如下:

class Module {
  constructor(rawModule) {
    this._children = Object.create(null);
    this._rawModule = rawModule;
    this.state = rawModule.state;
  }
}

vue全家桶的源码中,如果命名的变量名是raw开头的话代表是未经过加工的数据。

传入options单个模块的未经过加工的数据,返回一个包含_rawModule_childrenstate三个属性的数据结构:

  • _children:用于存放子模块。
  • _rawModule:存储自己模块的伪(未被加工)模块时的内容。
  • state:存储自己模块的数据内容。

Module类是对单个模块的处理,而vuex中支持多模块,如果当前模块有子模块的话需要放到_children中,这时候需要通过ModuleCollection类来处理。

ModuleCollection

先来看下源码:

class ModuleCollection {
  constructor(options) {
    this.register([], options);
  }
  register(path, rawModule) {
    let newModule = new Module(rawModule);
    if (!this.root) {
      this.root = newModule;
    } else {
      let parentModule = path.slice(0, -1).reduce((root, moduleName) => {
        return root._children[moduleName];
      }, this.root);
      parentModule._children[path[path.length - 1]] = newModule;
    }
    //如果子元素还有modules,需要递归注册
    if (rawModule.modules) {
      Object.keys(rawModule.modules).forEach(res => {
        this.register(path.concat(res), rawModule.modules[res]);
      });
    }
  }
}

ModuleCollection核心的功能是register函数,将所有的子模块整合成树状结构。

register做了什么?

  1. 将传入的options通过Module类生成新的模块。
  2. 将生成的新模块添加到它的父元素上。
  3. 如果当前的模块有子元素,重新执行register,也就是重复第1,2步骤。

register函数的pathrawModule两个参数的作用?

  1. rawModule:表示当前未加工的模块。
  2. path:表示当前模块和所有父级模块的模块名的集合。在递归过程中,如果有子模块的话会将当前模块的模块名合并子模块的模块名做为下一个register函数中的path参数。举个例子:如果根模块有子模块citycity子模块又有district子模块,因为有三级,按层级划分就是根模块,city模块和district模块,那这个path在注册每个模块时处理结果如下:
    第一次对根模块执行registerpath[]
    第二次对city模块执行registerpath[ 'city' ]
    第三次对district模块执行registerpath[ 'city' , 'district' ]

为何要判断是否是this.root
通过实例化ModuleCollection返回的数据结构,它的根模块数据是包在root对象里的。因为根模块调用register,也就是第一次调用register函数的时候是没有this.root的,类里面没有这个属性,所以一定返回false,于是就将当前模块赋值给this.root,因为this.root已被赋值,所以不会再进入这个判断。

除了以上问题,还有个比较难理解的是下面这段代码:

let parentModule = path.slice(0, -1).reduce((root, moduleName) => {
  return root._children[moduleName];
}, this.root);
parentModule._children[path[path.length - 1]] = newModule;

path.slice(0, -1)表示父级路径的集合,然后通过reduce获取当前模块的上级模块,并将当前模块添加到上级模块的_children里。

文章的最后

讲完了数据注册,接下来还有模块的安装,模块的安装最主要的功能就是将注册完的数据里每个模块的stategettersmutationaction递归安装到Store类上,从而用户可以在组件中可以通过this.$store.xxx来操作数据。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,294评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,780评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,001评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,593评论 1 289
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,687评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,679评论 1 294
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,667评论 3 415
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,426评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,872评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,180评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,346评论 1 345
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,019评论 5 340
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,658评论 3 323
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,268评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,495评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,275评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,207评论 2 352

推荐阅读更多精彩内容