当前文档对应 qiankun 3.0(RC),安装请使用 npm i qiankun@rc;2.x 文档见 v2 站点
Skip to content

实用指南

本节汇总 qiankun v3 常见场景的处理方法。各页面围绕明确目标组织内容,并提供相应的配置和代码示例。若需了解相关机制,请参阅文中链接的核心概念页面。

阅读说明

  • 每篇指南针对一个具体目标,例如启用某项能力、改造微应用或处理特定故障,不会逐项介绍某个 API 的全部功能。
  • 各篇内容可以独立阅读。文中的步骤假定 qiankun 已安装,并且已有可运行的主应用和至少一个微应用。尚未完成基础接入时,请先阅读快速上手教程
  • 本节不重复说明底层机制。相关内容请参阅 JavaScript 沙箱样式隔离HTML 入口加载等核心概念页面。
  • 类型、默认值和完整字段说明见 API 参考。本节侧重说明各项配置在具体场景中的使用方式。

指南一览

指南目标
启用 CSS 样式隔离为指定应用启用 sandbox.styleIsolation,避免微应用样式影响主应用或其他微应用。
优化加载与预加载配置缓存、控制入口体积,并利用流式加载器的自动预加载能力。
处理微应用错误通过 addErrorHandlerremoveErrorHandler 和实例级状态处理加载及生命周期错误。
应用间共享状态与通信通过 props 在主应用和微应用之间传递数据与回调。qiankun v3 不再提供内置状态管理。
从 qiankun 2.x 迁移将 2.x 接入方式迁移到 v3,包括字符串 entry、元素 container、应用级 configuration 和已移除的选项。
接入 Vite 应用配置 @qiankunjs/bundler-plugin/vite 并导出生命周期,使 Vite 应用能够作为微应用加载。
接入 Webpack 应用配置 QiankunWebpackPlugin 并导出生命周期,使 Webpack 应用能够作为微应用加载。
运行多个微应用实例使用 loadMicroApp 挂载同一应用或不同应用的多个实例,并分别管理其卸载过程。
用插件扩展沙箱编写隔离插件,让自定义副作用与内置插件一样被捕获、释放和重建。
独立使用沙箱单独使用 @qiankunjs/sandbox 隔离第三方脚本,无需加载完整的微应用。

按目标选择指南

可根据具体任务选择对应指南:

默认使用 loadMicroApp

本节示例默认将 AppConfiguration 作为 loadMicroApp 的第二个参数传入。对于由路由驱动的应用,可将同一配置写入 registerMicroApps 的应用 configuration 字段。完整字段和默认值见配置参考。

v3 不再内置全局状态管理

qiankun v3 已移除 2.x 中的 initGlobalStateonGlobalStateChangesetGlobalState。需要共享状态时,应通过 props 传递数据和回调。详见应用间共享状态与通信

相关

基于 MIT 协议发布