71. Webpack 教程

1. Webpack 简介

Webpack 是一个现代 JavaScript 应用程序的静态模块打包器。当 Webpack 处理应用程序时，它会递归地构建一个依赖关系图，其中包含应用程序需要的每个模块，然后将所有这些模块打包成一个或多个 bundle。

1.1 Webpack 的核心概念

  • 入口（Entry）：指定 Webpack 应该从哪个模块开始构建依赖关系图
  • 输出（Output）：告诉 Webpack 在哪里输出打包后的文件以及如何命名
  • 加载器（Loader）：让 Webpack 能够处理非 JavaScript 文件（如 CSS、图片等）
  • 插件（Plugin）：执行更广泛的任务，如打包优化、资源管理和环境变量注入
  • 模式（Mode）：设置为 development、production 或 none，影响 Webpack 的默认行为

1.2 Webpack 的优势

  • 支持模块化开发
  • 丰富的插件生态系统
  • 强大的代码分割能力
  • 支持热模块替换（HMR）
  • 高度可配置

2. 安装与配置

2.1 安装 Webpack

首先，在项目中安装 Webpack 和 Webpack CLI：

# 使用 npm
npm install --save-dev webpack webpack-cli

# 使用 yarn
yarn add --dev webpack webpack-cli

# 使用 pnpm
pnpm add --save-dev webpack webpack-cli

2.2 基本配置文件

在项目根目录创建 webpack.config.js 文件：

const path = require('path');

module.exports = {
  mode: 'development',
  entry: './src/index.js',
  output: {
    filename: 'bundle.js',
    path: path.resolve(__dirname, 'dist')
  }
};

2.3 配置 package.json 脚本

在 package.json 文件中添加构建脚本：

{
  "scripts": {
    "build": "webpack",
    "watch": "webpack --watch",
    "dev": "webpack serve --open"
  }
}

3. 基本使用

3.1 处理 JavaScript 模块

创建 src/index.js 文件：

// 导入模块
import { add } from './utils.js';

// 使用模块
console.log(add(1, 2));

创建 src/utils.js 文件：

// 导出模块
export const add = (a, b) => a + b;
export const subtract = (a, b) => a - b;

3.2 处理 CSS 文件

首先安装 css-loader 和 style-loader：

npm install --save-dev css-loader style-loader

更新 webpack.config.js 文件：

module.exports = {
  // ... 其他配置
  module: {
    rules: [
      {
        test: /\.css$/,
        use: ['style-loader', 'css-loader']
      }
    ]
  }
};

创建 src/styles.css 文件：

body {
  font-family: Arial, sans-serif;
  background-color: #f0f0f0;
}

在 src/index.js 中导入 CSS 文件：

import './styles.css';
// ... 其他代码

3.3 处理图片和字体

更新 webpack.config.js 文件，添加文件加载器：

module.exports = {
  // ... 其他配置
  module: {
    rules: [
      // ... 其他规则
      {
        test: /\.(png|svg|jpg|jpeg|gif)$/i,
        type: 'asset/resource'
      },
      {
        test: /\.(woff|woff2|eot|ttf|otf)$/i,
        type: 'asset/resource'
      }
    ]
  }
};

4. 高级特性

4.1 代码分割

4.1.1 入口分割

module.exports = {
  entry: {
    main: './src/index.js',
    vendor: './src/vendor.js'
  },
  output: {
    filename: '[name].bundle.js',
    path: path.resolve(__dirname, 'dist')
  }
};

4.1.2 动态导入

使用 import() 语法实现按需加载：

// src/index.js
button.addEventListener('click', async () => {
  const { default: module } = await import('./heavy-module.js');
  module.doSomething();
});

4.2 热模块替换（HMR）

更新 webpack.config.js 文件：

module.exports = {
  // ... 其他配置
  devServer: {
    static: './dist',
    hot: true
  }
};

4.3 环境变量

使用 webpack.DefinePlugin 注入环境变量：

const webpack = require('webpack');

module.exports = {
  // ... 其他配置
  plugins: [
    new webpack.DefinePlugin({
      'process.env.NODE_ENV': JSON.stringify(process.env.NODE_ENV)
    })
  ]
};

5. 最佳实践

5.1 开发环境与生产环境配置分离

创建两个配置文件：

  • webpack.common.js：公共配置
  • webpack.dev.js：开发环境配置
  • webpack.prod.js：生产环境配置

使用 webpack-merge 合并配置：

npm install --save-dev webpack-merge

5.2 优化构建性能

  • 使用 cache 选项缓存构建结果
  • 合理配置 resolve 选项
  • 使用 thread-loader 进行多线程构建
  • 对于大型项目，考虑使用 module.noParse 跳过某些模块的解析

5.3 优化输出文件

  • 使用 TerserPlugin 压缩 JavaScript
  • 使用 MiniCssExtractPlugin 提取 CSS 到单独的文件
  • 使用 OptimizeCSSAssetsPlugin 压缩 CSS
  • 配置合理的 splitChunks 策略

6. 示例项目

6.1 基本项目结构

├── dist/
├── src/
│   ├── index.js
│   ├── utils.js
│   ├── styles.css
│   └── assets/
│       └── logo.png
├── webpack.config.js
└── package.json

6.2 完整配置示例

const path = require('path');
const HtmlWebpackPlugin = require('html-webpack-plugin');
const MiniCssExtractPlugin = require('mini-css-extract-plugin');
const { CleanWebpackPlugin } = require('clean-webpack-plugin');

module.exports = {
  mode: 'production',
  entry: './src/index.js',
  output: {
    filename: '[name].[contenthash].js',
    path: path.resolve(__dirname, 'dist')
  },
  module: {
    rules: [
      {
        test: /\.css$/,
        use: [MiniCssExtractPlugin.loader, 'css-loader']
      },
      {
        test: /\.js$/,
        exclude: /node_modules/,
        use: {
          loader: 'babel-loader',
          options: {
            presets: ['@babel/preset-env']
          }
        }
      },
      {
        test: /\.(png|svg|jpg|jpeg|gif)$/i,
        type: 'asset/resource',
        generator: {
          filename: 'images/[name].[hash][ext]'
        }
      }
    ]
  },
  plugins: [
    new CleanWebpackPlugin(),
    new HtmlWebpackPlugin({
      template: './src/index.html'
    }),
    new MiniCssExtractPlugin({
      filename: '[name].[contenthash].css'
    })
  ],
  optimization: {
    splitChunks: {
      chunks: 'all'
    }
  }
};

6.3 运行构建

# 开发环境
npm run dev

# 生产环境构建
npm run build

7. 常见问题与解决方案

7.1 模块解析失败

问题：Webpack 无法解析模块

解决方案：

  • 检查模块路径是否正确
  • 确保已安装相关依赖
  • 配置 resolve.extensions 选项

7.2 构建速度慢

问题：Webpack 构建速度缓慢

解决方案：

  • 启用缓存
  • 使用多线程构建
  • 合理配置 exclude 选项
  • 考虑使用 esbuild-loader 替代 babel-loader

7.3 打包体积过大

问题：打包后的文件体积过大

解决方案：

  • 启用代码分割
  • 移除未使用的代码
  • 使用 Tree Shaking
  • 压缩资源
  • 考虑使用 CDN 加载第三方库

8. 总结

Webpack 是一个功能强大的前端构建工具，通过本教程的学习，你应该已经掌握了：

  • Webpack 的核心概念和基本使用方法
  • 如何配置 Webpack 处理不同类型的文件
  • 如何使用 Webpack 的高级特性如代码分割和热模块替换
  • Webpack 的最佳实践和性能优化技巧

Webpack 的生态系统非常丰富，建议在实际项目中根据需求选择合适的插件和配置，以达到最佳的构建效果。

9. 扩展阅读

« 上一篇 Vite 中文教程 下一篇 » 72. Rollup 教程
↑