基於 Webpack5 Module Federation 的業務解耦實踐

来源:https://www.cnblogs.com/dtux/archive/2023/12/13/17898758.html
-Advertisement-
Play Games

我們是袋鼠雲數棧 UED 團隊，致力於打造優秀的一站式數據中台產品。我們始終保持工匠精神，探索前端道路，為社區積累並傳播經驗價值。 本文作者：貝兒 前言 本文中會提到很多目前數棧中使用的特定名詞，統一做下解釋描述 dt-common：每個子產品都會引入的公共包(類似 NPM 包) AppMenus： ...


我們是袋鼠雲數棧 UED 團隊，致力於打造優秀的一站式數據中台產品。我們始終保持工匠精神，探索前端道路，為社區積累並傳播經驗價值。

本文作者：貝兒

前言

本文中會提到很多目前數棧中使用的特定名詞，統一做下解釋描述

  • dt-common：每個子產品都會引入的公共包(類似 NPM 包)
  • AppMenus：在子產品中快速進入到其他子產品的導航欄，統一維護在 dt-common 中，子產品從 dt-common 中引入
  • Portal：所有子產品的統一入口
  • APP_CONF：子產品的一些配置信息存放

背景

由於迭代中，我們有很多需求都是針對 AppMenus 的，這些需求的生效需要各個子產品的配合，進行統一變更。現在的數棧前端的項目當中， AppMenus 的相關邏輯存在於 dt-common 中，dt-common 又以獨立的目錄存在於每個子項目中， 所以當出現這種需求的時候，變更的分支就包含所有的子產品，這給前端以及測試同學都帶來很多重覆性的工作。

file

本文旨在通過 webpack5 Module Federation 的實踐，實現 AppMenus 與各個子產品的解耦，即 AppMenus 作為共用資源，將其從 dt-common 中分離出來，保證其更新部署無需其他子產品的配合。

file

本地實現

Portal 項目

  1. 拆分 AppMenus 到 Portal 下的 Components 中，Portal 內部引用 AppMenus 就是正常組件內部的引用
  2. 配置 Module Federation 相關配置，方便其他項目進行遠程依賴
const federationConfig = {
        name: 'portal',
        filename: 'remoteEntry.js',
        // 當前組件需要暴露出去的組件
        exposes: {
            './AppMenus': './src/views/components/app-menus',
        },
        shared: {
            react: { 
               singleton: true,
               eager: true, 
               requiredVersion: deps.react
            },
            'react-dom': {
                singleton: true,
                eager: true,
                requiredVersion: deps['react-dom'],
            },
        },
    };

    const plugins = [
        ...baseKoConfig.plugins,
        {
            key: 'WebpackPlugin',
            action: 'add',
            opts: {
                name: 'ModuleFederationPlugin',
                fn: () => new ModuleFederationPlugin({ ...federationConfig }),
            },
        },
    ].filter(Boolean);
  1. dt-common 中修改 Navigator 組件引用 AppMenus 的方式，通過 props.children 實現

子產品項目

  1. 配置 Module Federation config
const federationConfig = {
    name: 'xxx',
    filename: 'remoteEntry.js',
    // 關聯需要引入的其他應用
    remotes: {
        // 本地相互訪問採取該方式
        portal: 'portal@http://127.0.0.1:8081/portal/remoteEntry.js',
    },
    shared: {
        antd: {
            singleton: true,
            eager: true,
            requiredVersion: deps.antd,
        },
        react: {
            singleton: true,
            eager: true,
            requiredVersion: deps.react,
        },
        'react-dom': {
            singleton: true,
            eager: true,
            requiredVersion: deps['react-dom'],
        },
    },
};
  1. 修改 AppMenus 引用方式
const AppMenus = React.lazy(() => import('portal/AppMenus'));
<Navigator
    {...this.props}
>
    <React.Suspense fallback="loading">
        <AppMenus {...this.props} />
    </React.Suspense>
</Navigator>

// 需要 ts 定義 
// typings/app.d.ts 文件
declare module 'portal/AppMenus' {
    const AppMenus: React.ComponentType<any>;
    export default AppMenus;
}
  1. 註意本地調試的時候，子產品中需要代理 Portal 的訪問路徑到 Portal 服務的埠下，才能訪問 Portal 暴露出來的組件的相關chunckjs
module.exports = {
    proxy: {
        '/portal': {
            target: 'http://127.0.0.1:8081', // 本地
            //target: 'portal 對應的地址', 本地 -〉 devops 環境
            changeOrigin: true,
            secure: false,
            onProxyReq: ProxyReq,
       },
    }
}

遠程部署

部署到伺服器上，由於 Portal 項目中的 AppMenus 相當於是遠程組件，即共用依賴；子產品為宿主環境，所以部署的時候需要對應部署 Portal 項目與子產品。而在上述配置中，需要變更的是載入的地址。 Portal 項目中沒有需要變更的，變更的是子產品中的相關邏輯。

//remote.tsx 
import React from 'react';

function loadComponent(scope, module) {
    return async () => {
        // Initializes the share scope. This fills it with known provided modules from this build and all remotes
        await __webpack_init_sharing__('default');
        const container = window[scope]; // or get the container somewhere else
        // Initialize the container, it may provide shared modules
        await container.init(__webpack_share_scopes__.default);
        const factory = await window[scope].get(module);
        const Module = factory();
        return Module;
    };
}

const urlCache = new Set();
const useDynamicScript = (url) => {
    const [ready, setReady] = React.useState(false);
    const [errorLoading, setErrorLoading] = React.useState(false);

    React.useEffect(() => {
        if (!url) return;

        if (urlCache.has(url)) {
            setReady(true);
            setErrorLoading(false);
            return;
        }

        setReady(false);
        setErrorLoading(false);

        const element = document.createElement('script');

        element.src = url;
        element.type = 'text/javascript';
        element.async = true;

        element.onload = () => {
            console.log('onload');
            urlCache.add(url);
            setReady(true);
        };

        element.onerror = () => {
            console.log('error');
            setReady(false);
            setErrorLoading(true);
        };

        document.head.appendChild(element);

        return () => {
            urlCache.delete(url);
            document.head.removeChild(element);
        };
    }, [url]);

    return {
        errorLoading,
        ready,
    };
};

const componentCache = new Map();

export const useFederatedComponent = (remoteUrl, scope, module) => {
    const key = `${remoteUrl}-${scope}-${module}`;
    const [Component, setComponent] = React.useState(null);

    const { ready, errorLoading } = useDynamicScript(remoteUrl);
    React.useEffect(() => {
        if (Component) setComponent(null);
        // Only recalculate when key changes
    }, [key]);

    React.useEffect(() => {
        if (ready && !Component) {
            const Comp = React.lazy(loadComponent(scope, module));
            componentCache.set(key, Comp);
            setComponent(Comp);
        }
        // key includes all dependencies (scope/module)
    }, [Component, ready, key]);

    return { errorLoading, Component };
};

//layout header.tsx
const Header = () => {
	....
	const url = `${window.APP_CONF?.remoteApp}/portal/remoteEntry.js`;
  const scope = 'portal';
  const module = './AppMenus'
	const { Component: FederatedComponent, errorLoading } = useFederatedComponent(
      url,
      scope,
      module
  );
	return (
        <Navigator logo={<Logo />} menuItems={menuItems} licenseApps={licenseApps} {...props}>
            {errorLoading ? (
                <WarningOutlined />
            ) : (
                FederatedComponent && (
                    <React.Suspense fallback={<Spin />}>
                        {<FederatedComponent {...props} top={64} showBackPortal />}
                    </React.Suspense>
                )
            )}
        </Navigator>
    );
}

如何調試

子產品本地 → Portal 本地

Portal 與某個資產同時在不同的埠上運行
Portal 無需變更，子產品需要以下相關的文件
在這種情況下 remoteApp 為本地啟動的 portal 項目本地環境；同時當我們啟動項目的時候需要將 /partal 的請求代理到本地環境

// proxy -> 代理修改
// header 引用的遠程地址 -> 修改

window.APP_CONF?.remoteApp = 'http://127.0.0.1:8081'

proxy: {
    '/portal': {
        target: 'http://127.0.0.1:8081'
    }
}

子產品本地 → Portal 的伺服器環境

本地起 console 的服務
伺服器上部署 Portal 對應的 Module Ferderation 分支
同上，只不過此時 Portal 已經部署了，remote 和代理地址只需要改成部署後的 Portal 地址即可

// proxy -> 代理修改
// header 引用的遠程地址 -> 修改

window.APP_CONF?.remoteApp = 'xxx'

proxy: {
    '/portal': {
        target: 'xxx'
    }
}

子產品伺服器環境 → Portal 的伺服器環境

子產品 && Portal 分別部署到伺服器環境上
修改子產品的 config 的配置 ，添加 window.APP_CONF.remoteApp 到 Portal 的伺服器環境

異常處理

  1. 當 Portal 部署不當，或者是版本不對應的時候，沒有 AppMenus 遠程暴露出來的話， 做了異常處理思路是： 當請求 remoteEntry.js 出現 error 的時候，是不會展示 AppMenus 相關組件的
  2. 當 Portal 已經部署，其他子產品未接入 Module Federation， 是不會影響到子產品的正常展示的；子產品當下使用的 應是 dt-common 中的 AppMenus

如何開發 AppMenus

file

問題記錄

依賴版本不一致

【Error】Could not find "store" in either the context or props of "Connect(N)". Either wrap the root component in a <Provider>, or explicitly pass "store" as a prop to "Connect(N)".

file

發現報錯路徑為 portal/xxx，可以定位到是 AppMunes 發生了問題，導致原因數產品 React-Redux 和 Portal React-Redux 版本不一致導致的，需要在對應子產品 federationConfig 處理 react-redux 為共用

總結

本文主要從業務層面結合 webpack 5 Module Federation ，實現 AppMenus 的解耦問題。主要涉及 dt-common 、Portal、子產品的變更。通過解耦能夠發現我們對 AppMenus 的開發流程減少了不少，有效的提高了我們的效率。

最後

歡迎關註【袋鼠雲數棧UED團隊】~
袋鼠雲數棧UED團隊持續為廣大開發者分享技術成果，相繼參與開源了歡迎star


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 企業如何通過熔斷降級增強服務穩定性和系統可用性？
    API 的調用穩定性被視為數據服務的最重要的指標。該指標的影響因素是多種多樣的，「袋鼠雲數據服務平臺 DataAPI」不僅多次對於調用性能和穩定性進行壓測和調優，而且還提供了多種配置項優化手段供客戶進行自行調優。但是當遇到不可預期的大流量或其他突然情況時還是會遇到 API 調用失敗的情況。 當隨著流 ...
  • 故障解析丨導入字元串NULL導致主從報錯
    1.背景概述 目前需要搭建一個從庫，由於單表數據量較大，時間比較有限，考慮到導入導出的時間，並且GreatSQL支持並行load data的功能，能夠加速數據的導入，因此決定使用 select into outfile 和 load data 的方式進行數據的遷移； 在數據導入完成後進行數據同步，從 ...
  • [20231207]開發不應該這樣寫sql4.txt
    原文地址：https://www.soughttech.com/front/article/7159/viewArticle 今天我偶然看到了參數slave_exec_mode。從手冊中的描述可以看出，該參數與MySQL複製有關。它是一個可以動態修改的變數。預設為STRICT mode(嚴格模式)， ...
  • 第一個“hello Android”程式
    1、首先安裝Android studio（跳過） Android Studio是由Google推出的官方集成開發環境（IDE），專門用於Android應用程式的開發。它是基於JetBrains的IntelliJ IDEA IDE構建的，提供了豐富的功能和工具，方便開發者創建、測試、調試和發佈Andr ...
  • Android MaterialButtonToggleGroup使用
    原文地址: Android MaterialButtonToggleGroup使用 - Stars-One的雜貨小窩 覺得單選框不好看,發現了一個Material里的單選按鈕組,感覺UI還不錯,記下使用 使用 效果: 使用前,得看看是否有material的依賴,如 implementation 'c ...
  • Chrome擴展的核心：manifest 文件（上）
    Chrome 在全球瀏覽器市場份額獨占 6 成，無論是對普通用戶還是開發者，都是電腦里的必備利器。Chrome 無論是在性能還是 UI 交互方面都非常出色，而 Chrome 擴展則為開發者提供了介面，讓開發者有能力自己編寫代碼使自己的 Chrome 更強大，更加定製化。 ...
  • 記錄--7個Js async/await高級用法
    這裡給大家分享我在網上總結出來的一些知識，希望對大家有所幫助 7個Js async/await高級用法 JavaScript的非同步編程已經從回調(Callback)演進到Promise，再到如今廣泛使用的async/await語法。後者不僅讓非同步代碼更加簡潔，而且更貼近同步代碼的邏輯與結構，大大增強 ...
  • 使用element 2.14 實現表格虛擬滾動組件
    下述代碼為組件實現代碼複製即可食用,預設只展示 一屏數據加兩條 全選存在些許問題, 使用row-key時,如果行過多滾動時會不會很流暢 特別需要註意的是 行高必須要保持一致 <template> <div class="t-table" :id="TTableId"> <el-table ref=" ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類