前端架构成长之路——微前端系列(二)之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 对象,去提供给到各个微应用去使用

参考资料


目录
相关文章
|
1月前
|
前端开发 JavaScript 开发者
颠覆传统:React框架如何引领前端开发的革命性变革
【10月更文挑战第32天】本文以问答形式探讨了React框架的特性和应用。React是一款由Facebook推出的JavaScript库,以其虚拟DOM机制和组件化设计,成为构建高性能单页面应用的理想选择。文章介绍了如何开始一个React项目、组件化思想的体现、性能优化方法、表单处理及路由实现等内容,帮助开发者更好地理解和使用React。
78 9
|
1月前
|
前端开发 JavaScript
探索现代Web应用的微前端架构
【10月更文挑战第40天】在数字时代的浪潮中,Web应用的发展日益复杂多变。微前端架构作为一种新兴的设计理念,正逐步改变着传统的单一前端开发模式。本文将深入探讨微前端的核心概念、实现原理及其在实际项目中的应用,同时通过一个简单的代码示例,揭示如何将一个庞大的前端工程拆分成小而美的模块,进而提升项目的可维护性、可扩展性和开发效率。
|
1月前
|
存储 分布式计算 关系型数据库
架构/技术框架调研
本文介绍了微服务间事务处理、调用、大数据处理、分库分表、大文本存储及数据缓存的最优解决方案。重点讨论了Seata、Dubbo、Hadoop生态系统、MyCat、ShardingSphere、对象存储服务和Redis等技术,提供了详细的原理、应用场景和优缺点分析。
|
1月前
|
监控 前端开发 数据可视化
3D架构图软件 iCraft Editor 正式发布 @icraft/player-react 前端组件, 轻松嵌入3D架构图到您的项目,实现数字孪生
@icraft/player-react 是 iCraft Editor 推出的 React 组件库,旨在简化3D数字孪生场景的前端集成。它支持零配置快速接入、自定义插件、丰富的事件和方法、动画控制及实时数据接入,帮助开发者轻松实现3D场景与React项目的无缝融合。
111 8
3D架构图软件 iCraft Editor 正式发布 @icraft/player-react 前端组件, 轻松嵌入3D架构图到您的项目,实现数字孪生
|
7天前
|
机器学习/深度学习 前端开发 算法
婚恋交友系统平台 相亲交友平台系统 婚恋交友系统APP 婚恋系统源码 婚恋交友平台开发流程 婚恋交友系统架构设计 婚恋交友系统前端/后端开发 婚恋交友系统匹配推荐算法优化
婚恋交友系统平台通过线上互动帮助单身男女找到合适伴侣,提供用户注册、个人资料填写、匹配推荐、实时聊天、社区互动等功能。开发流程包括需求分析、技术选型、系统架构设计、功能实现、测试优化和上线运维。匹配推荐算法优化是核心,通过用户行为数据分析和机器学习提高匹配准确性。
35 3
|
5天前
|
前端开发 搜索推荐 安全
陪玩系统架构设计陪玩系统前后端开发,陪玩前端设计是如何让人眼前一亮的?
陪玩系统的架构设计、前后端开发及前端设计是构建吸引用户、功能完善的平台关键。架构需考虑用户需求、技术选型、安全性等,确保稳定性和扩展性。前端可选用React、Vue或Uniapp,后端用Spring Boot或Django,数据库结合MySQL和MongoDB。功能涵盖用户管理、陪玩者管理、订单处理、智能匹配与通讯。安全性方面采用SSL加密和定期漏洞扫描。前端设计注重美观、易用及个性化推荐,提升用户体验和平台粘性。
32 0
|
1月前
|
监控
SMoA: 基于稀疏混合架构的大语言模型协同优化框架
通过引入稀疏化和角色多样性,SMoA为大语言模型多代理系统的发展开辟了新的方向。
46 6
SMoA: 基于稀疏混合架构的大语言模型协同优化框架
|
22天前
|
存储 前端开发 JavaScript
前端状态管理:Vuex 核心概念与实战
Vuex 是 Vue.js 应用程序的状态管理模式和库。它采用集中式存储管理应用的所有组件的状态,并以相应的规则保证状态以一种可预测的方式发生变化。本教程将深入讲解 Vuex 的核心概念,如 State、Getter、Mutation 和 Action,并通过实战案例帮助开发者掌握在项目中有效使用 Vuex 的技巧。
|
1月前
|
前端开发 JavaScript API
前端界的秘密武器:掌握这些框架,让你轻松秒杀99%的同行!
前端开发日新月异,掌握几个明星框架如React、Vue.js和Angular,不仅能让工作更得心应手,还能轻松超越同行。React以高效的虚拟DOM和组件化著称;Vue.js简洁易懂,灵活性高;Angular提供全面的解决方案,适合大型应用。此外,轻量级的Svelte也值得关注,其编译时处理设计提升了应用性能。掌握这些框架,结合深刻理解和灵活运用,助你在前端领域脱颖而出。
32 9
|
1月前
|
消息中间件 前端开发 JavaScript
探索微前端架构:构建现代Web应用的新策略
本文探讨了微前端架构的概念、优势及实施策略,旨在解决传统单体应用难以快速迭代和团队协作的问题。微前端允许不同团队独立开发、部署应用的各部分,提升灵活性与可维护性。文中还讨论了技术栈灵活性、独立部署、团队自治等优势,并提出了定义清晰接口、使用Web组件、状态管理和样式隔离等实施策略。