qiankun源码分析-2.初始化全局数据

初始化全局数据

qiankun提供了initGlobalState方法来初始化全局数据,该方法接受一个对象作为参数,该函数返回两个函数onGlobalStateChangesetGlobalState,分别用于监听和修改全局数据。

ts 复制代码
let globalState: Record<string, any> = {}
export function initGlobalState(state: Record<string, any> = {}) {
 //...
  if (state === globalState) {
    console.warn('[qiankun] state has not changed!');
  } else {
    const prevGlobalState = cloneDeep(globalState);
    globalState = cloneDeep(state);
    emitGlobal(globalState, prevGlobalState);
  }
  return getMicroAppStateActions(`global-${+new Date()}`, true);
}

这个函数做了两件事:

  1. 保存全局数据,emitGlobal函数我们暂时不分析,随后会分析,可以先忽略
  2. 返回getMicroAppStateActions的调用结果,getMicroAppStateActions返回onGlobalStateChangesetGlobalState两个函数,我们看下getMicroAppStateActions的源码:
ts 复制代码
const deps: Record<string, OnGlobalStateChangeCallback> = {};
export function getMicroAppStateActions(id: string, isMaster?: boolean): MicroAppStateActions {
  return {
    /**
     * onGlobalStateChange 全局依赖监听
     */
    onGlobalStateChange(callback: OnGlobalStateChangeCallback, fireImmediately?: boolean) {
      deps[id] = callback;
      if (fireImmediately) {
        const cloneState = cloneDeep(globalState);
        callback(cloneState, cloneState);
      }
    },

    /**
     * setGlobalState 更新 store 数据
     *
     * 1. 对输入 state 的第一层属性做校验,只有初始化时声明过的第一层(bucket)属性才会被更改
     * 2. 修改 store 并触发全局监听
     *
     * @param state
     */
    setGlobalState(state: Record<string, any> = {}) {
      if (state === globalState) {
        console.warn('[qiankun] state has not changed!');
        return false;
      }

      const changeKeys: string[] = [];
      const prevGlobalState = cloneDeep(globalState);
      globalState = cloneDeep(
        Object.keys(state).reduce((_globalState, changeKey) => {
          if (isMaster || _globalState.hasOwnProperty(changeKey)) {
            changeKeys.push(changeKey);
            return Object.assign(_globalState, { [changeKey]: state[changeKey] });
          }
          console.warn(`[qiankun] '${changeKey}' not declared when init state!`);
          return _globalState;
        }, globalState),
      );
      if (changeKeys.length === 0) {
        console.warn('[qiankun] state has not changed!');
        return false;
      }
      emitGlobal(globalState, prevGlobalState);
      return true;
    },

    // 注销该应用下的依赖
    offGlobalStateChange() {
      delete deps[id];
      return true;
    },
  };
}

这个函数结构也是很清晰的,入参为id和isMaster,在这里isMaster为true,id为global-当前时间,return了一个对象,其中的两个属性就是我们的onGlobalStateChangesetGlobalStateonGlobalStateChange,接受两个参数,第一个参数必填,是一个回调函数,第二个参数是可选的,是一个布尔值,用于控制是否立即执行回调函数,这里我们只分析fireImmediately为false的情况,当调用这个函数的时候, 会往全局的deps下添加一个回调函数,这个回调函数的key为id,value为传入的回调函数,这个回调函数的作用是在全局数据发生变化的时候,执行传入的回调函数,这个回调函数的入参为全局数据和上一次的全局数据,我们看下实际使用时的例子:

ts 复制代码
onGlobalStateChange((value, prev) => console.log('[onGlobalStateChange - master]:', value, prev));

接下来我们再看下setGlobalState函数,这个函数接受一个对象作为参数,这个对象就是我们要修改的全局数据,它做了两件事:

  1. 新旧数据的比较,如果没有变化,就不执行后续操作,否则修改全局globalState(源码中有关于只会修改初始化时的第一层bucket,目前好像没有看到相关逻辑,后续再看)
  2. 触发全局的监听函数emitGlobal,这个函数的作用是遍历全局的deps,执行所有的回调函数,这些回调函数的入参为全局数据和上一次的全局数据,我们看下函数定义:
ts 复制代码
function emitGlobal(state: Record<string, any>, prevState: Record<string, any>) {
  Object.keys(deps).forEach((id: string) => {
    if (deps[id] instanceof Function) {
      deps[id](cloneDeep(state), cloneDeep(prevState));
    }
  });
}

代码比较简单,遍历deps,执行所有的回调函数,并传入全局数据和老的全局数据,这样我们就可以在全局数据发生变化的时候,执行我们的回调函数,这样就实现了全局数据的监听。流程图如下:

总结

初始化全局数据的逻辑还是比较清晰,通过onGlobalStateChange注册回调,通过setGloablState修改全局数据,最后触发我们在onGlobalStateChange中注册的回调函数。

相关推荐
小小小小宇4 小时前
虚拟列表兼容老DOM操作
前端
悦悦子a啊4 小时前
Python之--基本知识
开发语言·前端·python
安全系统学习5 小时前
系统安全之大模型案例分析
前端·安全·web安全·网络安全·xss
涛哥码咖5 小时前
chrome安装AXURE插件后无效
前端·chrome·axure
OEC小胖胖5 小时前
告别 undefined is not a function:TypeScript 前端开发优势与实践指南
前端·javascript·typescript·web
行云&流水6 小时前
Vue3 Lifecycle Hooks
前端·javascript·vue.js
Sally璐璐6 小时前
零基础学HTML和CSS:网页设计入门
前端·css
老虎06276 小时前
JavaWeb(苍穹外卖)--学习笔记04(前端:HTML,CSS,JavaScript)
前端·javascript·css·笔记·学习·html
三水气象台6 小时前
用户中心Vue3网页开发(1.0版)
javascript·css·vue.js·typescript·前端框架·html·anti-design-vue
灿灿121386 小时前
CSS 文字浮雕效果:巧用 text-shadow 实现 3D 立体文字
前端·css