当前位置：首页 > ds >正文

Webpack 5 Module Federation 深度解析

ds 2025/7/4 23:52:59

Module Federation 深度解析

摘要
Module Federation 是 Webpack 5 引入的一项革命性功能，让不同编译产物之间可以相互暴露与消费模块，实现微前端与微模块的按需加载、共享依赖和灰度发布。本文将从背景、核心原理、配置示例、进阶特性及实战建议等角度，全方位介绍 Module Federation。

背景与动机

随着前端工程的不断膨胀，以下痛点日益凸显：

构建臃肿：大型单体应用常常需要几十秒甚至几分钟才能打包完成。
共享逻辑难：跨项目重用组件或工具库，需要发布 npm 包，走完整的发版流程。
版本不易灰度：一旦线上有问题，需要整包回滚，无法对单个模块进行灰度发布。
多仓协作成本高：多个团队维护各自项目，公共依赖版本混乱，升级麻烦。

Webpack 5 的 Module Federation 正是为了解决这些问题而生：它打破了「构建期捆绑、运行期整体部署」的局限，实现了「运行期动态加载、共享依赖、按需灰度」的新范式。

核心概念

Host（主应用）：Consumer，负责加载并使用远程模块。
Remote（子应用）：Exposer，暴露自己的模块给 Host 或其他 Remote。
Shared（共享依赖）：声明可被多端共享的包，避免重复打包。
Container：运行时暴露的入口文件，通过 remoteEntry.js 暴露模块和版本元数据。

工作原理

构建期
- Host 与 Remote 分别在各自的 Webpack 配置里添加 ModuleFederationPlugin。
- Remote 通过 exposes 指定要暴露的模块；Host 通过 remotes 指定要消费的远程入口。
- Webpack 在构建时生成 remoteEntry.js，其中包含模块元数据、依赖图、版本号等信息。
运行期
- Host 加载时，会动态 <script src="远程 remoteEntry.js">，注册远程容器。
- 通过 __webpack_init_sharing__ 与 __webpack_share_scopes__ 初始化共享依赖环境。
- 运行 container.get(模块路径) 获取远程模块的 factory，再执行 factory，得到模块实例。
- 共享依赖首次加载后，被缓存并复用，实现去重。

配置示例

主应用（Host）Webpack 配置

// webpack.config.js
const { ModuleFederationPlugin } = require("webpack").container;module.exports = {// ...其他配置plugins: [new ModuleFederationPlugin({name: "hostApp",remotes: {// 命名为 remoteAppremoteApp: "remoteApp@http://localhost:3001/remoteEntry.js"},shared: {react: { singleton: true, requiredVersion: "^17.0.0" },"react-dom": { singleton: true, requiredVersion: "^17.0.0" }}})]
};

在主应用中引入远程模块：

import React from "react";
const RemoteButton = React.lazy(() => import("remoteApp/Button"));export default function App() {return (<React.Suspense fallback="Loading..."><RemoteButton /></React.Suspense>);
}

子应用（Remote）Webpack 配置

// webpack.config.js
const { ModuleFederationPlugin } = require("webpack").container;module.exports = {// ...其他配置plugins: [new ModuleFederationPlugin({name: "remoteApp",filename: "remoteEntry.js",exposes: {"./Button": "./src/components/Button"},shared: {react: { singleton: true, eager: true },"react-dom": { singleton: true, eager: true }}})]
};

在子应用中，一个简单的 Button 组件：

// src/components/Button.jsx
import React from "react";export default function Button() {return <button>远程按钮</button>;
}

进阶特性

共享依赖（Shared）

singleton：同库只会加载一次，确保 Host 与 Remote 使用同一实例。
eager：提前加载共享依赖到入口，避免首次请求新脚本时延迟。
strictVersion：开启版本校验，避免加载到不兼容版本。

示例：

shared: {lodash: { singleton: true, strictVersion: true, requiredVersion: "^4.17.0" }
}

动态远程加载（Dynamic Remotes）

当远程入口 URL 需要在运行时才确定时，可用以下写法：

remotes: {dynamicRemote: `promise new Promise(resolve => {const url = window.getRemoteUrl(); // 自定义逻辑const script = document.createElement("script");script.src = url + "/remoteEntry.js";script.onload = () => resolve(window.dynamicRemote);document.head.appendChild(script);})`
}

优势与局限

优势	局限
- 按需加载：减小首屏体积 - 共享依赖：避免重复打包 - 运行期灰度：秒级上线与回滚 - 团队协作：跨仓/跨项目复用	- 学习曲线：需要理解容器与共享机制 - 调试成本：异步加载与作用域管理 - 构建体积：如果 shared 过多，配置复杂