qiankun -- 入门微前端

微前端(Micro-Frontends)是一种类似于微服务的架构,它将微服务的理念应用于浏览器端,即将 Web 应用分解成一些更小、更简单的小模块,而在用户侧看起来还是一个内聚的产品。各个前端应用还可以独立运行、独立开发、独立部署。微前端不是单纯的前端框架或者工具,而是一套架构体系。

qiankun是一个基于 single-spa 的微前端实现库,旨在帮助大家能更简单、无痛的构建一个生产可用微前端架构系统。

安装

$ yarn add qiankun # 或者 npm i qiankun -S

创建基座项目,并在基座项目中引入qiankun

这里我们基座项目使用的是vue项目,版本为vue@3.0.0,具体创建项目教程请参考创建vue,项目目录结构如下:

|-- qiankun

    |-- .DS_Store

    |-- .browserslistrc

    |-- .eslintrc.js

    |-- .gitignore

    |-- README.md

    |-- babel.config.js

    |-- package-lock.json

    |-- package.json

    |-- public

    |  |-- favicon.ico

    |  |-- index.html

    |-- src

        |-- .DS_Store

        |-- App.vue

        |-- main.js

        |-- assets

        |  |-- logo.png

        |-- components

        |  |-- HelloWorld.vue

        |-- router

        |  |-- index.js

        |-- views

            |-- About.vue

            |-- Home.vue

创建子应用

创建两个子应用,分别为Vue项目和React项目:

vue目录结构:

|-- .DS_Store

    |-- .browserslistrc

    |-- .eslintrc.js

    |-- .gitignore

    |-- README.md

    |-- babel.config.js

    |-- package-lock.json

    |-- package.json

    |-- vue.config.js

    |-- public

    |  |-- favicon.ico

    |  |-- index.html

    |-- src

        |-- App.vue

        |-- main.js

        |-- assets

        |  |-- logo.png

        |-- components

        |  |-- HelloWorld.vue

        |-- router

        |  |-- index.js

        |-- views

            |-- About.vue

            |-- Home.vue

react目录结构:

react项目创建请参考创建 react

|-- .DS_Store

    |-- .eslintrc.js

    |-- .gitignore

    |-- README.md

    |-- config-overrides.js

    |-- package-lock.json

    |-- package.json

    |-- yarn.lock

    |-- public

    |  |-- favicon.ico

    |  |-- index.html

    |  |-- logo192.png

    |  |-- logo512.png

    |  |-- manifest.json

    |  |-- robots.txt

    |-- src

        |-- App.css

        |-- App.js

        |-- App.test.js

        |-- index.css

        |-- index.js

        |-- logo.svg

        |-- reportWebVitals.js

        |-- setupTests.js

基座中引入

在基座项目中引入qiankun,修改main.js文件

import { registerMicroApps, start } from "qiankun";

const apps = [

  {

    name: 'vueApp',

    entry: '//localhost:8081', // 默认会加载这个html,解析里面的js,动态执行(子应用必须支持跨域)

    container: '#vue',

    activeRule: '/vue',

    props: { a: 1 }

  },

  {

    name: 'reactApp',

    entry: "//localhost:3000",

    container: "#react",

    activeRule: '/react'

  }

]

registerMicroApps(apps);

start({

  // sandbox: { experimentalStyleIsolation: true } //沙箱默认开启

})

createApp(App).use(ElementPlus).use(router).mount('#appBase')

registerMicroApps的相关入参请参考入参,其中:

container是针对微应用挂载的节点,

entry微应用的入口,微应用的访问地址;

activeRule微应用的激活规则,当配置为字符串时会直接跟 url 中的路径部分做前缀匹配,匹配成功表明当前应用会被激活。所以我们需要在基座项目中修改App.vue,在该项目中增加微应用的挂载节点,修改如下:

<template>

  <div id="nav">

    <el-menu class="el-menu-demo" :router="true" mode="horizontal">

      <el-menu-item index="/">Home</el-menu-item>

      <el-menu-item index="/vue">vue应用</el-menu-item>

      <el-menu-item index="/react">react应用</el-menu-item>

    </el-menu>

    <router-view />

    <div id="vue"></div>

    <div id="react"></div>

  </div>

</template>

子应用文件修改

我们需要根据协议,在子应用的入口文件中导出三个生命周期函数,以供主应用在适当的时机调用:

/**

* 只会在微应用初始化的时候调用一次,下次微应用重新进入时会直接调用 mount 钩子,不会再重复触发 bootstrap

*/

export async function bootstrap() { }

/**

* 应用每次进入都会调用 mount 方法,通常我们在这里触发应用的渲染方法

* @param {*} props

*/

export async function mount(props) {

  console.log(props);

}

/**

* 应用每次 切出/卸载 会调用的方法,通常在这里我们会卸载微应用的应用实例

* @param {*} props

*/

export async function unmount(props) {

  console.log(app);

}

为了能让子应用也可独立运行,我们可以根据qiankun在全局注册一个变量window.__POWERED_BY_QIANKUN__,来区分子应用是否运行在qiankun中:

vue

// vue

import { createApp } from 'vue'

import App from './App.vue'

import router from './router'

let app = null

function render(props) {

    app = createApp(App).use(router) //挂载到自己的html.基座会拿到挂载后的html,直接插入

    app.mount('#app')

}

if (window.__POWERED_BY_QIANKUN__) { // 动态添加publicPath

    __webpack_public_path__ = window.__INJECTED_PUBLIC_PATH_BY_QIANKUN__;

}

if (!window.__POWERED_BY_QIANKUN__) { //

    render()

}

// 子组件的协议

/**

* 只会在微应用初始化的时候调用一次,下次微应用重新进入时会直接调用 mount 钩子,不会再重复触发 bootstrap

*/

export async function bootstrap() { }

/**

* 应用每次进入都会调用 mount 方法,通常我们在这里触发应用的渲染方法

* @param {*} props

*/

export async function mount(props) {

    console.log(props);

    render(props)

}

/**

* 应用每次 切出/卸载 会调用的方法,通常在这里我们会卸载微应用的应用实例

* @param {*} props

*/

export async function unmount(props) {

    console.log(app);

    app.unmount() // 卸载

}

react

// react

import React from 'react';

import ReactDOM from 'react-dom';

import './index.css';

import App from './App';

function render() {

  ReactDOM.render(

    <React.StrictMode>

      <App />

    </React.StrictMode>,

    document.getElementById('root')

  );

}

if (window.__POWERED_BY_QIANKUN__) { // 动态添加publicPath

  __webpack_public_path__ = window.__INJECTED_PUBLIC_PATH_BY_QIANKUN__;

}

if (!window.__POWERED_BY_QIANKUN__) {

  render()

}

export async function bootstrap() { };

export async function mount() {

  render()

};

export async function unmount() {

  ReactDOM.unmountComponentAtNode(document.getElementById('root'))

};

子应用配置修改

vue

//vue vue.config.js

module.exports = {

    devServer: {

        headers: {

            'Access-Control-Allow-Origin': '*' //支持跨域

        }

    },

    configureWebpack: {

        output: {

            library: 'vueApp',

            libraryTarget: 'umd',

        }

    },

    publicPath: 'http://localhost:8081/'

}

react

module.exports = {

    webpack: (config) => {

        config.output.library = 'reactApp';

        config.output.libraryTarget = 'umd';

        config.output.publicPath = 'http://localhost:3000/' // 静态资源路径

        return config

    },

    devServer: (configFunction) => {

        return function (proxy, allowedHost) {

            const config = configFunction(proxy, allowedHost);

            config.headers = {

                "Access-Control-Allow-Origin": "*"

            }

            return config

        }

    }

}

运行结果

子应用独立运行结果展示

基座运行结果

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,294评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,493评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,790评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,595评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,718评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,906评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,053评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,797评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,250评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,570评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,711评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,388评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,018评论 3 316
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,796评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,023评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,461评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,595评论 2 350

推荐阅读更多精彩内容