微前端框架qiankun入门指南:主应用与子应用集成详解

微前端框架qiankun入门指南:主应用与子应用集成详解

qiankun Blazing fast, simple and complete solution for micro frontends. qiankun 项目地址: https://gitcode.com/gh_mirrors/qia/qiankun

前言

微前端架构正在成为大型前端应用开发的主流模式,而qiankun作为基于single-spa的微前端解决方案,提供了更加完善的开发体验。本文将详细介绍如何使用qiankun框架实现主应用与子应用的集成。

主应用配置

1. 安装依赖

首先需要在主应用中安装qiankun核心库:

yarn add qiankun
# 或者使用npm
npm install qiankun --save

2. 注册子应用

在主应用入口文件中,需要注册所有需要管理的子应用:

import { registerMicroApps, start } from 'qiankun';

registerMicroApps([
  {
    name: 'react子应用',  // 子应用唯一标识
    entry: '//localhost:7100',  // 子应用入口地址
    container: '#subapp-container',  // 挂载容器ID
    activeRule: '/react',  // 激活路由规则
  },
  {
    name: 'vue子应用',
    entry: { scripts: ['//localhost:7100/main.js'] },  // 也支持对象格式
    container: '#subapp-container',
    activeRule: '/vue',
  },
]);

// 启动qiankun
start();

关键点说明:

  • name:子应用唯一名称,建议与package.json中的name保持一致
  • entry:支持字符串或对象格式,可以是完整URL或相对路径
  • container:子应用挂载的DOM节点
  • activeRule:路由匹配规则,可以是字符串、函数或数组

当浏览器URL发生变化时,qiankun会自动匹配activeRule返回true的子应用,并依次调用其生命周期钩子函数。

子应用配置

子应用无需额外安装qiankun依赖,但需要做以下改造:

1. 导出生命周期钩子

子应用需要在其入口文件(通常是webpack配置的entry文件)中导出三个必要的生命周期函数:

// 初始化钩子,只会执行一次
export async function bootstrap() {
  console.log('子应用初始化');
}

// 挂载钩子,每次进入都会调用
export async function mount(props) {
  ReactDOM.render(
    <App />,
    props.container 
      ? props.container.querySelector('#root') 
      : document.getElementById('root')
  );
}

// 卸载钩子,每次切出/卸载都会调用
export async function unmount(props) {
  ReactDOM.unmountComponentAtNode(
    props.container 
      ? props.container.querySelector('#root') 
      : document.getElementById('root')
  );
}

// 可选更新钩子
export async function update(props) {
  console.log('子应用更新', props);
}

生命周期详解:

  • bootstrap:子应用初始化时调用,适合做全局变量设置等一次性操作
  • mount:子应用挂载时调用,通常在这里执行渲染逻辑
  • unmount:子应用卸载时调用,需要清理定时器、事件监听等
  • update:可选,使用loadMicroApp方式加载子应用时才会触发

2. 修改打包配置

为了让主应用能正确识别子应用暴露的资源,需要修改子应用的webpack配置:

Webpack 5配置
const packageName = require('./package.json').name;

module.exports = {
  output: {
    library: `${packageName}-[name]`,
    libraryTarget: 'umd',
    chunkLoadingGlobal: `webpackJsonp_${packageName}`,
  },
};
Webpack 4配置
const packageName = require('./package.json').name;

module.exports = {
  output: {
    library: `${packageName}-[name]`,
    libraryTarget: 'umd',
    jsonpFunction: `webpackJsonp_${packageName}`,
  },
};

配置说明:

  • library:将子应用导出为UMD格式的库
  • libraryTarget:指定模块化规范为UMD
  • chunkLoadingGlobal/jsonpFunction:避免多个子应用间的chunk冲突

开发注意事项

  1. 样式隔离:qiankun默认提供了样式隔离,但建议子应用使用BEM等命名规范避免冲突

  2. 路由处理:子应用路由应基于主应用分配的基础路由进行开发

  3. 全局状态:避免直接修改window等全局对象,建议使用qiankun提供的props通信

  4. 静态资源:子应用静态资源建议使用绝对路径,或通过webpack的publicPath配置

  5. 跨域问题:开发环境下需要配置CORS,生产环境建议将主应用和子应用部署在同一域名下

结语

通过以上步骤,我们完成了qiankun微前端架构的基本集成。qiankun的强大之处在于它对各种技术栈子应用的包容性,无论是React、Vue还是Angular应用,都可以无缝集成。在实际项目中,还可以根据需求进一步探索qiankun的高级功能,如预加载、沙箱隔离等。

qiankun Blazing fast, simple and complete solution for micro frontends. qiankun 项目地址: https://gitcode.com/gh_mirrors/qia/qiankun

创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

仲嘉煊

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值