Bootstrap 和 Webpack

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

当前页

想跳到最后吗？ 从 [twbs/examples repository]twbs/examples repository下载本指南的源代码和工作演示。你也可以在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 之外，我们还需要更多的依赖项来正确导入 Bootstrap 的 CSS 和 JS 并将其与 Webpack 捆绑在一起。其中包括 Sass、一些加载程序和自动前缀程序。
```
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>
    <script src="./main.js"></script>
  </body>
</html>

我们在这里包含了一些 Bootstrap 样式，其中包含 div class="container" 和 <button>，以便我们可以看到 Bootstrap 的 CSS 何时由 Webpack 加载。

现在我们需要一个 npm 脚本来运行 Webpack。 打开 package.json 并添加如下所示的 start 脚本（你应该已经有了测试脚本）。我们将使用此脚本来启动我们的本地 Webpack 开发服务器。您还可以添加如下所示的build 脚本来构建项目。
```
{
  // ...
  "scripts": {
    "start": "webpack serve",
    "build": "webpack build",
    "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 示例项目](https://github.com/twbs/examples/tree/main/webpack) ，了解如何包含额外的自定义 Sass 并通过仅导入您需要的 Bootstrap CSS 和 JS 部分来优化您的构建。

优化

根据您的设置，您可能希望实现一些额外的安全性和速度优化，这些优化对于在生产中运行项目很有用。请注意，这些优化不会应用于 Webpack 示例项目，而是由您来实现的。

提取 CSS

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

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

首先，安装插件：

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中。您可以将生成的 CSS 包含在dist/index.html中，如下所示：

--- a/webpack/dist/index.html
+++ b/webpack/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包含通过内联data:URI对SVG文件的多个引用。如果为项目定义阻止图像的data:URI 的内容安全策略，则不会加载这些 SVG 文件。您可以通过使用 Webpack 的资产模块功能提取内联 SVG 文件来解决此问题。

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

--- a/webpack/webpack.config.js
+++ b/webpack/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搜索或开始讨论。