这是我参与「第四届青训营 」笔记创作活动的第3天

webpack的基本使用

什么是 webpack

概念：webpack 是前端项目工程化的具体解决方案。

主要功能： 它提供了友好的前端模块化开发支持，以及代码压缩混淆、处理浏览器端 JavaScript 的兼容性、性

能优化等强大的功能。

好处：让程序员把工作的重心放到具体功能的实现上，提高了前端开发效率和项目的可维护性。

注意：目前 Vue，React 等前端项目，基本上都是基于 webpack 进行工程化开发的。

创建列表隔行变色项目

① 新建项目空白目录，并运行 npm init –y 命令，初始化包管理配置文件 package.json

② 新建 src 源代码目录

③ 新建 src -> index.html 首页和 src -> index.js 脚本文件

④ 初始化首页基本的结构

ul>li{这是第 $ 个 li}*9
//再回车，生成
    <ul>
        <li>这是第 1 个 li</li>
        <li>这是第 2 个 li</li>
        <li>这是第 3 个 li</li>
        <li>这是第 4 个 li</li>
        <li>这是第 5 个 li</li>
        <li>这是第 6 个 li</li>
        <li>这是第 7 个 li</li>
        <li>这是第 8 个 li</li>
        <li>这是第 9 个 li</li>
    </ul>

⑤ 运行 npm install jquery –S 命令，安装 jQuery ( -S 是 --save 的缩写 ，表示安装在dependencies，开发和上线都需要)

⑥ 通过 ES6 模块化的方式导入 jQuery，实现列表隔行变色效果

import $ from 'jquery'

在项目中安装 webpack

在终端运行如下的命令，安装 webpack 相关的两个包：

npm install webpack@5.42.1 webpack-cli@4.7.2 -D 

( -D 是 --save-dev 的缩写 ，表示安装在devDependencies，仅开发需要的工具)

在项目中配置 webpack

① 在项目根目录中，创建名为 webpack.config.js 的 webpack 配置文件，并初始化如下的基本配置：

// 使用 Node.js 中的导出语法，向外导出一个 webpack 的配置对象
module.exports = {
    mode: 'development'  //mode 用来指定构建模式。可选值有 development（开发，打包速度快） 和 production（上线，体积小）
}

② 在 package.json 的 scripts 节点下，新增 dev 脚本如下：

  "scripts": {
      "dev": "webpack"
  },

③ 在终端中运行 npm run dev 命令，启动 webpack 进行项目的打包构建

mode 的可选值

mode 节点的可选值有两个，分别是：

① development

• 开发环境
• 不会对打包生成的文件进行代码压缩和性能优化
• 打包速度快，适合在开发阶段使用

② production

• 生产环境
• 会对打包生成的文件进行代码压缩和性能优化
• 打包速度很慢，仅适合在项目发布阶段使用

webpack.config.js 文件的作用

webpack.config.js 是 webpack 的配置文件。webpack 在真正开始打包构建之前，会先读取这个配置文件，从而基于给定的配置，对项目进行打包。

注意：由于 webpack 是基于 node.js 开发出来的打包工具，因此在它的配置文件中，支持使用 node.js 相关的语法和模块进行 webpack 的个性化配置。

webpack 中的默认约定

在 webpack 4.x 和 5.x 的版本中，有如下的默认约定：

• 默认的打包入口文件为 src -> index.js
• 默认的输出文件路径为 dist -> main.js

注意：可以在 webpack.config.js 中修改打包的默认约定

自定义打包的入口与出口

在 webpack.config.js 配置文件中，通过 entry 节点指定打包的入口。通过 output 节点指定打包的出口。

const path = require('path') // 导入 node.js 中专门操作路径的模块
// 使用 Node.js 中的导出语法，向外导出一个 webpack 的配置对象
module.exports = {
    entry:path.join(__dirname, './src/index.js'), // 打包入口文件的路径
    output: {
        path: path.join(__dirname, './dist'), // 输出文件的存放路径
        filename: 'main.js' // 输出文件的名称
    }
}

webpack 中的插件

webpack 插件的作用

通过安装和配置第三方的插件，可以拓展 webpack 的能力，从而让 webpack 用起来更方便。最常用的

webpack 插件有如下两个：

webpack-dev-server

• 类似于 node.js 阶段用到的 nodemon 工具
• 每当修改了源代码，webpack 会自动进行项目的打包和构建

html-webpack-plugin

• webpack 中的 HTML 插件（类似于一个模板引擎插件）
• 可以通过此插件自定制 index.html 页面的内容

webpack-dev-server

webpack-dev-server 可以让 webpack 监听项目源代码的变化，从而进行自动打包构建。

安装 webpack-dev-server

npm install webpack-dev-server@3.11.2 -D

配置 webpack-dev-server

① 修改 package.json -> scripts 中的 dev 命令如下：

  "scripts": {
    "dev": "webpack serve"
  },

② 再次运行 npm run dev 命令，重新进行项目的打包

③ 在浏览器中访问 http://localhost:8080 地址，查看自动打包效果

打包生成的文件哪儿去了？

① 不配置 webpack-dev-server 的情况下，webpack 打包生成的文件，会存放到实际的物理磁盘上

• 严格遵守开发者在 webpack.config.js 中指定配置
• 根据 output 节点指定路径进行存放

② 配置了 webpack-dev-server 之后，打包生成的文件存放到了内存中

• 不再根据 output 节点指定的路径，存放到实际的物理磁盘上
• 提高了实时打包输出的性能，因为内存比物理磁盘速度快很多

生成到内存中的文件该如何访问？

webpack-dev-server 生成到内存中的文件，默认放到了项目的根目录中，而且是虚拟的、不可见的。

• 可以直接用 / 表示项目根目录，后面跟上要访问的文件名称，即可访问内存中的文件
• 例如 /bundle.js 就表示要访问 webpack-dev-server 生成到内存中的 bundle.js 文件

html-webpack-plugin

html-webpack-plugin 是 webpack 中的 HTML 插件，可以通过此插件自定制 index.html 页面的内容。

通过 html-webpack-plugin 插件，将 src 目录下的 index.html 首页，复制到项目根目录中一份！即可在根目录下打开 index.html 页面

安装 html-webpack-plugin

运行如下的命令，即可在项目中安装此插件：

npm install html-webpack-plugin@5.3.2 -D

配置 html-webpack-plugin

修改 package.json文件

// 导入 html-webpack-plugin 这个插件，得到插件的构造函数
const HtmlPlugin = require('html-webpack-plugin')
// new 构造函数，创建插件的实例对象
const htmlPlugin = new HtmlPlugin({
    template: './src/index.html', // 原文件路径和文件名
    filename: './index.html'  // 指定复制到的文件路径和文件名
})
​
module.exports = {
    mode: 'development',
    plugins: [htmlPlugin], // 插件的数组，通过plugins节点，使htmlPlugin插件生效
}

解惑 html-webpack-plugin不需要导入js文件

① 通过 HTML 插件复制到项目根目录中的 index.html 页面，也被放到了内存中

② HTML 插件在生成的 index.html 页面，自动注入了同级目录下打包的 bundle.js 文件

devServer 节点

在 webpack.config.js 配置文件中，可以通过 devServer 节点对 webpack-dev-server 插件进行更多的配置，

示例代码如下：

module.exports = {
    devServer: {
        open: true, // 初次完成打包后，自动打开默认浏览器
        host: '127.0.0.1', // 运行的主机地址
        port: 80, // 打包的端口号
    }
}

注意：凡是修改了 webpack.config.js 配置文件，或修改了 package.json 配置文件，必须重启实时打包的服

务器，否则最新的配置文件无法生效！

webpack 中的 loader

loader 概述

在实际开发过程中，webpack 默认只能打包处理以 .js 后缀名结尾的模块。其他非 .js 后缀名结尾的模块，

webpack 默认处理不了，需要调用 loader 加载器才可以正常打包，否则会报错！

loader 加载器的作用：协助 webpack 打包处理特定的文件模块。比如：

• css-loader 可以打包处理 .css 相关的文件
• less-loader 可以打包处理 .less 相关的文件
• babel-loader 可以打包处理 webpack 无法处理的高级 JS 语法

打包处理 css 文件

① 运行 npm i style-loader@3.0.0 css-loader@5.2.6 -D 命令，安装处理 css 文件的 loader

② 在 webpack.config.js 的 module -> rules 数组中，添加 loader 规则如下：

    module: { // 所有第三方文件模块的匹配规则
        rules: [ // 文件后缀名的匹配规则
            { test: /.css$/, use: ['style-loader', 'css-loader']}
        ]
    }

其中，test 表示匹配的文件类型， use 表示对应要调用的 loader

注意：

• use 数组中指定的 loader 顺序是固定的
• 多个 loader 的调用顺序是：从后往前调用

打包处理 less 文件

① 运行 npm i less-loader@10.0.1 less@4.1.1 -D 命令

② 在 webpack.config.js 的 module -> rules 数组中，添加 loader 规则如下：

    module: { // 所有第三方文件模块的匹配规则
        rules: [ // 文件后缀名的匹配规则
            { test: /.less$/, use: ['style-loader', 'css-loader', 'less-loader']}
        ]
    }

打包处理样式表中与 url 路径相关的文件

① 运行 npm i url-loader@4.1.1 file-loader@6.2.0 -D 命令

② 在 webpack.config.js 的 module -> rules 数组中，添加 loader 规则如下：

module: { // 所有第三方文件模块的匹配规则
        rules: [ // 文件后缀名的匹配规则
            { test: /.jpg|png|gif$/, use: 'url-loader?limit=22229'}
        ]
    }

其中 ? 之后的是 loader 的参数项：

• limit 用来指定图片的大小，单位是字节（byte）
• 只有 ≤ limit 大小的图片，才会被转为 base64 格式的图片

打包处理 js 文件中的高级语法

webpack 只能打包处理一部分高级的 JavaScript 语法。对于那些 webpack 无法处理的高级 js 语法，需要借

助于 babel-loader 进行打包处理。例如 webpack 无法处理下面的 JavaScript 代码

// 定义了名为 info 的装饰器
function info(target) {
    // 为目标添加静态属性 info
    target.info = 'Person info'
}
// 为 Person 类应用 info 装饰器
@info
class Person {}
// 打印 Person 的静态属性 info
console.log(Person.info)

安装 babel-loader 相关的包

运行如下的命令安装对应的依赖包：

npm i babel-loader@8.2.2 @babel/core@7.14.6 @babel/plugin-proposal-decorators@7.14.5 -D 

在 webpack.config.js 的 module -> rules 数组中，添加 loader 规则如下：

// 注意:必须使用 exclude 指定排除项;因为 node_modules 目录下的第三方包不需要被打包
{ test: /.js$/, use: 'babel-loader', exclude: /node_modules/}

配置 babel-loader

在项目根目录下，创建名为 babel.config.js 的配置文件，定义 Babel 的配置项如下：

module.exports = {
    // 声明 babel 可用的插件
    plugins: [['@babel/plugin-proposal-decorators', { legacy: true}]]
}

Babel 的官网 ：https://babeljs.io/docs/en/babel-plugin-proposal-decorators

打包发布

为什么要打包发布

项目开发完成之后，需要使用 webpack 对项目进行打包发布，主要原因有以下两点：

• 开发环境下，打包生成的文件存放于内存中，无法获取到最终打包生成的文件
• 开发环境下，打包生成的文件不会进行代码压缩和性能优化

为了让项目能够在生产环境中高性能的运行，因此需要对项目进行打包发布。

配置 webpack 的打包发布

在 package.json 文件的 scripts 节点下，新增 build 命令如下：

  "scripts": {
    "dev": "webpack serve", // 开发环境中，运行 dev 命令
    "build": "webpack --mode production" // 项目发布时，运行 build 命令
  }

--model 是一个参数项，用来指定 webpack 的运行模式。production 代表生产环境，会对打包生成的文件进行代码压缩和性能优化。

注意：通过 --model 指定的参数项，会覆盖 webpack.config.js 中的 model 选项。

把 JavaScript 文件统一生成到 js 目录中

在 webpack.config.js 配置文件的 output 节点中，进行如下的配置：

    output: {
        path: path.join(__dirname, './dist'), // 输出文件的存放路径
        filename: 'js/bundle.js' // 输出文件的名称
    }

把图片文件统一生成到 images 目录中

修改 webpack.config.js 中的 module -> rules 数组的 url-loader 配置项，新增 outputPath 参数即可指定图片文件的输出路径：

{ test: /.jpg|png|gif$/, use: 'url-loader?limit=22229&outputPath=images'}

自动清理 dist 目录下的旧文件

为了在每次打包发布时自动清理掉 dist 目录中的旧文件，可以安装并配置 clean-webpack-plugin 插件

安装clean-webpack-plugin

npm i clean-webpack-plugin -D

配置使用clean-webpack-plugin

①在 webpack.config.js 中的导入clean-webpack-plugin

const { CleanWebpackPlugin } = require('clean-webpack-plugin')

②在 webpack.config.js 中的 module.exports 节点下的 plugins中 new CleanWebpackPlugin()

module.exports = {
    plugins: [htmlPlugin, new CleanWebpackPlugin()], 
}

Source Map

什么是 Source Map

Source Map 就是一个信息文件，里面储存着位置信息。也就是说，Source Map 文件中存储着压缩混淆后的

代码，所对应的转换前的位置。

有了它，出错的时候，除错工具将直接显示原始代码，而不是转换后的代码，能够极大的方便后期的调试。

webpack 开发环境下的 Source Map

在开发环境下，webpack 默认启用了 Source Map 功能。当程序运行出错时，可以直接在控制台提示错误行

的位置，并定位到具体的源代码。

默认 Source Map 的问题

开发环境下默认生成的 Source Map，记录的是生成后的代码的位置。会导致运行时报错的行数与源代码的行数不一致的问题。

解决默认 Source Map 的问题

开发环境下，推荐在 webpack.config.js 中添加如下的配置，即可保证运行时报错的行数与源代码的行数

保持一致

module.exports = {
    mode: 'development',
    devtool: 'eval-source-map'
    }

webpack 生产环境下的 Source Map

在生产环境下，如果省略了 devtool 选项，则最终生成的文件中不包含 Source Map。这能够防止原始代码通 过 Source Map 的形式暴露给其他人。

只定位行数不暴露源码

在生产环境下，如果只想定位报错的具体行数，且不想暴露源码。此时可以将 devtool 的值设置为

nosources-source-map。

定位行数且暴露源码

在生产环境下，如果想在定位报错行数的同时，展示具体报错的源码。此时可以将 devtool 的值设置为

source-map。（不推荐）

Source Map 的最佳实践

① 开发环境下：

• 建议把 devtool 的值设置为 eval-source-map
• 好处：可以精准定位到具体的错误行

② 生产环境下：

• 建议关闭 Source Map 或将 devtool 的值设置为 nosources-source-map
• 好处：防止源码泄露，提高网站的安全性