Skip to content

08 Webpack 模块打包工具

知识点自测

  1. 以下哪个选项是 ECMAScript 默认导出和导入的语法?

    • A. exportrequire
    • B. module.exports = {}import 变量名
    • C. export defaultimport 变量名
    • D. exportimport { 同名变量名 }
    答案
    • C 选项正确
  2. 对以下 less 样式代码描述正确的是?

    js
    .title {
      span {
        color: red;
      }
    }
    • A. 查找 class 名字叫 title 元素范围内,所有 span 标签
    • B. 查找 class 名字叫 titlespan 标签
    答案
    • A 选项正确
  3. 以下代码运行结果是多少?

    js
    const arr = [1, 2, 3, 4].map((val) => val * 2);
    console.log(arr);
    • A. [undefined, undefined, undefined, undefined]
    • B. [2, 4, 6, 8]
    答案
    • B 选项正确
  4. 以下针对 axios 函数使用时的配置项描述正确的选项?

    js
    axios({
      // 这里
    });
    • A. url: 请求的方法method: 传递参数
    • B. data: 传递查询参数params: 传递请求体参数
    • C. url: 请求的网址method: 请求的方法
    • D. data: 传递请求体参数params: 传递请求体参数
    答案
    • C 选项正确

Webpack 简介

了解 Webpack 的概念和作用,以及使用

  1. Webpack 是一个静态模块打包工具,从入口构建依赖图,打包有关的模块,最后用于展示你的内容

    本质上,webpack 是一个用于现代 JavaScript 应用程序的静态模块打包工具。当 webpack 处理应用程序时,它会在内部从一个或多个入口点构建一个依赖图 (dependency graph),然后将你项目中所需的每一个模块组合成一个或多个 bundles,它们均为静态资源,用于展示你的内容。

  2. 静态模块:编写代码过程中的,html,css,js,图片等固定内容的文件

  3. 打包过程,注意:只有和入口有直接/间接引入关系的模块,才会被打包

    218ccb4c-ba34-4cb6-8759-0588625441de

  4. Webpack 的作用:把静态模块内容压缩,转译,整合,打包等(前端工程化)

    • 把 less/sass 转成 css 代码
    • 把 ES6+ 降级成 ES5 等
    • 支持多种模块文件类型,多种模块标准语法
  5. 为何不学 vite?

    现在很多项目还是基于 Webpack 来进行构建的,所以还是要掌握 Webpack 的使用

Webpack 体验

  1. 体验 Webpack 打包 2 个 JS 文件内容

  2. 需求:封装 utils 包,校验手机号和验证码长度,在 src/index.js 中使用,使用 Webpack 打包

  3. 步骤:

    1. 新建项目文件夹 Webpack_study,初始化包环境,得到 package.json 文件

      bash
      npm init -y
    2. 新建 src 源代码文件夹(书写代码)包括 utils/check.js 封装用户名和密码长度函数,引入到 src/index.js 进行使用

    3. 下载 webpack webpack-cli 到项目(版本独立)

      bash
      pnpm i webpack webpack-cli --save-dev
      pnpm i webpack webpack-cli -D

      注意

      虽然 webpack 是全局软件包,封装的是命令工具,但是为了保证项目之间版本分别独立,所以这次比较特殊,下载到某个项目环境下,但是需要把 webpack 命令配置到 package.json 的 scripts 自定义命令,作为局部命令使用

    4. 项目中运行工具命令,采用自定义命令的方式(局部命令)

      bash
      npm run build

      npm run 自定义命令名字

      实际上在终端运行的是 build 右侧的具体命名

    5. 自动产生 dist 分发文件夹(压缩和优化后,用于最终运行的代码)

  4. 需求最终流程图:

    7b8b43b1-83c7-434c-951e-9f6a80c68ebc

bash
 tre
.
├── dist
   └── main.js
├── package.json
├── pnpm-lock.yaml
└── src
    ├── index.js
    └── utils
        └── check.js
json
{
  "name": "14.Webpack_study",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "build": "webpack"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "devDependencies": {
    "webpack": "^5.89.0",
    "webpack-cli": "^5.1.4"
  }
}
js
/**
 * 目标 1:体验 webpack 打包过程
 */
// 1.1 准备项目和源代码
import { checkPhone, checkCode } from './utils/check.js';
console.log(checkPhone('13900002020'));
console.log(checkCode('123123123123'));
// 1.2 准备 webpack 打包的环境
// 1.3 运行自定义命令打包观察效果(npm run 自定义命令)
js
// 封装校验手机号长度和校验验证码长度的函数
export const checkPhone = (phone) => phone.length === 11;
export const checkCode = (code) => code.length === 6;

小结

  1. Webpack 有什么用?

    • 压缩,转译,整合,打包我们的静态模块
  2. Webpack 怎么用?

    • 初始化环境,编写代码,安装 Webpack 软件包,配置自定义命令,打包体验查看结果
  3. 如何运行 package.json 里的自定义命令?

    • npm run 自定义命令
  4. Webpack 默认入口和出口?

    • src/index.jsdist/main.js

修改入口和出口

了解 Webpack 配置文件使用,影响 Webpack 打包过程和结果

  1. Webpack 配置:影响 Webpack 打包过程

  2. 步骤:

    • 项目根目录,新建 Webpack.config.js 配置文件

    • 导出配置对象,配置入口,出口文件路径(别忘了修改磁盘文件夹和文件的名字)

      js
      const path = require('path');
      
      module.exports = {
        entry: path.resolve(__dirname, 'src/login/index.js'),
        output: {
          path: path.resolve(__dirname, 'dist'),
          filename: './login/index.js',
        },
      };
    • 重新打包观察

  3. 图解:

    3f56d2fd-b129-4941-9559-afd10e282211

bash
 tre
.
├── Webpack.config.js
├── dist
   ├── login
   └── index.js
   └── main.js
├── package.json
├── pnpm-lock.yaml
└── src
    ├── login
   └── index.js
    └── utils
        └── check.js
js
const path = require('path');

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

小结

  1. 如何影响 Webpack 打包过程?

    • 查文档,新建配置文件和配置属性

案例 - 手机号验证码长度判断

体验前端项目代码,如何被 Webpack 打包和使用

  1. 需求:点击登录按钮,判断手机号和验证码长度是否符合要求

  2. 步骤:

    • 新建 public/login.html 准备网页模板(方便查找标签和后期自动生成 html 文件做准备)

    • 核心 JS 代码写在 src/login/index.js 文件

      bash
      /**
       * 目标 3:用户登录 - 长度判断案例
       *  3.1 准备用户登录页面
       *  3.2 编写核心 JS 逻辑代码
       *  3.3 打包并手动复制网页到 dist 下,引入打包后的 js,运行
       */
      // 3.2 编写核心 JS 逻辑代码
      document.querySelector('.btn').addEventListener('click', () => {
        const phone = document.querySelector('.login-form [name=mobile]').value
        const code = document.querySelector('.login-form [name=code]').value
      
        if (!checkPhone(phone)) {
          console.log('手机号长度必须是 11 位')
          return
        }
      
        if (!checkCode(code)) {
          console.log('验证码长度必须是 6 位')
          return
        }
      
        console.log('提交到服务器登录...')
      })
    • 运行自定义命令,让 Webpack 打包 JS 代码

    • 手动复制 public/login.htmldist 下,手动引入打包后的 JS 代码文件,运行 dist/login.html 在浏览器查看效果

      f6a1fd45-5815-4bad-b12f-5be693082220

小结

  1. Webpack 打包后的前端代码是如何运行的?

    • 手动引入到 html 文件中,再交给浏览器运行

Webpack 项目配置

自动生成 html 文件

让 Webpack 拥有自动生成 html 文件能力,并引入打包后的其他资源

  1. 插件 html-webpack-plugin 作用:在 Webpack 打包时生成 html 文件,并引入其他打包后的资源

  2. 步骤:

    • 下载 html-webpack-plugin 本地软件包到项目中

      bash
      pnpm i html-webpack-plugin -D
    • 配置 webpack.config.js 让 Webpack 拥有插件功能

      js
      const HtmlWebpackPlugin = require('html-webpack-plugin');
      
      module.exports = {
        // 出口
        output: {
          path: path.resolve(__dirname, 'dist'),
          filename: './login/index.js',
          clean: true, // 生成打包后内容之前,清空输出目录
        },
        // 插件(给 Webpack 提供更多功能)
        plugins: [
          new HtmlWebpackPlugin({
            template: './public/login.html', // 模板文件
            filename: './login/index.html', // 输出文件
          }),
        ],
      };
    • 指定以 public/login.html 为模板复制到 dist/login/index.html,并自动引入其他打包后资源

  3. 运行打包命令,观察打包后 dist 文件夹下内容并运行查看效果

bash
 tre
.
├── Webpack.config.js
├── dist
   └── login
       ├── index.html
       └── index.js
├── package.json
├── pnpm-lock.yaml
├── public
   └── login.html
└── src
    ├── login
   └── index.js
    └── utils
        └── check.js

小结

  1. html-webpack-plugin 插件怎么用?

    • 找到插件文档,下载到项目中,配置到 Webpack 的配置文件中即可使用

打包 css 代码

让 Webpack 能够打包 css 代码

  1. 注意:Webpack 默认只识别 JS 和 JSON 文件内容,所以想要让 Webpack 识别更多不同内容,需要使用加载器

  2. 介绍需要的 2 个加载器来辅助 Webpack 才能打包 css 代码

  3. 步骤:

    • 下载 bootstrap, css-loaderstyle-loader 本地软件包

      bash
      pnpm i bootstrap css-loader style-loader -D
    • 准备 css 文件引入到 src/login/index.js 中(压缩转译处理等)

      js
      /**
       * 目标 5:打包 css 代码
       *  5.1 准备 css 代码,并引入到 js 中
       *  5.2 下载 css-loader 和 style-loader 本地软件包
       *  5.3 配置 webpack.config.js 让 Webpack 拥有该加载器功能
       *  5.4 打包后观察效果
       */
      // 5.1 准备 css 代码,并引入到 js 中
      import 'bootstrap/dist/css/bootstrap.min.css';
      import './index.css';

      注意

      这里只是引入代码内容让 Webpack 处理,不需定义变量接收在 JS 代码中继续使用,所以没有定义变量接收

    • 配置 webpack.config.js 让 Webpack 拥有该加载器功能

      js
      module.exports = {
        module: {
          rules: [
            {
              test: /\.css$/i, // 匹配 .css 结尾的文件
              use: ['style-loader', 'css-loader'], // 使用从后到前的加载器来解析 css 代码和插入到 DOM
            },
          ],
        },
      };
    • 打包后运行 dist/login/index.html 观察效果,看看准备好的样式是否作用在网页上

bash
 tre
.
├── Webpack.config.js
├── dist
   └── login
       ├── index.html
       └── index.js
├── package.json
├── pnpm-lock.yaml
├── public
   └── login.html
└── src
    ├── login
   ├── index.css
   └── index.js
    └── utils
        └── check.js

小结

  1. 加载器的作用是什么?

    • 让 Webpack 识别更多的代码内容类型

提取 css 代码

让 Webpack 能够提取 css 代码到独立的 css 文件中

  1. 需求:让 webpack 把 css 代码内容字符串单独提取到 dist 下的 css 文件中

  2. 需要:mini-css-extract-plugin 插件来实现

  3. 步骤:

    • 下载 mini-css-extract-plugin 插件软件包到本地项目中

      bash
      pnpm i -D mini-css-extract-plugin
    • 配置 webpack.config.js 让 Webpack 拥有该插件功能

      js
      const MiniCssExtractPlugin = require('mini-css-extract-plugin');
      
      module.exports = {
        module: {
          rules: [
            {
              test: /\.css$/i,
              // use: ['style-loader', 'css-loader']
              use: [MiniCssExtractPlugin.loader, 'css-loader'],
            },
          ],
        },
        plugins: [new MiniCssExtractPlugin()],
      };
    • 打包后观察效果

    • 好处:css 文件可以被浏览器缓存,减少 JS 文件体积,让浏览器并行下载 css 和 js 文件

    注意

    MiniCssExtractPlugin.loader 不能和 style-loader 一起使用

bash
 tre
.
├── Webpack.config.js
├── dist
   ├── login
   ├── index.html
   └── index.js
   └── main.css # 可以看到单独提取的 css 文件
├── package.json
├── pnpm-lock.yaml
├── public
   └── login.html
└── src
    ├── login
   ├── index.css
   └── index.js
    └── utils
        └── check.js

优化压缩过程

把单独提取的 css 文件内代码压缩

  1. 需求:把提出的 css 文件内样式代码压缩

  2. 需要:css-minimizer-webpack-plugin 插件来实现

  3. 步骤:

    • 下载 css-minimizer-webpack-plugin 插件软件包到本地项目中

      bash
      pnpm i -D css-minimizer-webpack-plugin
    • 配置 webpack.config.js 让 Webpack 拥有该插件功能

      js
      const CssMinimizerPlugin = require('css-minimizer-webpack-plugin');
      
      module.exports = {
        // 优化
        optimization: {
          minimizer: [
            // 在 webpack@5 中,你可以使用 `...` 语法来扩展现有的 minimizer(即 `terser-webpack-plugin`),将下一行取消注释
            `...`,
            new CssMinimizerPlugin(),
          ],
          minimize: true, // 开发环境下启用 CSS 优化 (mode: 'development')
        },
      };
    • 打包后观察 css 文件内自己代码是否被压缩了

bash
 tre
.
├── Webpack.config.js
├── dist
   ├── login
   ├── index.html
   ├── index.js
   └── index.js.LICENSE.txt
   └── main.css
├── package.json
├── pnpm-lock.yaml
├── public
   └── login.html
└── src
    ├── login
   ├── index.css
   └── index.js
    └── utils
        └── check.js

打包 less 代码

让 Webpack 拥有打包 less 代码功能

  1. 加载器 less-loader:把 less 代码编译为 css 代码,还需要依赖 less 软件包

  2. 步骤:

    • 新建 login/index.less 文件,设置背景图样式(图片在配套资料 - 素材文件夹中)

      less
      html {
        body {
          background: url('./assets/login-bg.png') no-repeat center/cover;
        }
      }
    • less 样式引入到 src/login/index.js

      js
      /**
       * 目标 8:打包 less 代码
       *  8.1 新建 less 代码(设置背景图)并引入到 src/login/index.js 中
       *  8.2 下载 less 和 less-loader 本地软件包
       *  8.3 配置 webpack.config.js 让 Webpack 拥有功能
       *  8.4 打包后观察效果
       */
      // 8.1 新建 less 代码(设置背景图)并引入到 src/login/index.js 中
      import './index.less';
    • 下载 lessless-loader 本地软件包

      bash
      pnpm i -D less less-loader
    • 配置 webpack.config.js 让 Webpack 拥有功能

      js
      module.exports = {
        module: {
          rules: [
            {
              test: /\.less$/i,
              use: [MiniCssExtractPlugin.loader, 'css-loader', 'less-loader'],
            },
          ],
        },
      };
    • 打包后运行 观察效果

bash
 tre
.
├── Webpack.config.js
├── dist
   ├── 03e9db9780832fb1bb47.png
   ├── login
   ├── index.html
   ├── index.js
   └── index.js.LICENSE.txt
   └── main.css
├── package.json
├── pnpm-lock.yaml
├── public
   └── login.html
└── src
    ├── login
   ├── assets
   ├── login-bg.png
   └── logo.png
   ├── index.css
   ├── index.js
   └── index.less
    └── utils
        └── check.js

小结

  1. Webpack 支持 less 代码打包需要哪 2 个软件包?

    • 需要 less less-loader 这 2 个软件包

打包图片

让 Webpack 支持图片等资源打包

  1. 资源模块:Webpack 内置了资源模块的打包,无需下载额外 loader

  2. 步骤:

    • 配置 webpack.config.js 让 Webpack 拥有打包图片功能

      • 占位符【hash】对模块内容做算法计算,得到映射的数字字母组合的字符串
      • 占位符【ext】使用当前模块原本的占位符,例如:.png / .jpg 等字符串
      • 占位符【query】保留引入文件时代码中查询参数(只有 URL 下生效)

      注意

      判断临界值默认为 8KB

      • 大于 8KB 文件:发送一个单独的文件并导出 URL 地址
      • 小于 8KB 文件:导出一个 data URI(base64 字符串)
    • src/login/index.js 中给 img 标签添加 logo 图片

      js
      /**
       * 目标 9:打包资源模块(图片处理)
       *  9.1 创建 img 标签并动态添加到页面,配置 webpack.config.js
       *  9.2 打包后观察效果和区别
       */
      // 9.1 创建 img 标签并动态添加到页面,配置 webpack.config.js
      // 注意:js 中引入本地图片资源要用 import 方式(如果是网络图片 HTTP 地址,字符串可以直接写)
      import imgObj from './assets/logo.png';
      const theImg = document.createElement('img');
      theImg.src = imgObj;
      document.querySelector('.login-wrap').appendChild(theImg);
    • 配置 webpack.config.js 让 Webpack 拥有打包图片功能

      js
      module.exports = {
        module: {
          rules: [
            {
              test: /\.(png|jpg|jpeg|gif)$/i,
              type: 'asset',
              generator: {
                filename: 'assets/[hash][ext][query]',
              },
            },
          ],
        },
      };
    • 打包后运行观察效果

bash
 tre
.
├── Webpack.config.js
├── dist
   ├── assets
   └── 03e9db9780832fb1bb47.png
   ├── login
   ├── index.html
   ├── index.js
   └── index.js.LICENSE.txt
   └── main.css
├── package.json
├── pnpm-lock.yaml
├── public
   └── login.html
└── src
    ├── login
   ├── assets
   ├── login-bg.png
   └── logo.png
   ├── index.css
   ├── index.js
   └── index.less
    └── utils
        └── check.js

小结

  1. 资源模块指的是什么?

    • 图片,字体文件等等

案例 - 用户登录

在 Webpack 环境下,使用 npm 下包作用在前端项目

  1. 需求:点击登录按钮,基于 npm 下载 axios 包,完成验证码登录功能

    1da5eee0-84ca-4697-bbf0-c62ea45481a3

  2. 步骤:

    • 使用 npm 下载 axios pnpm i axios
    • 引入到 src/login/index.js 中编写业务实现
    • 打包后运行观察效果
js
/**
 * 目标 1:体验 webpack 打包过程
 */
// 1.1 准备项目和源代码
import { checkPhone, checkCode } from '../utils/check.js';
// console.log(checkPhone('13900002020'));
// console.log(checkCode('123123123123'));
// 1.2 准备 webpack 打包的环境
// 1.3 运行自定义命令打包观察效果(npm run 自定义命令)

/**
 * 目标 3:用户登录 - 长度判断案例
 *  3.1 准备用户登录页面
 *  3.2 编写核心 JS 逻辑代码
 *  3.3 打包并手动复制网页到 dist 下,引入打包后的 js,运行
 */
// document.querySelector('.btn').addEventListener('click', () => {
//   const phone = document.querySelector('.login-form [name=mobile]').value;
//   const code = document.querySelector('.login-form [name=code]').value;

//   if (!checkPhone(phone)) {
//     console.log('手机号长度必须是 11 位');
//     return;
//   }

//   if (!checkCode(code)) {
//     console.log('验证码长度必须是 6 位');
//     return;
//   }

//   console.log('提交到服务器登录...');
// });

/**
 * 目标 5:打包 css 代码
 *  5.1 准备 css 代码,并引入到 js 中
 *  5.2 下载 css-loader 和 style-loader 本地软件包
 *  5.3 配置 webpack.config.js 让 Webpack 拥有该加载器功能
 *  5.4 打包后观察效果
 */
// 5.1 准备 css 代码,并引入到 js 中
import 'bootstrap/dist/css/bootstrap.min.css';
import './index.css';

/**
 * 目标 8:打包 less 代码
 *  8.1 新建 less 代码(设置背景图)并引入到 src/login/index.js 中
 *  8.2 下载 less 和 less-loader 本地软件包
 *  8.3 配置 webpack.config.js 让 Webpack 拥有功能
 *  8.4 打包后观察效果
 */
// 8.1 新建 less 代码(设置背景图)并引入到 src/login/index.js 中
import './index.less';

/**
 * 目标 9:打包资源模块(图片处理)
 *  9.1 创建 img 标签并动态添加到页面,配置 webpack.config.js
 *  9.2 打包后观察效果和区别
 */
// 9.1 创建 img 标签并动态添加到页面,配置 webpack.config.js
// 注意:js 中引入本地图片资源要用 import 方式(如果是网络图片 HTTP 地址,字符串可以直接写)
import imgObj from './assets/logo.png';
const theImg = document.createElement('img');
theImg.src = imgObj;
document.querySelector('.login-wrap').appendChild(theImg);

/**
 * 目标 10:完成登录功能
 *  10.1 使用 npm 下载 axios(体验 npm 作用在前端项目中)
 *  10.2 准备并修改 utils 工具包源代码导出实现函数
 *  10.3 导入并编写逻辑代码,打包后运行观察效果
 */
import { myAlert } from '../utils/alert.js';
import myAxios from '../utils/request.js';
document.querySelector('.btn').addEventListener('click', async () => {
  const phone = document.querySelector('.login-form [name=mobile]').value;
  const code = document.querySelector('.login-form [name=code]').value;

  if (!checkPhone(phone)) {
    myAlert(false, '手机号长度必须是 11 位');
    console.log('手机号长度必须是 11 位');
    return;
  }

  if (!checkCode(code)) {
    myAlert(false, '验证码长度必须是 6 位');
    console.log('验证码长度必须是 6 位');
    return;
  }

  // console.log('提交到服务器登录...');
  try {
    const data = {
      mobile: phone,
      code,
    };
    const res = await myAxios.post('/v1_0/authorizations', data);
    console.log(res);
    myAlert(true, '登录成功!');
    localStorage.setItem('token', res.data.token);
  } catch (error) {
    myAlert(false, err.response.data.message);
    console.log(err.response.data.message);
  }
});
js
// 弹窗插件
// 需要先准备 alert 样式相关的 DOM
/**
 * BS 的 Alert 警告框函数,2秒后自动消失
 * @param {*} isSuccess 成功 true,失败 false
 * @param {*} msg 提示消息
 */
export function myAlert(isSuccess, msg) {
  const myAlert = document.querySelector('.alert');
  myAlert.classList.add(isSuccess ? 'alert-success' : 'alert-danger');
  myAlert.innerHTML = msg;
  myAlert.classList.add('show');

  setTimeout(() => {
    myAlert.classList.remove(isSuccess ? 'alert-success' : 'alert-danger');
    myAlert.innerHTML = '';
    myAlert.classList.remove('show');
  }, 2000);
}
js
// 封装校验手机号长度和校验验证码长度的函数
export const checkPhone = (phone) => phone.length === 11;
export const checkCode = (code) => code.length === 6;
js
// axios 公共配置
import axios from 'axios';

// 基地址
axios.defaults.baseURL = 'http://geek.itheima.net';

// 添加请求拦截器
axios.interceptors.request.use(
  (config) => {
    // 在发送请求之前做些什么
    // 统一携带 token 令牌字符串在请求头上
    const token = localStorage.getItem('token');
    if (token) {
      config.headers.Authorization = `Bearer ${token}`;
    }
    return config;
  },
  (error) => {
    // 对请求错误做些什么
    return Promise.reject(error);
  },
);

// 添加响应拦截器
axios.interceptors.response.use(
  (response) => {
    // 2xx 范围内的状态码都会触发该函数。
    // 对响应数据做点什么,例如:直接返回服务器的响应结果对象
    const result = response.data;
    return result;
  },
  (error) => {
    // 超出 2xx 范围的状态码都会触发该函数。
    // 对响应错误做点什么,例如:统一对 401 身份验证失败情况做出处理
    console.dir(error);
    if (error?.response?.status === 401) {
      alert('身份验证失败,请重新登录');
      localStorage.clear();
      location.href = '../login/index.html';
    }
    return Promise.reject(error);
  },
);

export default axios;
json
{
  "name": "14.Webpack_study",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "build": "webpack"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "devDependencies": {
    "bootstrap": "^5.3.2",
    "css-loader": "^6.9.0",
    "css-minimizer-webpack-plugin": "^5.0.1",
    "html-webpack-plugin": "^5.6.0",
    "less": "^4.2.0",
    "less-loader": "^11.1.4",
    "mini-css-extract-plugin": "^2.7.7",
    "style-loader": "^3.3.4",
    "webpack": "^5.89.0",
    "webpack-cli": "^5.1.4"
  },
  "dependencies": {
    "axios": "^1.6.5"
  }
}
js
const path = require('path');
const HtmlWebpackPlugin = require('html-webpack-plugin');
const MiniCssExtractPlugin = require('mini-css-extract-plugin');
const CssMinimizerPlugin = require('css-minimizer-webpack-plugin');

module.exports = {
  // 打包模式(development 开发模式 - 使用相关内置优化)
  mode: 'development',
  // 入口
  entry: path.resolve(__dirname, 'src/login/index.js'),
  // 出口
  output: {
    path: path.resolve(__dirname, 'dist'),
    filename: './login/index.js',
    clean: true, // 生成打包后内容之前,清空输出目录
  },
  // 插件(给 Webpack 提供更多功能)
  plugins: [
    new HtmlWebpackPlugin({
      template: path.resolve(__dirname, 'public/login.html'), // 模板文件
      filename: path.resolve(__dirname, 'dist/login/index.html'), // 输出文件
    }),
    new MiniCssExtractPlugin({
      filename: './login/index.css',
    }),
  ],
  // 加载器(让 webpack 识别更多模块文件内容)
  module: {
    rules: [
      {
        test: /\.css$/i,
        use: [MiniCssExtractPlugin.loader, 'css-loader'],
      },
      {
        test: /\.less$/i,
        use: [MiniCssExtractPlugin.loader, 'css-loader', 'less-loader'],
      },
      {
        test: /\.(png|jpg|jpeg|gif)$/i,
        type: 'asset',
        generator: {
          filename: 'assets/[hash][ext][query]',
        },
      },
    ],
  },
  // 优化
  optimization: {
    minimizer: [
      // 在 webpack@5 中,你可以使用 `...` 语法来扩展现有的 minimizer(即 `terser-webpack-plugin`),将下一行取消注释
      '...',
      new CssMinimizerPlugin(),
    ],
    minimize: true,
  },
};

小结

  1. npm 下载的包如何作用在前端项目上?

    • 被 Webpack 打包处理后,再引入到 html 文件中运行

Webpack 开发环境

Webpack 打包模式

了解不同打包模式对代码和环境的影响

  1. 打包模式:告知 Webpack 使用相应模式的内置优化

  2. 分类:

    模式名称模式名字特点场景
    开发模式development调试代码,实时加载,模块热替换等本地开发
    生产模式production压缩代码,资源优化,更轻量等打包上线
  3. 如何设置影响 Webpack 呢?

    js
    module.exports = {
      // 设置 `mode` 选项
      mode: 'production',
    };
    json
    "scripts": {
      "build": "webpack --mode=production",
      "dev": "webpack serve --mode=development"
    }

    注意

    命令行设置的优先级高于配置文件中的,推荐用命令行设置

  4. 体验:在 build 命令后 修改 mode 的值,打包输出观察打包后的 js 文件内容

热更新

体验 webpack-dev-server 开发服务器,快速开发应用程序

  1. 每次改动代码,都要重新打包,很麻烦,所以这里给项目集成 webpack-dev-server 开发服务器

  2. 作用:启动 Web 服务,打包输出源码在内存,并会自动检测代码变化热更新到网页 (在 js / css 文件中修改代码保存后,会实时反馈到浏览器)

  3. 步骤;

    • 下载 webpack-dev-server 软件包到当前项目 pnpm i -D webpack-dev-server
    • 配置自定义命令,并设置打包的模式为开发模式
    • 使用 pnpm run dev 来启动开发服务器,访问提示的 域名 + 端口号,在浏览器访问打包后的项目网页,修改代码后试试热更新效果

小结

  1. 两种模式的区别?

    • 开发模式注重代码热替换更快,让开发调试代码更便捷,生产模式注重项目体积更小,更轻量,适配不同的浏览器环境
  2. webpack-dev-server 的作用?

    • 启动 Webpack 开发服务器,会启动一个 Web 服务,实时检测代码变化重新打包,并快速反应最新效果到浏览器页面上

打包模式的应用

了解 Webpack 打包模式的应用

  1. 需求:在开发模式下用 style-loader 内嵌更快,在生产模式下提取 css 代码

    • 方案 1webpack.config.js 配置导出函数,但是局限性大(只接受 2 种模式)
    • 方案 2:借助 cross-env(跨平台通用)包命令,设置参数区分环境
    • 方案 3:配置不同的 webpack.config.js(适用多种模式差异性较大情况)
  2. 主要使用方案 2 尝试,其他方案可以结合点击跳转的官方文档查看尝试

  3. 步骤:

    • 下载 cross-env 软件包到当前项目 pnpm i -D cross-env

    • 配置自定义命令,传入参数名和值(会绑定到 process.env 对象下)

    • webpack.config.js 区分不同环境使用不同配置

      json
      {
        "scripts": {
          "build": "cross-env NODE_ENV=production webpack --config webpack.config.js --mode=production",
          "dev": "cross-env NODE_ENV=development webpack serve --config webpack.config.js --mode=development"
        }
      }
      js
      module: {
          rules: [
            {
              test: /\.css$/i,
              // use: ['style-loader', "css-loader"],
              use: [process.env.NODE_ENV === 'development' ? 'style-loader' : MiniCssExtractPlugin.loader, "css-loader"]
            },
            {
              test: /\.less$/i,
              use: [
                // compiles Less to CSS
                process.env.NODE_ENV === 'development' ? 'style-loader' : MiniCssExtractPlugin.loader, 'css-loader', 'less-loader',
              ],
            }
          ],
        },
    • 重新打包观察两种配置区别

注入环境变量

前端项目中,开发模式下打印语句生效,生产模式下打印语句失效

  1. 需求:前端项目中,开发模式下打印语句生效,生产模式下打印语句失效

  2. 问题:cross-env 设置的只在 Node.js 环境生效,前端代码无法访问 process.env.NODE_ENV

  3. 解决:使用 Webpack 内置的 DefinePlugin 插件

  4. 作用:在编译时,将前端代码中匹配的变量名,替换为值或表达式

  5. 配置 webpack.config.js 中给前端注入环境变量

    js
    const webpack = require('webpack');
    
    module.exports = {
      plugins: [
        new webpack.DefinePlugin({
          // key 是注入到打包后的前端 JS 代码中作为全局变量
          // value 是变量对应的值(在 corss-env 注入在 Node.js 中的环境变量字符串)
          'process.env.NODE_ENV': JSON.stringify(process.env.NODE_ENV),
        }),
      ],
    };

开发环境调错 source map

在开发环境如何精准定位到报错源码位置

  1. source map:可以准确追踪 errorwarning 在原始代码的位置

  2. 问题:代码被压缩和混淆,无法正确定位源代码位置(行数和列数)

  3. 设置:webpack.config.js 配置 devtool 选项

    js
    module.exports = {
      devtool: 'inline-source-map',
    };

    `inline-source-map` 选项

    把源码的位置信息一起打包在 JS 文件内

  4. 注意:source map 适用于开发环境,不要在生产环境使用(防止被轻易查看源码位置)

小结

  1. 为何打包后,在控制台无法准确定位到源码的位置信息?

    • 因为 Webpack 把代码压缩和混淆了

Webpack 设置解析别名路径

设置 Webpack 如何设置路径别名,方便我们引入目标模块

  1. 解析别名:配置模块如何解析,创建 import 或 require 的别名,来确保模块引入变得更简单

  2. 例如:

    • 原来路径如下:import { checkPhone, checkCode } from '../src/utils/check.js';

    • 配置解析别名:在 webpack.config.js 中设置

      js
      const config = {
        // ...
        resolve: {
          alias: {
            '@': path.resolve(__dirname, 'src'),
          },
        },
      };
    • 这样我们以后,引入目标模块写的路径就更简单了 import { checkPhone, checkCode } from '@/utils/check.js';

  3. 修改代码的路径后,重新打包观察效果是否正常!

小结

  1. 路径中的 '@' 符号代表什么意思?

    • 看在 webpack 配置中的别名路径是什么,就会在打包时替换成哪个路径使用

CDN 使用

开发模式使用本地第三方库,生产模式下使用 CDN 加载引入

  1. 需求:开发模式使用本地第三方库,生产模式下使用 CDN 加载引入

  2. CDN:内容分发网络,指的是一组分布在各个地区的服务器

  3. 作用:把静态资源文件/第三方库放在 CDN 网络中各个服务器中,供用户就近请求获取

  4. 好处:减轻自己服务器请求压力,就近请求物理延迟低,配套缓存策略

  5. 实现需求的思路图:

    5b96fe3d-2f0f-4f5c-bf69-b20bc41a77a9

  6. 步骤:

    • 在 html 中引入第三方库的 CDN 并用模板语法判断

      html
      <% if(htmlWebpackPlugin.options.useCdn){ %>
      <link href="https://cdn.bootcdn.net/ajax/libs/twitter-bootstrap/5.2.3/css/bootstrap.min.css" rel="stylesheet" />
      <% } %>
    • 配置 webpack.config.jsexternals 外部扩展选项(防止某些 import 的包被打包)

      js
      // 生产环境下使用相关配置
      if (process.env.NODE_ENV === 'production') {
        // 外部扩展(让 webpack 防止 import 的包被打包进来)
        config.externals = {
          // key:import from 语句后面的字符串
          // value:留在原地的全局变量(最好和 cdn 在全局暴露的变量一致)
          'bootstrap/dist/css/bootstrap.min.css': 'bootstrap',
          axios: 'axios',
        };
      }
      
      const config = {
        plugins: [
          new HtmlWebpackPlugin({
            // 自定义属性,在 html 模板中 <%=htmlWebpackPlugin.options.useCdn%> 访问使用
            useCdn: process.env.NODE_ENV === 'production',
          }),
        ],
      };
    • 两种模式下打包观察效果

小结

Webpack 多页面打包

让 Webpack 同时打包登录和内容列表页面

  1. 概念:单页面:单个 html 文件,切换 DOM 的方式实现不同业务逻辑展示,后续 Vue/React 会学到

    多页面:多个 html 文件,切换页面实现不同业务逻辑展示

  2. 需求:把黑马头条数据管理平台 内容页面一起引入打包使用

  3. 步骤:

    • 准备源码(html,css,js)放入相应位置,并改用模块化语法导出

    • 下载 form-serialize 包并导入到核心代码中使用

    • 配置 webpack.config.js 多入口和多页面的设置

      js
      const config = {
        entry: {
          '模块名 1': path.resolve(__dirname, 'src/入口 1.js'),
          '模块名 2': path.resolve(__dirname, 'src/入口 2.js'),
        },
        output: {
          path: path.resolve(__dirname, 'dist'),
          filename: './[name]/index.js'
        }
        plugins: [
          new HtmlWebpackPlugin({
            template: './public/页面 2.html', // 模板文件
            filename: './路径/index.html', // 输出文件
            chunks: ['模块名 2']
          })
          new HtmlWebpackPlugin({
            template: './public/页面 2.html', // 模板文件
            filename: './路径/index.html', // 输出文件
            chunks: ['模块名 2']
          })
        ]
      }
    • 重新打包观察效果

案例 - 发布文章页面打包

案例 - 发布文章页面打包

  1. 需求:把发布文章页面一起打包

  2. 步骤:

    • 准备发布文章页面源代码,改写成模块化的导出和导入方式
    • 修改 webpack.config.js 的配置,增加一个入口和出口
    • 打包观察效果

优化 分割公共代码

优化 - 分割功能代码

  1. 需求:把 2 个以上页面引用的公共代码提取

  2. 步骤:

    • 配置 webpack.config.jssplitChunks 分割功能

      js
      const config = {
        optimization: {
          splitChunks: {
            chunks: 'all', // 所有模块动态非动态移入的都分割分析
            cacheGroups: {
              // 分隔组
              commons: {
                // 抽取公共模块
                minSize: 0, // 抽取的 chunk 最小大小字节
                minChunks: 2, // 最小引用数
                reuseExistingChunk: true, // 当前 chunk 包含已从主 bundle 中拆分出的模块,则它将被重用
                name(module, chunks, cacheGroupKey) {
                  // 分离出模块文件名
                  const allChunksNames = chunks.map((item) => item.name).join('~'); // 模块名 1~模块名 2
                  return `./js/${allChunksNames}`; // 输出到 dist 目录下位置
                },
              },
            },
          },
        },
      };
    • 打包观察效果