Webpack 模块联合不适用于急切的共享库
Webpack module federation is not working with eager shared libs
我正在研究 Webpack 5 模块联合功能,但很难理解为什么我的代码不起作用。
这个想法与标准模块联合示例所做的非常相似:
app1
- 是主机应用
app2
- 是一个将整个应用程序暴露给 app1
的遥控器
(app1
呈现 header 和水平线,在其下方应呈现 app2
)
app1
和 app2
都将 react
和 react-dom
声明为它们在 weback.config.js
:
中共享的、单例的、急切的依赖项
// app1 webpack.config.js
module.exports = {
entry: path.resolve(SRC_DIR, './index.js');,
...
plugins: [
new ModuleFederationPlugin({
name: "app1",
remotes: {
app2: `app2@//localhost:2002/remoteEntry.js`,
},
shared: { react: { singleton: true, eager: true }, "react-dom": { singleton: true, eager: true } },
}),
...
],
};
// app2 webpack.config.js
module.exports = {
entry: path.resolve(SRC_DIR, './index.js');,
...
plugins: [
new ModuleFederationPlugin({
name: "app2",
library: { type: "var", name: "app2" },
filename: "remoteEntry.js",
exposes: {
"./App": "./src/App",
},
shared: { react: { singleton: true, eager: true }, "react-dom": { singleton: true, eager: true } },
}),
...
],
};
在 App1 index.js 我有下一个代码:
import React from "react";
import ReactDOM from "react-dom";
import App from "./App";
ReactDOM.render(<App />, document.getElementById("root"));
App1 App.js
组件是下一个:
import React, { Suspense } from 'react';
const RemoteApp2 = React.lazy(() => import("app2/App"));
export default function App() {
return (
<div>
<h1>App 1</h1>
<p>Below will be some content</p>
<hr/>
<Suspense fallback={'Loading App 2'}>
<RemoteApp2 />
</Suspense>
</div>
);
}
但是当我启动应用程序时出现下一个错误:
Uncaught Error: Shared module is not available for eager consumption: webpack/sharing/consume/default/react/react?1bb3
at Object.__webpack_modules__.<computed> (consumes:133)
at __webpack_require__ (bootstrap:21)
at fn (hot module replacement:61)
at Module../src/index.js (main.bundle.a8d89941f5dd9a37d429.js:239)
at __webpack_require__ (bootstrap:21)
at startup:4
at startup:6
如果我提取从 index.js
到 bootstrap.js
和 index.js
中的所有内容
import('./bootstrap');
一切正常。
这让我感到困惑,因为创建者 official docs and blog posts 指出您可以采用 bootstrap.js
方式或将依赖声明为急切的方式。
感谢 help/insights 为什么没有 bootstrap.js
模式就无法工作。
这是我正在构建的 link 到完整的 GitHub 沙箱:https://github.com/vovkvlad/webpack-module-fedaration-sandbox/tree/master/simple
为了使其正常工作,您需要更改加载远程条目的方式。
- 在
webpack.config.js
中将 app1 的 ModuleFederationPlugin
配置更新为:
...
new ModuleFederationPlugin({
name: "app1",
remoteType: 'var',
remotes: {
app2: 'app2',
},
shared: {
...packageJsonDeps,
react: { singleton: true, eager: true, requiredVersion: packageJsonDeps.react },
"react-dom": { singleton: true, eager: true, requiredVersion: packageJsonDeps["react-dom"] }
},
}),
...
- 将
script
标记添加到 app1 中 index.html
的 head
:
<script src="http://localhost:2002/remoteEntry.js"></script>
进一步黑客攻击后看起来不错!
更新:
只是为了它:我已经为您的沙盒存储库创建了一个 PR,其中包含上述修复:
https://github.com/vovkvlad/webpack-module-fedaration-sandbox/pull/2
只是为了让那些可能错过对初始答案的评论的人说清楚:
最初失败的主要原因似乎是 remoteEntry.js
文件是在实际 运行 主机应用程序的代码之后加载的。
bootstrap.js
方法和将直接脚本 <script src="http://localhost:2002/remoteEntry.js"></script>
添加到 <head></head>
标记具有完全相同的结果 - 它们使 remoteEntry.js
被加载和解析 之前 主应用程序的代码。
在 bootstrap 的情况下,下一个顺序是:
main_bundle
已加载
- 因为主要代码被提取到
bootstrap.js
文件中 - remoteEntry.js
已加载
bootstrap.js
已加载,实际上 运行 是主应用程序
Oleg Vodolazsky 提出的变体事件顺序是下一个:
remoteEntry.js
首先加载,因为它直接添加到 html
文件,webpack 的 main_bundle
在 remoteEntry link[= 之后附加到 <head></head>
58=]
main_bundle
已加载并且 运行 应用程序
如果只是尝试 运行 没有 bootstrap 且 <head></head>
中没有硬编码脚本的应用程序 main_bundle
在 remoteEntry.js
之前加载并且作为main_bundle
尝试实际 运行 应用程序,但失败并出现错误:
你可以在Module Federation的高级API里面设置依赖为eager,它不会把模块放到一个async chunk中,而是同步提供。这允许我们在初始块中使用这些共享模块。但要小心,因为所有提供的和后备模块将始终被下载。建议仅在应用程序的某一点提供它,例如shell.
Webpack 网站强烈推荐使用异步边界。它将拆分出更大块的初始化代码以避免任何额外的往返并提高总体性能。
例如,您的条目如下所示:
index.js
import React from 'react';
import ReactDOM from 'react-dom';
import App from './App';
ReactDOM.render(<App />, document.getElementById('root'));
让我们创建 bootstrap.js 文件并将条目的内容移动到其中,然后将 bootstrap 导入条目:
index.js
+ import('./bootstrap');
- import React from 'react';
- import ReactDOM from 'react-dom';
- import App from './App';
- ReactDOM.render(<App />, document.getElementById('root'));
bootstrap.js
+ import React from 'react';
+ import ReactDOM from 'react-dom';
+ import App from './App';
+ ReactDOM.render(<App />, document.getElementById('root'));
此方法有效,但可能有局限性或缺点。
通过 ModuleFederationPlugin
为依赖项设置 eager: true
webpack.config.js
// ...
new ModuleFederationPlugin({
shared: {
...deps,
react: {
eager: true,
},
},
});
我在将 NextJS 应用程序用作容器应用程序时也遇到了问题。要知道,我们不得不一次又一次地给 eager 加载。
我采用了与网络上当前技术不同的方式。我为我的远程库使用了动态加载技术,现在似乎没有一次又一次地获取共享模块。它们只被加载一次。此外,我将整个系统实现为框架不可知论者,因此您可以将任何框架用作远程应用程序(angular、vue、react、svelte...)。此外,我将 SSR 逻辑移至远程应用程序部分,因此现在它也可以完全支持任何框架的 SSR。它似乎有效,我想在这里分享我的解决方案以帮助社区。我用示例 Github 回购 link 写了一个中型博客 post。我把我的方法详细说了。
您可以在此处找到详细的 post:https://medium.com/@metinarslanturkk/how-i-implemented-dynamic-loaded-framework-agnostic-microfrontend-app-with-nextjs-and-react-which-620ff3df4298
这是示例回购 link:https://github.com/MetinArslanturk/microfrontend-nextjs-ssr
谢谢,梅廷
我正在研究 Webpack 5 模块联合功能,但很难理解为什么我的代码不起作用。 这个想法与标准模块联合示例所做的非常相似:
app1
- 是主机应用
app2
- 是一个将整个应用程序暴露给 app1
(app1
呈现 header 和水平线,在其下方应呈现 app2
)
app1
和 app2
都将 react
和 react-dom
声明为它们在 weback.config.js
:
// app1 webpack.config.js
module.exports = {
entry: path.resolve(SRC_DIR, './index.js');,
...
plugins: [
new ModuleFederationPlugin({
name: "app1",
remotes: {
app2: `app2@//localhost:2002/remoteEntry.js`,
},
shared: { react: { singleton: true, eager: true }, "react-dom": { singleton: true, eager: true } },
}),
...
],
};
// app2 webpack.config.js
module.exports = {
entry: path.resolve(SRC_DIR, './index.js');,
...
plugins: [
new ModuleFederationPlugin({
name: "app2",
library: { type: "var", name: "app2" },
filename: "remoteEntry.js",
exposes: {
"./App": "./src/App",
},
shared: { react: { singleton: true, eager: true }, "react-dom": { singleton: true, eager: true } },
}),
...
],
};
在 App1 index.js 我有下一个代码:
import React from "react";
import ReactDOM from "react-dom";
import App from "./App";
ReactDOM.render(<App />, document.getElementById("root"));
App1 App.js
组件是下一个:
import React, { Suspense } from 'react';
const RemoteApp2 = React.lazy(() => import("app2/App"));
export default function App() {
return (
<div>
<h1>App 1</h1>
<p>Below will be some content</p>
<hr/>
<Suspense fallback={'Loading App 2'}>
<RemoteApp2 />
</Suspense>
</div>
);
}
但是当我启动应用程序时出现下一个错误:
Uncaught Error: Shared module is not available for eager consumption: webpack/sharing/consume/default/react/react?1bb3
at Object.__webpack_modules__.<computed> (consumes:133)
at __webpack_require__ (bootstrap:21)
at fn (hot module replacement:61)
at Module../src/index.js (main.bundle.a8d89941f5dd9a37d429.js:239)
at __webpack_require__ (bootstrap:21)
at startup:4
at startup:6
如果我提取从 index.js
到 bootstrap.js
和 index.js
中的所有内容
import('./bootstrap');
一切正常。
这让我感到困惑,因为创建者 official docs and blog posts 指出您可以采用 bootstrap.js
方式或将依赖声明为急切的方式。
感谢 help/insights 为什么没有 bootstrap.js
模式就无法工作。
这是我正在构建的 link 到完整的 GitHub 沙箱:https://github.com/vovkvlad/webpack-module-fedaration-sandbox/tree/master/simple
为了使其正常工作,您需要更改加载远程条目的方式。
- 在
webpack.config.js
中将 app1 的ModuleFederationPlugin
配置更新为:
...
new ModuleFederationPlugin({
name: "app1",
remoteType: 'var',
remotes: {
app2: 'app2',
},
shared: {
...packageJsonDeps,
react: { singleton: true, eager: true, requiredVersion: packageJsonDeps.react },
"react-dom": { singleton: true, eager: true, requiredVersion: packageJsonDeps["react-dom"] }
},
}),
...
- 将
script
标记添加到 app1 中index.html
的head
:
<script src="http://localhost:2002/remoteEntry.js"></script>
进一步黑客攻击后看起来不错!
更新:
只是为了它:我已经为您的沙盒存储库创建了一个 PR,其中包含上述修复: https://github.com/vovkvlad/webpack-module-fedaration-sandbox/pull/2
只是为了让那些可能错过对初始答案的评论的人说清楚:
最初失败的主要原因似乎是 remoteEntry.js
文件是在实际 运行 主机应用程序的代码之后加载的。
bootstrap.js
方法和将直接脚本 <script src="http://localhost:2002/remoteEntry.js"></script>
添加到 <head></head>
标记具有完全相同的结果 - 它们使 remoteEntry.js
被加载和解析 之前 主应用程序的代码。
在 bootstrap 的情况下,下一个顺序是:
main_bundle
已加载- 因为主要代码被提取到
bootstrap.js
文件中 -remoteEntry.js
已加载 bootstrap.js
已加载,实际上 运行 是主应用程序
Oleg Vodolazsky 提出的变体事件顺序是下一个:
remoteEntry.js
首先加载,因为它直接添加到html
文件,webpack 的main_bundle
在 remoteEntry link[= 之后附加到<head></head>
58=]main_bundle
已加载并且 运行 应用程序
如果只是尝试 运行 没有 bootstrap 且 <head></head>
中没有硬编码脚本的应用程序 main_bundle
在 remoteEntry.js
之前加载并且作为main_bundle
尝试实际 运行 应用程序,但失败并出现错误:
你可以在Module Federation的高级API里面设置依赖为eager,它不会把模块放到一个async chunk中,而是同步提供。这允许我们在初始块中使用这些共享模块。但要小心,因为所有提供的和后备模块将始终被下载。建议仅在应用程序的某一点提供它,例如shell.
Webpack 网站强烈推荐使用异步边界。它将拆分出更大块的初始化代码以避免任何额外的往返并提高总体性能。
例如,您的条目如下所示:
index.js
import React from 'react';
import ReactDOM from 'react-dom';
import App from './App';
ReactDOM.render(<App />, document.getElementById('root'));
让我们创建 bootstrap.js 文件并将条目的内容移动到其中,然后将 bootstrap 导入条目:
index.js
+ import('./bootstrap');
- import React from 'react';
- import ReactDOM from 'react-dom';
- import App from './App';
- ReactDOM.render(<App />, document.getElementById('root'));
bootstrap.js
+ import React from 'react';
+ import ReactDOM from 'react-dom';
+ import App from './App';
+ ReactDOM.render(<App />, document.getElementById('root'));
此方法有效,但可能有局限性或缺点。
通过 ModuleFederationPlugin
为依赖项设置 eager: truewebpack.config.js
// ...
new ModuleFederationPlugin({
shared: {
...deps,
react: {
eager: true,
},
},
});
我在将 NextJS 应用程序用作容器应用程序时也遇到了问题。要知道,我们不得不一次又一次地给 eager 加载。
我采用了与网络上当前技术不同的方式。我为我的远程库使用了动态加载技术,现在似乎没有一次又一次地获取共享模块。它们只被加载一次。此外,我将整个系统实现为框架不可知论者,因此您可以将任何框架用作远程应用程序(angular、vue、react、svelte...)。此外,我将 SSR 逻辑移至远程应用程序部分,因此现在它也可以完全支持任何框架的 SSR。它似乎有效,我想在这里分享我的解决方案以帮助社区。我用示例 Github 回购 link 写了一个中型博客 post。我把我的方法详细说了。
您可以在此处找到详细的 post:https://medium.com/@metinarslanturkk/how-i-implemented-dynamic-loaded-framework-agnostic-microfrontend-app-with-nextjs-and-react-which-620ff3df4298
这是示例回购 link:https://github.com/MetinArslanturk/microfrontend-nextjs-ssr
谢谢,梅廷