二.qiankun（源码解析）

qiankun@2.6.3项目目录结构

bash

├── src              # 源码文件夹
│   ├── assets       # 存放组件中的静态资源
│   ├── apis.ts   # 存放一些公共组件
│   ├── effects.ts        # 存放所有的路由组件
│   ├── error.ts      # 应用根主组件
│   ├── index.ts      # 应用入口
│   ├── router       # 路由配置文件
│   └── store        # vuex状态管理文件

1.入口

export { loadMicroApp, registerMicroApps, start } from "./apis"
export { initGlobalState } from "./globalState"
export { getCurrentRunningApp as __internalGetCurrentRunningApp } from "./sandbox"
export * from "./errorHandler"
export * from "./effects"
export * from "./interfaces"
export { prefetchImmediately as prefetchApps } from "./prefetch"

2.apis

let microApps: Array<RegistrableApp<Record<string, unknown>>> = []
export let frameworkConfiguration: FrameworkConfiguration = {};
export function registerMicroApps<T extends ObjectType>(
  apps: Array<RegistrableApp<T>>,
  lifeCycles?: FrameworkLifeCycles<T>
) {
  // Each app only needs to be registered once
  const unregisteredApps = apps.filter(
    (app) => !microApps.some((registeredApp) => registeredApp.name === app.name)
  ) //选出未注册的子项目

  microApps = [...microApps, ...unregisteredApps] //注册子项目

  unregisteredApps.forEach((app) => {
    const { name, activeRule, loader = noop, props, ...appConfig } = app

    registerApplication({
      //调用single-spa的方法注册子项目
      name,
      app: async () => {
        loader(true)
        await frameworkStartedDefer.promise // promise等待resolve

        const { mount, ...otherMicroAppConfigs } = (
          await loadApp(
            { name, props, ...appConfig },
            frameworkConfiguration,
            lifeCycles
          )
        )()

        return {
          mount: [
            async () => loader(true),
            ...toArray(mount),
            async () => loader(false),
          ],
          ...otherMicroAppConfigs,
        }
      },
      activeWhen: activeRule,
      customProps: props,
    })
  })
}
export function start(opts: FrameworkConfiguration = {}) {
  frameworkConfiguration = {
    prefetch: true,
    singular: true,
    sandbox: true,
    ...opts,
  }
  const {
    prefetch,
    sandbox,
    singular,
    urlRerouteOnly = defaultUrlRerouteOnly,
    ...importEntryOpts
  } = frameworkConfiguration

  if (prefetch) {
    doPrefetchStrategy(microApps, prefetch, importEntryOpts)
  }

  frameworkConfiguration = autoDowngradeForLowVersionBrowser(
    frameworkConfiguration
  )

  startSingleSpa({ urlRerouteOnly })
  started = true

  frameworkStartedDefer.resolve()
}

3.loader.ts

export async function loadApp<T extends ObjectType>(
  app: LoadableApp<T>,
  configuration: FrameworkConfiguration = {},
  lifeCycles?: FrameworkLifeCycles<T>
): Promise<ParcelConfigObjectGetter> {
  const { entry, name: appName } = app
  const appInstanceId = genAppInstanceIdByName(appName)

  const markName = `[qiankun] App ${appInstanceId} Loading`
  if (process.env.NODE_ENV === "development") {
    performanceMark(markName)
  }

  const {
    singular = false,
    sandbox = true,
    excludeAssetFilter,
    globalContext = window,
    ...importEntryOpts
  } = configuration

  // get the entry html content and script executor
  const { template, execScripts, assetPublicPath } = await importEntry( //核心部分获取子应用的 HTML 和 JS，同时对 HTML 和 JS 进行了各自的处理，以便于子应用在父应用中加载
    entry,
    importEntryOpts
  )

  // as single-spa load and bootstrap new app parallel with other apps unmounting
  // (see https://github.com/CanopyTax/single-spa/blob/master/src/navigation/reroute.js#L74)
  // we need wait to load the app until all apps are finishing unmount in singular mode
  if (await validateSingularMode(singular, app)) {
    await (prevAppUnmountedDeferred && prevAppUnmountedDeferred.promise)
  }

  const appContent = getDefaultTplWrapper(appInstanceId)(template)

  const strictStyleIsolation =
    typeof sandbox === "object" && !!sandbox.strictStyleIsolation

  if (process.env.NODE_ENV === "development" && strictStyleIsolation) {
    console.warn(
      "[qiankun] strictStyleIsolation configuration will be removed in 3.0, pls don't depend on it or use experimentalStyleIsolation instead!"
    )
  }

  const scopedCSS = isEnableScopedCSS(sandbox)
  let initialAppWrapperElement: HTMLElement | null = createElement(
    appContent,
    strictStyleIsolation,
    scopedCSS,
    appInstanceId
  )

  const initialContainer = "container" in app ? app.container : undefined
  const legacyRender = "render" in app ? app.render : undefined

  const render = getRender(appInstanceId, appContent, legacyRender)

  // 第一次加载设置应用可见区域 dom 结构
  // 确保每次应用加载前容器 dom 结构已经设置完毕
  render(
    {
      element: initialAppWrapperElement,
      loading: true,
      container: initialContainer,
    },
    "loading"
  )

  const initialAppWrapperGetter = getAppWrapperGetter(
    appInstanceId,
    !!legacyRender,
    strictStyleIsolation,
    scopedCSS,
    () => initialAppWrapperElement
  )

  let global = globalContext
  let mountSandbox = () => Promise.resolve()
  let unmountSandbox = () => Promise.resolve()
  const useLooseSandbox = typeof sandbox === "object" && !!sandbox.loose
  let sandboxContainer
  if (sandbox) {
    sandboxContainer = createSandboxContainer(
      appInstanceId,
      // FIXME should use a strict sandbox logic while remount, see https://github.com/umijs/qiankun/issues/518
      initialAppWrapperGetter,
      scopedCSS,
      useLooseSandbox,
      excludeAssetFilter,
      global
    )
    // 用沙箱的代理对象作为接下来使用的全局对象
    global = sandboxContainer.instance.proxy as typeof window
    mountSandbox = sandboxContainer.mount
    unmountSandbox = sandboxContainer.unmount
  }

  const {
    beforeUnmount = [],
    afterUnmount = [],
    afterMount = [],
    beforeMount = [],
    beforeLoad = [],
  } = mergeWith({}, getAddOns(global, assetPublicPath), lifeCycles, (v1, v2) =>
    concat(v1 ?? [], v2 ?? [])
  )

  await execHooksChain(toArray(beforeLoad), app, global)

  // get the lifecycle hooks from module exports
  const scriptExports: any = await execScripts(
    global,
    sandbox && !useLooseSandbox
  )
  const { bootstrap, mount, unmount, update } = getLifecyclesFromExports(
    scriptExports,
    appName,
    global,
    sandboxContainer?.instance?.latestSetProp
  )

  const {
    onGlobalStateChange,
    setGlobalState,
    offGlobalStateChange,
  }: Record<string, CallableFunction> = getMicroAppStateActions(appInstanceId)

  // FIXME temporary way
  const syncAppWrapperElement2Sandbox = (element: HTMLElement | null) =>
    (initialAppWrapperElement = element)

  const parcelConfigGetter: ParcelConfigObjectGetter = (
    remountContainer = initialContainer
  ) => {
    let appWrapperElement: HTMLElement | null
    let appWrapperGetter: ReturnType<typeof getAppWrapperGetter>

    const parcelConfig: ParcelConfigObject = {
      name: appInstanceId,
      bootstrap,
      mount: [
        async () => {
          if (process.env.NODE_ENV === "development") {
            const marks = performanceGetEntriesByName(markName, "mark")
            // mark length is zero means the app is remounting
            if (marks && !marks.length) {
              performanceMark(markName)
            }
          }
        },
        async () => {
          if (
            (await validateSingularMode(singular, app)) &&
            prevAppUnmountedDeferred
          ) {
            return prevAppUnmountedDeferred.promise
          }

          return undefined
        },
        // initial wrapper element before app mount/remount
        async () => {
          appWrapperElement = initialAppWrapperElement
          appWrapperGetter = getAppWrapperGetter(
            appInstanceId,
            !!legacyRender,
            strictStyleIsolation,
            scopedCSS,
            () => appWrapperElement
          )
        },
        // 添加 mount hook, 确保每次应用加载前容器 dom 结构已经设置完毕
        async () => {
          const useNewContainer = remountContainer !== initialContainer
          if (useNewContainer || !appWrapperElement) {
            // element will be destroyed after unmounted, we need to recreate it if it not exist
            // or we try to remount into a new container
            appWrapperElement = createElement(
              appContent,
              strictStyleIsolation,
              scopedCSS,
              appInstanceId
            )
            syncAppWrapperElement2Sandbox(appWrapperElement)
          }

          render(
            {
              element: appWrapperElement,
              loading: true,
              container: remountContainer,
            },
            "mounting"
          )
        },
        mountSandbox,
        // exec the chain after rendering to keep the behavior with beforeLoad
        async () => execHooksChain(toArray(beforeMount), app, global),
        async (props) =>
          mount({
            ...props,
            container: appWrapperGetter(),
            setGlobalState,
            onGlobalStateChange,
          }),
        // finish loading after app mounted
        async () =>
          render(
            {
              element: appWrapperElement,
              loading: false,
              container: remountContainer,
            },
            "mounted"
          ),
        async () => execHooksChain(toArray(afterMount), app, global),
        // initialize the unmount defer after app mounted and resolve the defer after it unmounted
        async () => {
          if (await validateSingularMode(singular, app)) {
            prevAppUnmountedDeferred = new Deferred<void>()
          }
        },
        async () => {
          if (process.env.NODE_ENV === "development") {
            const measureName = `[qiankun] App ${appInstanceId} Loading Consuming`
            performanceMeasure(measureName, markName)
          }
        },
      ],
      unmount: [
        async () => execHooksChain(toArray(beforeUnmount), app, global),
        async (props) => unmount({ ...props, container: appWrapperGetter() }),
        unmountSandbox,
        async () => execHooksChain(toArray(afterUnmount), app, global),
        async () => {
          render(
            { element: null, loading: false, container: remountContainer },
            "unmounted"
          )
          offGlobalStateChange(appInstanceId)
          // for gc
          appWrapperElement = null
          syncAppWrapperElement2Sandbox(appWrapperElement)
        },
        async () => {
          if (
            (await validateSingularMode(singular, app)) &&
            prevAppUnmountedDeferred
          ) {
            prevAppUnmountedDeferred.resolve()
          }
        },
      ],
    }

    if (typeof update === "function") {
      parcelConfig.update = update
    }

    return parcelConfig
  }

  return parcelConfigGetter
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265

二.qiankun（源码解析） ​

1.入口 ​

2.apis ​

3.loader.ts ​

二.qiankun（源码解析）

1.入口

2.apis

3.loader.ts