微前端qiankun改造日漸龐大的項(xiàng)目教程

更新時(shí)間：2022年06月16日 16:04:27 作者：szqlovexyt

這篇文章主要為大家介紹了微前端qiankun改造日漸龐大的項(xiàng)目教程示例，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪

項(xiàng)目背景

很多小伙伴在工作中都碰到過(guò)和我一樣的場(chǎng)景，手上的某個(gè)項(xiàng)目越來(lái)越大，眼看著每次build時(shí)間越來(lái)越長(zhǎng)，吐了??。在杭州某獨(dú)角獸我碰到了這樣的一個(gè)項(xiàng)目，他叫運(yùn)營(yíng)后臺(tái)，聽(tīng)名字就知道，他的主要用戶(hù)是運(yùn)營(yíng)人員。問(wèn)題就是隨著公司業(yè)務(wù)的越來(lái)越多，這個(gè)運(yùn)營(yíng)后臺(tái)承擔(dān)的已經(jīng)不是某一塊業(yè)務(wù)了，而是所有業(yè)務(wù)的運(yùn)營(yíng)操作的中后臺(tái)都在這上面。你可以這樣理解，這個(gè)系統(tǒng)的每個(gè)一級(jí)菜單都是一塊獨(dú)立的業(yè)務(wù)，相互之間沒(méi)有任何瓜葛；按常規(guī)的理解，這應(yīng)該是單獨(dú)的每一個(gè)project比較合理，但是正因?yàn)樗挠脩?hù)又都是公司的同一群人，他們?cè)缫呀?jīng)習(xí)慣就在運(yùn)營(yíng)后臺(tái)上去找自己的菜單進(jìn)行業(yè)務(wù)操作，拒不接受在他的收藏夾里多出來(lái)好幾個(gè)項(xiàng)目地址。那我們有沒(méi)有一個(gè)辦法讓我們的項(xiàng)目更好維護(hù)，又能讓用戶(hù)不改變他們使用同一個(gè)項(xiàng)目的期望呢。這就是寫(xiě)這篇文章的初衷，就是微前端??！????

微前端的好處

除了可以解決上面的問(wèn)題以外，你想想，只要我們把項(xiàng)目改造成了微前端，那每個(gè)業(yè)務(wù)都是獨(dú)立的project，只不過(guò)最終用戶(hù)都是在一個(gè)主項(xiàng)目里去使用，那我們每個(gè)project的技術(shù)棧也不用定死了，就不存在老項(xiàng)目的技術(shù)棧是vue，以至于后面的項(xiàng)目都必須要用vue了，你也可以用react，這就很香不是嗎。微前端的原理就是項(xiàng)目被拆成了父子關(guān)系，通過(guò)基座去引用了子應(yīng)用，子應(yīng)用之間是互相隔離的????

qiankun

可能是你見(jiàn)過(guò)最完善的微前端解決方案??——官方是這么介紹的，基于single-spa，這里我就不詳細(xì)介紹了，感興趣的去看看文檔，地址丟給你

qiankun
single-spa

改造過(guò)程

首先我先用vue2-admin-cli——我自己做的腳手架工具，創(chuàng)建兩個(gè)vue-admin項(xiàng)目來(lái)演示，一個(gè)作為qiankun基座，另外一個(gè)就是我要引用的子應(yīng)用。

全局安裝腳手架
npm install -g vue2-admin-cli 
or
yarn global add vue2-admin-cli
創(chuàng)建項(xiàng)目
vue2-admin-cli init <project_name>
安裝依賴(lài)
yarn
啟動(dòng)項(xiàng)目
yarn serve

運(yùn)行起來(lái)就是這樣的

現(xiàn)在我們開(kāi)始分別改造基座qiankun-base和子應(yīng)用qiankun-vue，我想達(dá)到的效果是主應(yīng)用qiankun-base只保留header sider footer的一個(gè)基本layout的布局，content部分全部加載子應(yīng)用

qiankun-base

yarn add qiankun # 或者 npm i qiankun -S

修改package.json啟動(dòng)命令修改啟動(dòng)端口

"serve": "vue-cli-service serve --port 80 --open"

src/router/index.ts修改路由模式為history

const createRouter = () =>
  new VueRouter({
    mode: "history",
    routes: routes as any,
  });

修改vue.config.js 我這里之前用的路由模式是hash 上線配置了publicPath 導(dǎo)致改為history以后靜態(tài)資源加載路徑有問(wèn)題所以修改

module.exports = {
  // publicPath: "./",  
  devServer: {
    disableHostCheck: true, // 關(guān)閉host檢查
  },
};

在入口文件src/main.ts下注冊(cè)微應(yīng)用并啟動(dòng)：

import { registerMicroApps, start } from "qiankun";
registerMicroApps([
  {
    name: "qiankunVue",
    entry: "http://localhost:8080", //子應(yīng)用的啟動(dòng)端口修改為8080，基座使用80，不要相同
    container: "#qiankunVue",  //加載子應(yīng)用的容器
    activeRule: "/qiankunVue", //路由匹配規(guī)則
  },
]);
// 啟動(dòng) qiankun
start();

在你要放置子應(yīng)用的位置增加一個(gè)容器用于加載子應(yīng)用

src/components/layout/index.vue

<template>
  <el-container direction="vertical" style="height: 100%">
    <Header />
    <el-container style="overflow: auto">
      <el-aside width="250px">
        <Menu />
      </el-aside>
      <el-main>
        <el-breadcrumb
          separator-class="el-icon-arrow-right"
          v-if="showBreadcrumb"
        >
          <template v-for="(route, index) in matchedRoutes">
            <el-breadcrumb-item
              v-if="
                (route.meta && route.meta.breadcrumbTo === false) ||
                index === matchedRoutes.length - 1
              "
              :key="route.path"
            >
              {{ route.meta.title }}
            </el-breadcrumb-item>
            <el-breadcrumb-item
              v-else
              :key="route.path"
              :to="{ path: route.path }"
            >
              {{ route.meta.title }}
            </el-breadcrumb-item>
          </template>
        </el-breadcrumb>
        <!-- 本身的路由加載 -->
        <router-view style="margin-top: 20px" />
        <!-- 子應(yīng)用加載容器 -->
        <div id="qiankunVue" style="width: 100%; height: 100%" />
      </el-main>
    </el-container>
  </el-container>
</template>

將主應(yīng)用之前的路由配置進(jìn)行修改，不渲染自己的內(nèi)容了，因?yàn)橐某扇ゼ虞d子應(yīng)用的內(nèi)容才是我們想要的,我的左側(cè)菜單欄sider也是用路由配置這份文件生成的，所以我只需要注釋這些路由要渲染的components就行，讓他只充當(dāng)一個(gè)生成sider菜單欄的作用，但是注意要保留容器所在的layout，因?yàn)槲业淖討?yīng)用加載容器在這里面，加載子應(yīng)用之前你必須保證容器被加載了

src/router/config.ts

const routes: Array<IBaseRouter> = [
  {
    path: "/",
    redirect: "/home",
    hidden: true,
  },
  {
    path: "/login",
    name: "login",
    hidden: true,
    component: () => import("../views/Login.vue"),
  },
  //保證子應(yīng)用加載時(shí)容器頁(yè)面必須加載
   {
    path: "/qiankunVue/*",
    name: "qiankunVue",
    hidden: true,
    component: Layout,
  },
  {
    path: "/qiankunVue/home",
    name: "home",
    component: Layout,
    redirect: "/qiankunVue/home/index",
    meta: {
      title: "首頁(yè)",
      icon: "el-icon-s-home",
    },
    children: [
      {
        path: "index",
        name: "index",
        hidden: true,
        // component: () => import("../views/Home.vue"),
        meta: {
          title: "首頁(yè)",
          breadcrumb: false,
        },
      },
      {
        path: "bar/:width/:height",
        name: "bar",
        props: true,
        hidden: true,
        // component: () => import("@/components/echarts/Bar.vue"),
        meta: {
          title: "柱狀圖",
          activeMenu: "/home/index",
        },
      },
      {
        path: "pie/:width/:height",
        name: "pie",
        props: true,
        hidden: true,
        // component: () => import("@/components/echarts/Pie.vue"),
        meta: {
          title: "餅圖",
          activeMenu: "/home/index",
        },
      },
      {
        path: "line/:width/:height",
        name: "line",
        props: true,
        hidden: true,
        // component: () => import("@/components/echarts/Line.vue"),
        meta: {
          title: "折線圖",
          activeMenu: "/home/index",
        },
      },
    ],
  },
  .....
  {
    path: "*",
    redirect: "/error/404",
    hidden: true,
  },
];
export default routes;

改完之后刷新看一看，這樣基座項(xiàng)目就改造好了，保留了基本頁(yè)面的框架，中間的內(nèi)容到時(shí)候都由子應(yīng)用來(lái)填充就行了

qiankun-vue

修改package.json啟動(dòng)命令修改啟動(dòng)端口

"serve": "vue-cli-service serve --port 8080 --open"

入口文件 src/main.ts 修改

let vm: any = null;
function render(props: any = {}) {
  const { container } = props;
  vm = new Vue({
    router,
    store,
    render: (h) => h(App),
  }).$mount(container ? container.querySelector("#app") : "#app");
}
// 在被qiankun引用時(shí) 修改運(yùn)行時(shí)的 `publicPath`
if ((window as any).__POWERED_BY_QIANKUN__) { 
  __webpack_public_path__ = (window as any).__INJECTED_PUBLIC_PATH_BY_QIANKUN__;
}
// 獨(dú)立運(yùn)行時(shí)
if (!(window as any).__POWERED_BY_QIANKUN__) {
  render();
}
導(dǎo)出三個(gè)生命周期函數(shù)
export async function bootstrap() {
  console.log("[vue] vue app bootstraped");
}
export async function mount(props: any) {
  console.log("[vue] props from main framework", props);
  render(props);
}
export async function unmount() {
  vm.$destroy();
  vm.$el.innerHTML = "";
  vm = null;
}
export default vm;

src/router/index.ts修改路由模式并增加base（和主應(yīng)用設(shè)置的activeRule一致）

const createRouter = () =>
  new VueRouter({
    mode: "history",
    base: "/qiankunVue",
    routes: routes as any
  });

打包配置修改（`vue.config.js`）

module.exports = {
  devServer: {
    disableHostCheck: true, // 關(guān)閉host檢查
    headers: {
      "Access-Control-Allow-Origin": "*", // 防止加載時(shí)跨域
    },
  },
  configureWebpack: {
    output: {
      library: "qiankunVue",
      libraryTarget: "umd", // 把微應(yīng)用打包成 umd 庫(kù)格式
    },
  },
};

基座和子應(yīng)用都修改完以后刷新看看，控制臺(tái)報(bào)錯(cuò)了

立馬查看官方文檔，發(fā)現(xiàn)是因?yàn)槲业淖討?yīng)用加載容器在基座的某個(gè)路由頁(yè)面即我的layout里面，文檔里指出必須保證微應(yīng)用加載時(shí)主應(yīng)用這個(gè)路由頁(yè)面也加載了，就很喜歡這種文檔????，于是立馬改一改

注釋之前qiankun-base注冊(cè)子應(yīng)用時(shí)的啟動(dòng)qiankun命令，改到路由頁(yè)面layout里面啟動(dòng)
src/main.ts

// 啟動(dòng) qiankun
//start();
src/components/layout/index.vue
import { start } from "qiankun";
 mounted() {
    if (!(window as any).qiankunStarted) {
      (window as any).qiankunStarted = true;
      start();
    }
  }

重新刷新看看，成功了????，多少有點(diǎn)舒服了

接下來(lái)要做的就是把子應(yīng)用再改造一下，在qiankun中就只需要展示子應(yīng)用content的內(nèi)容，單獨(dú)運(yùn)行的時(shí)候?yàn)榱朔奖阏{(diào)試我們就保留layout布局?？戳诉@么久的官方文檔，我當(dāng)然知道用它就可以做出判斷__POWERED_BY_QIANKUN__，思路很清晰，沖他????

qiankun-vue

src/components/layout/index.vue

<template>
  <el-container direction="vertical" v-if="isQiankun">
    <el-main>
      <el-breadcrumb
        separator-class="el-icon-arrow-right"
        v-if="showBreadcrumb"
      >
        <template v-for="(route, index) in matchedRoutes">
          <el-breadcrumb-item
            v-if="
              (route.meta && route.meta.breadcrumbTo === false) ||
              index === matchedRoutes.length - 1
            "
            :key="route.path"
          >
            {{ route.meta.title }}
            <!-- {{ route.path }} -->
          </el-breadcrumb-item>
          <el-breadcrumb-item
            v-else
            :key="route.path"
            :to="{ path: route.path }"
          >
            {{ route.meta.title }}
            <!-- {{ route.path }} -->
          </el-breadcrumb-item>
        </template>
      </el-breadcrumb>
      <router-view style="margin-top: 20px" />
    </el-main>
  </el-container>
  <el-container direction="vertical" style="height: 100%" v-else>
    <Header />
    <el-container style="overflow: auto">
      <el-aside width="250px">
        <Menu />
      </el-aside>
      <el-main>
        <el-breadcrumb
          separator-class="el-icon-arrow-right"
          v-if="showBreadcrumb"
        >
          <template v-for="(route, index) in matchedRoutes">
            <el-breadcrumb-item
              v-if="
                (route.meta && route.meta.breadcrumbTo === false) ||
                index === matchedRoutes.length - 1
              "
              :key="route.path"
            >
              {{ route.meta.title }}
              <!-- {{ route.path }} -->
            </el-breadcrumb-item>
            <el-breadcrumb-item
              v-else
              :key="route.path"
              :to="{ path: route.path }"
            >
              {{ route.meta.title }}
              <!-- {{ route.path }} -->
            </el-breadcrumb-item>
          </template>
        </el-breadcrumb>
        <router-view style="margin-top: 20px" />
      </el-main>
    </el-container>
  </el-container>
</template>
<script lang="ts">
import { Vue, Component } from "vue-property-decorator";
import Header from "./Header.vue";
import Menu from "./Menu.vue";
// import { IBaseRouter } from "@/router/config";
@Component({
  name: "Layout",
  components: { Header, Menu },
})
export default class Layout extends Vue {
  private get showBreadcrumb() {
    return this.$route?.meta?.breadcrumbAll !== false;
  }
  private get matchedRoutes() {
    return this.$route.matched?.filter(
      (v) => v.meta?.title && v?.meta?.breadcrumb !== false
    );
  }
  private get isQiankun() {
    return (window as any).__POWERED_BY_QIANKUN__;
  }
}
</script>
<style lang="less" scoped></style>

至此完結(jié)撒花，改造結(jié)束????，看看效果基座正常展示子應(yīng)用