Bootstrap 和 Webpack

使用 Webpack 在项目中包含和捆绑 Bootstrap 的 CSS 和 JavaScript 的官方指南。

此页面上的内容

想跳到结尾？从 twbs/examples 存储库下载本指南的源代码和工作演示。您还可以在 StackBlitz 中打开示例进行实时编辑。

设置

我们从头开始使用 Bootstrap 构建一个 Webpack 项目，因此在我们真正开始之前有一些先决条件和前期步骤。本指南要求您安装 Node.js 并熟悉终端。

创建一个项目文件夹并设置 npm。我们将创建 my-project 文件夹并使用 -y 参数初始化 npm，以避免它向我们询问所有交互式问题。
```
mkdir my-project && cd my-project
npm init -y
```
安装 Webpack。接下来，我们需要安装我们的 Webpack 开发依赖项：webpack 用于 Webpack 的核心，webpack-cli，以便我们可以从终端运行 Webpack 命令，以及 webpack-dev-server，以便我们可以运行本地开发服务器。此外，我们将安装 html-webpack-plugin，以便能够将我们的 index.html 存储在 src 目录中，而不是默认的 dist 目录中。我们使用 --save-dev 来表示这些依赖项仅用于开发，不用于生产。
```
npm i --save-dev webpack webpack-cli webpack-dev-server html-webpack-plugin
```
安装 Bootstrap。现在我们可以安装 Bootstrap 了。我们还将安装 Popper，因为我们的下拉菜单、弹出框和工具提示依赖它进行定位。如果您不打算使用这些组件，则可以在这里省略 Popper。
```
npm i --save bootstrap @popperjs/core
```
安装其他依赖项。除了 Webpack 和 Bootstrap，我们还需要一些其他依赖项才能使用 Webpack 正确导入和捆绑 Bootstrap 的 CSS 和 JS。其中包括 Sass、一些加载器和 Autoprefixer。
```
npm i --save-dev autoprefixer css-loader postcss-loader sass sass-loader style-loader
```

现在我们已经安装了所有必需的依赖项，我们可以开始创建项目文件和导入 Bootstrap 了。

项目结构

我们已经创建了 my-project 文件夹并初始化了 npm。现在，我们还将创建 src 和 dist 文件夹以完善项目结构。从 my-project 运行以下命令，或手动创建如下所示的文件夹和文件结构。

mkdir {src,src/js,src/scss}
touch src/index.html src/js/main.js src/scss/styles.scss webpack.config.js

完成后，你的完整项目应如下所示

my-project/
├── src/
│   ├── js/
│   │   └── main.js
│   ├── scss/
│   │   └── styles.scss
│   └── index.html
├── package-lock.json
├── package.json
└── webpack.config.js

此时，一切就绪，但 Webpack 无法工作，因为我们尚未填写 webpack.config.js。

配置 Webpack

在安装了依赖项且我们的项目文件夹已准备好开始编码后，我们现在可以配置 Webpack 并本地运行我们的项目。

在编辑器中打开 webpack.config.js。由于它是空白的，因此我们需要向其中添加一些样板配置，以便我们可以启动服务器。此部分配置告诉 Webpack 在哪里查找我们项目的 JavaScript，将编译后的代码输出到哪里（dist），以及开发服务器应如何运行（从 dist 文件夹中提取并热重载）。

'use strict'

const path = require('path')
const HtmlWebpackPlugin = require('html-webpack-plugin')

module.exports = {
  mode: 'development',
  entry: './src/js/main.js',
  output: {
    filename: 'main.js',
    path: path.resolve(__dirname, 'dist')
  },
  devServer: {
    static: path.resolve(__dirname, 'dist'),
    port: 8080,
    hot: true
  },
  plugins: [
    new HtmlWebpackPlugin({ template: './src/index.html' })
  ]
}

接下来，我们填写 src/index.html。这是 Webpack 将在浏览器中加载的 HTML 页面，以利用我们将在后续步骤中添加到其中的捆绑 CSS 和 JS。在执行此操作之前，我们必须为其提供一些要呈现的内容并包含上一步中的 output JS。

<!doctype html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>Bootstrap w/ Webpack</title>
  </head>
  <body>
    <div class="container py-4 px-3 mx-auto">
      <h1>Hello, Bootstrap and Webpack!</h1>
      <button class="btn btn-primary">Primary button</button>
    </div>
  </body>
</html>

我们在此处使用 div class="container" 和 <button> 包含一些 Bootstrap 样式，以便我们看到 Webpack 加载 Bootstrap 的 CSS 时的情况。

现在，我们需要一个 npm 脚本来运行 Webpack。打开 package.json 并添加如下所示的 start 脚本（你应该已经有了 test 脚本）。我们将使用此脚本启动我们的本地 Webpack 开发服务器。你还可以添加如下所示的 build 脚本来构建你的项目。
```
{
  // ...
  "scripts": {
    "start": "webpack serve",
    "build": "webpack build --mode=production",
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  // ...
}
```
最后，我们可以启动 Webpack。在终端中从 my-project 文件夹运行新添加的 npm 脚本
```
npm start
```

在本指南的下一部分也是最后一部分中，我们将设置 Webpack 加载器并导入所有 Bootstrap 的 CSS 和 JavaScript。

导入 Bootstrap

将 Bootstrap 导入 Webpack 需要我们在第一部分中安装的加载器。我们已经使用 npm 安装了它们，但现在需要配置 Webpack 以使用它们。

在 webpack.config.js 中设置加载器。你的配置文件现在已完成，应与以下代码段匹配。此处唯一的新部分是 module 部分。

'use strict'

const path = require('path')
const autoprefixer = require('autoprefixer')
const HtmlWebpackPlugin = require('html-webpack-plugin')

module.exports = {
  mode: 'development',
  entry: './src/js/main.js',
  output: {
    filename: 'main.js',
    path: path.resolve(__dirname, 'dist')
  },
  devServer: {
    static: path.resolve(__dirname, 'dist'),
    port: 8080,
    hot: true
  },
  plugins: [
    new HtmlWebpackPlugin({ template: './src/index.html' })
  ],
  module: {
    rules: [
      {
        test: /\.(scss)$/,
        use: [
          {
            // Adds CSS to the DOM by injecting a `<style>` tag
            loader: 'style-loader'
          },
          {
            // Interprets `@import` and `url()` like `import/require()` and will resolve them
            loader: 'css-loader'
          },
          {
            // Loader for webpack to process CSS with PostCSS
            loader: 'postcss-loader',
            options: {
              postcssOptions: {
                plugins: [
                  autoprefixer
                ]
              }
            }
          },
          {
            // Loads a SASS/SCSS file and compiles it to CSS
            loader: 'sass-loader'
          }
        ]
      }
    ]
  }
}

以下是我们为什么需要所有这些加载器的总结。style-loader 将 CSS 注入到 HTML 页面的 <head> 中的 <style> 元素中，css-loader 帮助使用 @import 和 url()，postcss-loader 是 Autoprefixer 所需的，sass-loader 允许我们使用 Sass。

现在，让我们导入 Bootstrap 的 CSS。将以下内容添加到 src/scss/styles.scss 以导入所有 Bootstrap 的源 Sass。
```
// Import all of Bootstrap's CSS
@import "bootstrap/scss/bootstrap";
```
如果您愿意，也可以单独导入我们的样式表。阅读我们的 Sass 导入文档了解更多详情。
接下来，我们加载 CSS 并导入 Bootstrap 的 JavaScript。将以下内容添加到 src/js/main.js 以加载 CSS 并导入所有 Bootstrap 的 JS。Popper 将通过 Bootstrap 自动导入。
```
// Import our custom CSS
import '../scss/styles.scss'

// Import all of Bootstrap's JS
import * as bootstrap from 'bootstrap'
```
您还可以根据需要单独导入 JavaScript 插件，以减小捆绑大小
```
import Alert from 'bootstrap/js/dist/alert'

// or, specify which plugins you need:
import { Tooltip, Toast, Popover } from 'bootstrap'
```
阅读我们的 JavaScript 文档，了解有关如何使用 Bootstrap 插件的更多信息。
大功告成！🎉随着 Bootstrap 的源 Sass 和 JS 完全加载，您的本地开发服务器现在应该如下所示

现在，您可以开始添加您想要使用的任何 Bootstrap 组件。务必查看完整的 Webpack 示例项目，了解如何包含其他自定义 Sass 并仅通过导入您需要的 Bootstrap 的 CSS 和 JS 部分来优化您的构建。

生产优化

根据您的设置，您可能需要实施一些额外的安全和速度优化，以便在生产中运行项目。请注意，这些优化并未应用于 Webpack 示例项目，并且由您决定是否实施。

提取 CSS

我们在上面配置的 style-loader 会将 CSS 方便地发送到捆绑包中，因此无需在 dist/index.html 中手动加载 CSS 文件。但是，此方法可能无法与严格的内容安全策略一起使用，并且由于捆绑包大小大，它可能会成为您的应用程序中的瓶颈。

为了分离 CSS，以便我们可以直接从 dist/index.html 加载它，请使用 mini-css-extract-loader Webpack 插件。

首先，安装该插件

npm install --save-dev mini-css-extract-plugin

然后在 Webpack 配置中实例化并使用该插件

--- a/webpack.config.js
+++ b/webpack.config.js
@@ -3,6 +3,7 @@
 const path = require('path')
 const autoprefixer = require('autoprefixer')
 const HtmlWebpackPlugin = require('html-webpack-plugin')
+const miniCssExtractPlugin = require('mini-css-extract-plugin')

 module.exports = {
   mode: 'development',
@@ -17,7 +18,8 @@ module.exports = {
     hot: true
   },
   plugins: [
-    new HtmlWebpackPlugin({ template: './src/index.html' })
+    new HtmlWebpackPlugin({ template: './src/index.html' }),
+    new miniCssExtractPlugin()
   ],
   module: {
     rules: [
@@ -25,8 +27,8 @@ module.exports = {
         test: /\.(scss)$/,
         use: [
           {
-            // Adds CSS to the DOM by injecting a `<style>` tag
-            loader: 'style-loader'
+            // Extracts CSS for each JS file that includes CSS
+            loader: miniCssExtractPlugin.loader
           },
           {

再次运行 npm run build 后，将生成一个新文件 dist/main.css，其中将包含 src/js/main.js 导入的所有 CSS。如果您现在在浏览器中查看 dist/index.html，则样式将丢失，因为它现在位于 dist/main.css 中。您可以像这样在 dist/index.html 中包含生成的 CSS

--- a/dist/index.html
+++ b/dist/index.html
@@ -3,6 +3,7 @@
   <head>
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width, initial-scale=1">
+    <link rel="stylesheet" href="./main.css">
     <title>Bootstrap w/ Webpack</title>
   </head>
   <body>

提取 SVG 文件

Bootstrap 的 CSS 包含对 SVG 文件的多个引用，通过内联 data: URI。如果您为项目定义了阻止图像 data: URI 的内容安全策略，则这些 SVG 文件将不会加载。您可以使用 Webpack 的资产模块功能提取内联 SVG 文件来解决此问题。

配置 Webpack 以提取内联 SVG 文件，如下所示

--- a/webpack.config.js
+++ b/webpack.config.js
@@ -23,6 +23,14 @@ module.exports = {
   },
   module: {
     rules: [
+      {
+        mimetype: 'image/svg+xml',
+        scheme: 'data',
+        type: 'asset/resource',
+        generator: {
+          filename: 'icons/[hash].svg'
+        }
+      },
       {
         test: /\.(scss)$/,
         use: [

再次运行 npm run build 后，您会发现 SVG 文件已提取到 dist/icons 中，并从 CSS 中正确引用。

发现此处有错误或已过时？请在 GitHub 上提出问题。需要故障排除帮助？在 GitHub 上搜索或开始讨论。