前端架构成长之路——微前端系列(二)之qiankun框架实战

简介: 用微前端架构去对某个古老项目进行框架升级

背景


之前有写过专门一篇关于微前端架构的基础知识——《前端架构成长之路——微前端架构理论篇》,但是里面主要讲几个点:

  • 微前端是什么,具体能做些什么
  • 微前端的一些主流框架
  • 微前端拆分项目的一些原则


那么其实对于微前端应用还是有些不太清楚,下面就用微前端架构去对某个古老项目进行框架升级,这其实也是微前端架构主要特性之一,对项目升级的方案之一。


在使用 qiankun  框架之前,脑子里有几个疑问:

  • qiankun 是怎么做到将不同框架的项目放在一起,是通过打包,还是其他方式:
  • qiankun 是有1个主基座 + N 个微应用
  • qiankun 利用路由控制,去加载不同的微应用,微应用与主应用之间消除跨域问题
  • qiankun 需要在子应用里加入生命周期钩子函数提供给主应用调用


搞明白后,我们就可以开始进行项目实战,

项目实战


由于本次是将老项目升级到新版本框架中,因此将采用 Monorepo 架构对新老项目进行统一管理。项目结构大概 如下所示:

qiankun-demo
├── apps # 应用层
|  ├── main #  基座项目
|  |  ├── ...
|  ├── old #  老版项目
|  |  ├── ...
|  └── new #  新版项目
|     ├── ...
├── README.md
├── nx.json #  nx.js 管理Monorepo
├── package.json
├── pnpm-lock.yaml
├── pnpm-workspace.yaml

main-基座项目


qiankun 的基座项目和普通 web 项目初始化没有什么区别,你可以基于 React  或  Vue 作为基座项目框架都可以,但是需要入口文件需要做一下调整,下面我以 Vue+Vite 项目为例:

步骤一: 初始化项目

npm create vite@latest main-vue -- --template vue
# 添加 qiankun
npm i qiankun -S

步骤二:在main.ts准备好基座项目以及注册微应用

import { createApp } from 'vue'
import { registerMicroApps, start , runAfterFirstMounted, setDefaultMountApp} from 'qiankun';
import './style.css'
import App from './App.vue'
/**
 * Step1 初始化应用
 */
createApp(App).mount('#app')
/**
 * Step2 注册子应用
 */
registerMicroApps(
    [
        {
            name: 'old-web', // 注册后子应用的名字 老项目启动端口为8080
            entry: '//localhost:8080', // 这里可以根据环境变量配置
            container: '#subapp-viewport',
            activeRule: '/old',
        },
        {
            name: 'new-web', // 注册后子应用的名字 新项目启动端口为8090
            entry: '//localhost:8090',
            container: '#subapp-viewport',
            activeRule: '/new',
        },
    ],
    {
        // qiankun 生命周期钩子 - 加载前
        beforeLoad: [
            (app) => {
                console.log('[LifeCycle] before load %c%s', 'color: green;', app.name);
            },
        ],
        beforeMount: [
            (app) => {
                console.log('[LifeCycle] before mount %c%s', 'color: green;', app.name);
            },
        ],
        afterMount: [
            (app) => {
                console.log('[LifeCycle] after mount %c%s', 'color: green;', app.name);
            },
        ],
        beforeUnmount: (app) => {
            console.log('[LifeCycle] before Unmount %c%s', 'color: green;', app.name);
        },
        afterUnmount: [
            (app) => {
                console.log('[LifeCycle] after unmount %c%s', 'color: green;', app.name);
            },
        ],
    },);
/**
 * Step3 设置默认进入的子应用
 */
// setDefaultMountApp('/old');
/**
 * Step4 启动应用
 */
start();
runAfterFirstMounted(() => {
  console.log('[MainApp] first app mounted');
});

microapp-微应用


微应用其实改动代码不多,只是需要将qiankun 所需要的接口(bootstrap, mountunmount) 暴露出来即可

步骤一: 新建 public-path.js 代码如下:

// 主要用来区分 qiankun 加载资源路径
if (window.__POWERED_BY_QIANKUN__) {
  __webpack_public_path__ = window.__INJECTED_PUBLIC_PATH_BY_QIANKUN__;
}

步骤二: 在 app.js 加入qiankun的接口,将 render 函数

var React = require('react')
var ReactDom = require('react-dom')
var ReactRouter2 = require('react-router')
var RouteConfig = require('./config/RouteConfig')
var Utils = require('radmin').Utils
import { createHistory } from 'history'
import './public-path.js'
import ReactRouter, { Router, Route, useRouterHistory } from 'react-router'
var appHistory = useRouterHistory(createHistory)({ queryKey: false });
require('../less/index.less')
/**
 * bootstrap 只会在微应用初始化的时候调用一次,下次微应用重新进入时会直接调用 mount 钩子,不会再重复触发 bootstrap。
 * 通常我们可以在这里做一些全局变量的初始化,比如不会在 unmount 阶段被销毁的应用级别的缓存等。
 */
export async function bootstrap() {
  console.log('[react15] react app bootstraped');
}
export async function mount(props = {}) {
  console.log('[react15] props from main framework', props);
  const { container } = props;
  // 这里判断 container 是否qiankun 携带进来的
  ReactDom.render(<ReactRouter2.Router routes={Utils.combineConfig(RouteConfig)} history={appHistory} />, container ? container.querySelector('#react15Root') : document.getElementById('react15Root'))
}
export async function unmount(props) {
  const { container } = props;
  ReactDOM.unmountComponentAtNode(
    container ? container.querySelector('#react15Root') : document.getElementById('react15Root'),
  );
}
// 独立的时候可自主运行
if (!window.__POWERED_BY_QIANKUN__) {
  bootstrap().then(mount);
}else{
  window.bootstrap = bootstrap;
  window.mount = mount;
}

步骤三: 在webpack.config.js调整打包配置,将 app.js暴露到window中:

var path = require('path')
module.exports = {
    entry: [
        path.resolve(__dirname, './src/js/app')
    ],
    output: {
        path: path.resolve(__dirname, 'hot'),
        filename: 'app.js',
        library: `${packageName}-[name]`,
        libraryTarget: 'umd',
        globalObject: 'window',
        jsonpFunction: `webpackJsonp_${packageName}`,
    }
}

到了这里,基本上就可以完成项目改造工作了,但是后续还需要其他一些改动点,如:

1.基座项目需要切换为真实域名,可以按照构建环境变量去切换

2.微应用需要注意资源使用相对路径

3.针对不同打包工具,都需要将bootstrapmount 函数进行暴露到 window 对象中,因为 qiankun 会拦截代理 window去运行微应用

4.需要解决不同应用之间的登录态等问题

qiankun 的缺陷


虽然 qiankun 使用起来很简单,但是在实际应用还是存在一些缺陷,但是在将其引入到项目中的时候,需要考虑这些点:

  • 对于 jQuery 老项目支持度不够,即使有解决方案,但是需要对 qiankun 整个框架原理深入了解才能明白如何解决
  • 沙箱隔离机制并不完美,如:写 css 代码挂载到 document.body,会导致样式污染
  • 通讯机制较简单,基于一个全局的 globalState 对象,去提供给到各个微应用去使用

参考资料


目录
相关文章
|
4月前
|
人工智能 监控 前端开发
支付宝 AI 出行助手高效研发指南:4 人团队的架构迁移与提效实战
支付宝「AI 出行助手」是一款集成公交、地铁、火车票、机票、打车等多项功能的智能出行产品。
683 21
支付宝 AI 出行助手高效研发指南:4 人团队的架构迁移与提效实战
|
4月前
|
消息中间件 Java Kafka
Java 事件驱动架构设计实战与 Kafka 生态系统组件实操全流程指南
本指南详解Java事件驱动架构与Kafka生态实操,涵盖环境搭建、事件模型定义、生产者与消费者实现、事件测试及高级特性,助你快速构建高可扩展分布式系统。
260 7
|
4月前
|
监控 Java API
Spring Boot 3.2 结合 Spring Cloud 微服务架构实操指南 现代分布式应用系统构建实战教程
Spring Boot 3.2 + Spring Cloud 2023.0 微服务架构实践摘要 本文基于Spring Boot 3.2.5和Spring Cloud 2023.0.1最新稳定版本,演示现代微服务架构的构建过程。主要内容包括: 技术栈选择:采用Spring Cloud Netflix Eureka 4.1.0作为服务注册中心,Resilience4j 2.1.0替代Hystrix实现熔断机制,配合OpenFeign和Gateway等组件。 核心实操步骤: 搭建Eureka注册中心服务 构建商品
759 3
|
4月前
|
消息中间件 Java 数据库
Java 基于 DDD 分层架构实战从基础到精通最新实操全流程指南
本文详解基于Java的领域驱动设计(DDD)分层架构实战,结合Spring Boot 3.x、Spring Data JPA 3.x等最新技术栈,通过电商订单系统案例展示如何构建清晰、可维护的微服务架构。内容涵盖项目结构设计、各层实现细节及关键技术点,助力开发者掌握DDD在复杂业务系统中的应用。
764 0
|
5月前
|
存储 SQL 监控
数据中台架构解析:湖仓一体的实战设计
在数据量激增的数字化时代,企业面临数据分散、使用效率低等问题。数据中台作为统一管理与应用数据的核心平台,结合湖仓一体架构,打通数据壁垒,实现高效流转与分析。本文详解湖仓一体的设计与落地实践,助力企业构建统一、灵活的数据底座,驱动业务决策与创新。
|
5月前
|
存储 设计模式 人工智能
AI Agent安全架构实战:基于LangGraph的Human-in-the-Loop系统设计​
本文深入解析Human-in-the-Loop(HIL)架构在AI Agent中的核心应用,探讨其在高风险场景下的断点控制、状态恢复与安全管控机制,并结合LangGraph的创新设计与金融交易实战案例,展示如何实现效率与安全的平衡。
841 0
|
2月前
|
Cloud Native Serverless API
微服务架构实战指南:从单体应用到云原生的蜕变之路
🌟蒋星熠Jaxonic,代码为舟的星际旅人。深耕微服务架构,擅以DDD拆分服务、构建高可用通信与治理体系。分享从单体到云原生的实战经验,探索技术演进的无限可能。
微服务架构实战指南:从单体应用到云原生的蜕变之路
|
2月前
|
监控 Cloud Native Java
Spring Boot 3.x 微服务架构实战指南
🌟蒋星熠Jaxonic,技术宇宙中的星际旅人。深耕Spring Boot 3.x与微服务架构,探索云原生、性能优化与高可用系统设计。以代码为笔,在二进制星河中谱写极客诗篇。关注我,共赴技术星辰大海!(238字)
Spring Boot 3.x 微服务架构实战指南
|
3月前
|
消息中间件 数据采集 NoSQL
秒级行情推送系统实战:从触发、采集到入库的端到端架构
本文设计了一套秒级实时行情推送系统,涵盖触发、采集、缓冲、入库与推送五层架构,结合动态代理IP、Kafka/Redis缓冲及WebSocket推送,实现金融数据低延迟、高并发处理,适用于股票、数字货币等实时行情场景。
351 3
秒级行情推送系统实战:从触发、采集到入库的端到端架构

热门文章

最新文章