最新 umi4-max 如何使用 webpack5 聯邦模塊

新項目用 umi4-max 搭建，部分功能想要使用其他項目的功能，不想重新開發，想到了使用 webpack5 的聯邦模塊，可以直接引用其他項目代碼來實現共享代碼。

理想很美好，現實很殘酷。直接按照 webpack5 聯邦模塊的使用方法，並不能成功，而官方文檔沒有明確說明如何使用。

webpack 聯邦模塊如何使用呢？

理解：

• 使用場景：項目A有一個功能，項目B也想用。此時可以用。
• 使用前提：依賴 webpack5，且主要依賴相同（如都依賴react)

說明：項目A需要用項目B的代碼，項目A爲導入項目，項目B爲導出項目。

相關配置字段說明：

字段名	類型	含義
name	string	必傳值，即輸出的模塊名，被遠程引用時路徑爲 name/{name}/name/
library	string	聲明全局變量的方式，name 爲 umd 的 name
filename	string	構建輸出的文件名
remotes	object	遠程引用的應用名及其別名的映射，使用時以 key 值作爲 name
exposes	object	被遠程引用時可暴露的資源路徑及其別名
shared	object	與其他應用之間可以共享的第三方依賴，使你的代碼中不用重複加載同一份依賴

1. 普通項目

1.1 導出項目

配置要導出的功能模塊

// 配置文件

const { ModuleFederationPlugin } = require("webpack").container;
const packageDeps = require('../package.json').dependencies

new ModuleFederationPlugin({
  name: "app1",
  filename: "remoteEntry.js",
  // 表示導出的模塊，只有在此申明的模塊纔可以作爲遠程依賴被使用。
  exposes: {
    "./CounterAppOne": "./src/components/CounterAppOne",
  },
  shared: {
    ...packageDeps,
    react: { singleton: true, eager: true, requiredVersion: deps.react },
    "react-dom": {
      singleton: true,
      eager: true,
      requiredVersion: deps["react-dom"],
    },
    "react-router-dom": {
      singleton: true,
      eager: true,
      requiredVersion: deps["react-router-dom"],
    },
  },
})

1.2 導入項目

配置要導入的功能模塊的文件地址

// 配置文件

const { ModuleFederationPlugin } = require("webpack").container;
const packageDeps = require('../package.json').dependencies

new ModuleFederationPlugin({
  name: "container",
  // 將其它項目的 name 映射到當前項目中
  remotes: {
    app1: 'app1@http://localhost:3001/remoteEntry.js',
  },
  // 是非常重要的參數，制定了這個參數，可以讓遠程加載的模塊對應依賴改爲使用本地項目的 React 或 ReactDOM。
  shared: {
    ...packageDeps,
    react: { singleton: true, eager: true, requiredVersion: deps.react },
    "react-dom": {
      singleton: true,
      eager: true,
      requiredVersion: deps["react-dom"],
    },
    "react-router-dom": {
      singleton: true,
      eager: true,
      requiredVersion: deps["react-router-dom"],
    },
  },
})

react 項目中使用

// 通過 webpack 關聯其它應用，然後按需加載
const CounterAppOne = React.lazy(() => import("app1/CounterAppOne"))

export default () => {
  return (
  	<React.Suspense fallback={<div>Loading</div>}>
      <CounterAppOne />
    </React.Suspense>
  )
}

2. umi3 項目

2.1 導出項目

配置

// .umirc.ts

publicPath:'http://127.0.0.1:5502/',
webpack5: {}, // 開啓 webpack5 
chainWebpack: (config) => {
  config.output.publicPath('auto'); // 路徑處理，保證導入項目路徑正確

  const { ModuleFederationPlugin } = require("webpack").container;
  const packageDeps = require('./package.json').dependencies

  config.plugin('mf').use(ModuleFederationPlugin, [{
    name: "app1",
    filename: 'remoteEntry.js',
    exposes: {
      "./Test": '@/pages/test.tsx',
    },
    shared: { react: { eager: true }, "react-dom": { eager: true } },
  }])
  return config;
}

2.2 導入項目

安裝插件：yarn install umi-plugin-mf-bootstrap 支持入口異步導入，以便支持使用 hooks。如果不安裝，會報錯 Uncaught Error: Shared module is not available for eager consumption。具體原因爲：違背了 hooks 的使用規則，不能用兩個 React 實例。

插件內容：

import { IApi } from 'umi';
import { resolve } from 'path';
import { readFileSync } from 'fs';

export default (api: IApi) => {

  api.onGenerateFiles(() => {
    const buffer= readFileSync(resolve('./src/.umi/umi.ts'))
    const c = String(buffer)
    // console.log()
    api.writeTmpFile({
      path: 'index.ts',
      content: c,
    });
    api.writeTmpFile({
      path: 'umi.ts',
      content: 'import("./index")',
    });
  });
};

配置

// .umirc.ts

dynamicImport:{},
webpack5: {}, // 開啓 webpack5
chainWebpack: (config) => {
  const { ModuleFederationPlugin } = require("webpack").container;
  config.plugin('mf').use(ModuleFederationPlugin, [{
    name: "app2",
    remotes: {
      "app1": "app1@http://127.0.0.1:5502/dist/remoteEntry.js",
    },
    shared: { react: { eager: true }, "react-dom": { eager: true } },
  }])
  return config;
}

使用和普通項目一致

3. umi4-max 項目

按照 umi3 的方案，沒有成功。多方查閱摸索後，最終通過查閱官方 github 代碼，看到有個插件中有個 mf 的文件，閱讀代碼後，摸索出最終的方案了。

導出項目配置和 umi3 的一致，而導入項目只需按照下面的配置即可，使用和普通項目一致。

// .umirc.ts

mf: {
  name: 'app2',
  remotes: [
    {
      name: 'app1',
      entry: 'http://127.0.0.1:5502/dist/remoteEntry.js'
    },
  ],
  shared: { react: { eager: true }, "react-dom": { eager: true } },
}

關於 mf 插件的詳細使用：可參考官方 github 代碼 Module Federation 插件，後來找到的。

其他相關實現：

• 源碼 mf 插件實現 mf
• 源碼 mfsu mf實現 MFImport

4. vite 項目

安裝插件 vite-plugin-federation

4.1 導出項目

配置

// vite.config.js 或 rollup.config.js

import federation from "@originjs/vite-plugin-federation";
export default {
  plugins: [
    federation({
      name: "remote-app",
      filename: "remoteEntry.js",
      // 需要暴露的模塊
      exposes: {
        "./Button": "./src/Button.vue",
      },
      shared: ["vue"],
    }),
  ],
};

4.2 導入項目

配置

// vite.config.js 或 rollup.config.js

import federation from "@originjs/vite-plugin-federation";
export default {
  plugins: [
    federation({
      name: "host-app",
      remotes: {
        remote_app: "http://localhost:5001/assets/remoteEntry.js",
      },
      shared: ["vue"],
    }),
  ],
};

react 項目中使用

// dynamic import
const myButton = React.lazy(() => import('remote/myButton'))

// static import
import myButton from 'remote/myButton'

備註：React 使用 federation 問題解決：

建議查看這個 Issue，裏面包含了大多數 React 相關的問題

常見問題：遠程模塊加載本地模塊的共享依賴失敗，報錯:

localhost/:1 Uncaught (in promise) TypeError: Failed to fetch dynamically imported module: http:your url

原因：Vite 在啓動服務時對於 IP、Port 有自動獲取邏輯，在 Plugin 中還沒有找到完全對應的獲取邏輯，在部分情況下可能會出現獲取失敗。

解決：

在本地模塊顯式到聲明 IP、Port、cacheDir，保證我們的 Plugin 可以正確的獲取和傳遞依賴的地址。

// 本地模塊的 vite.config.ts

export default defineConfig({
  server:{
    https: "http",
    host: "192.168.56.1",
    port: 5100,
  },
  cacheDir: "node_modules/.cacheDir",
}

建議閱讀：

• vite-plugin-federation 詳細設計
• Webpack 5 Module Federation: JavaScript 架構的變革者
• 三大應用場景調研，Webpack 新功能 Module Federation 深入解析

參考：

• 問題解決 Webpack 模塊聯合不適用於急切的共享庫
• 實現案例 webpack-module-fedaration-sandbox
• umi3 使用聯邦模塊 Umi使用webpack5 Module Federation