1-02-Webpack的基本使用

一. 什么是webpack

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

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

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

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

二. 创建列表隔行变色项目

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

2） 新建src源代码目录

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

4） 初始化首页基本结构

VSCode环境下，在index.html中输入感叹号可以直接生成html基本结构

5） 运行 npm install jquery -S 命令，安装jQuery

其中-S会将jquery加入到package.json中

6） 通过ES6模块化导入jQuery，实现列表隔行变色效果

import $ from ‘jquery’

$(function() {

$(‘li:odd’).css(‘background-color’, ‘red’);

$(‘li:even’).css(‘background-color’, ‘green’);

})

但是引入出现了一下报错：

这是因为import $ from ‘jquery’ 有兼容性的问题，需要引入webpack 解决

三. 在项目中安装webpack

在终端输入如下命令，安装webpack的两个包：

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

-S 是 –save的简写，

-D 是 –save-dev
的简写，作用跟-D差不多，只是记录的节点在devDependencies下面

其中devDependencies用于记录开发阶段需要用到的包，这些包不会跟到线上。

而Dependencies用于记录最后上线需要用到的包

至于如何区别那些包需要用-S还是-D，可以在npm官网上查看相应的介绍

四. 在项目中配置webpack

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

module.exports = {

mode: “development”

}

2） 在package.json的script节点下，新增dev脚本：

“scripts”: {

“dev”: “webpack”

},

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

这个dev就是第二点中的dev，因此实际执行的是webpack指令。

webpack的工作就是将src/index.js 和其引用到的jquery.js合并到一起

4） 将生成的 dist -> main.js 引入到 index.html 中

4.1 mode 的可选值

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

① development

• 开发环境

• 不会对打包生成的文件进行代码压缩和性能优化

• 打包速度快，适合开发阶段使用

② production

• 生产环境

• 会对打包生成的文件进行代码压缩和性能优化

• 打包速度慢，仅适合在项目发布阶段使用

4.2 webpack.config.js 文件的作用

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

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

4.3 webpack中的默认约定

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

① 默认的打包入口文件为 src -> index.js

② 默认的输出文件路径为 dist -> main.js

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

4.4 自定义打包的入口和出口

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

const path = require(‘path’); // node.js中专门操作路径的模块

module.exports = {

entry: path.join(__dirname, ‘./src/index.js’), // 打包入口文件的路径

output: {

path: path.join(__dirname, ‘./dist’), // 输出文件的存放路径

filename: ‘bundle.js’ // 输出文件名称

}

}

五. webpack中的插件

5.1 webpack插件的作用

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

1） webpack-dev-server

• 类似于node.js 阶段用到的nodemon

• 每当修改了源代码，webpack会自动进行项目的打包和构建

2） html-webpack-plugin

• webpack中的HTML插件（类似于一个模板引擎插件）

• 可以通过此插件自定制index.html页面的内容

5.2 webpack-dev-server

5.2.1 安装webpack-dev-server

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

npm install webpack-dev-server@3.11.2 -D

5.2.2 配置webpack-dev-server

① 修改package.json -> script 中的dev命令：

“scripts”: {

“dev”: “webpack serve”

},

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

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

注意：webpack-dev-server 会启动一个实时打包的http服务器

5.2.3 webpack-dev-server的工作原理

webpack-dev-server生成的dist/index.js并不存在于磁盘中，所以我们找不到对应的文件。

但我们可以从http://localhost:8080/index.js中访问到生成的dist/index.js，因为此时的dist/index.js是存在于内存中的。

存放在内存中是为了减少对磁盘的多次读写。

为了让index.js的修改能够立刻体现在浏览器上，首先需要修改index.html中的script指向/index.js。

这时候修改index.js的内容就可以立马改变浏览器中的显示效果。

5.3 html-webpack-plugin

5.3.1 安装 html-webpack-plugin

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

npm install html-webpack-plugin@5.3.2 -D

5.3.2 配置 html-webpack-plugin

// 导入HTML插件，得到一个构造函数

const HtmlPlugin = require(‘html-webpack-plugin’);

// 创建HTMl插件的实例对象

const htmlPlugin = new HtmlPlugin({

template: ‘./src/index.html’, // 指定原文件的存放路径

filename: ‘./index.html’ // 指定生成文件的存放路径

});

module.exports = {

plugins: [htmlPlugin] // 通过plugins节点，使htmlPlugin生效

}

此时src下的index.html会被存放到内存，并制定到根目录，所以localhost:8080可以访问index.html的内容

5.3.3 解惑 html-webpack-plugin

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

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

六、devServer节点

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

devServer: {

open: true,

port: 80,

host: ‘127.0.0.1’

}

注意：凡是修改了webpack.config.js配置文件，或修改了package.json配置文件，必须重启实时打包的服务器，否则最新的配置文件无法生效。

七、loader

7.1 loader的概述

在实际开发过程中，webpack默认只能打包处理以.js后缀名结尾的模块。其他非.js后缀名结尾的模块，webpack默认处理不了，需要调用loader加载器才可以正常打包，否则会报错！

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

• css-loader可以打包处理.css相关的文件

• less-loader可以打包处理.less相关的文件

• babel-loader可以打包处理webpack无法处理的高级JS语法

7.2 loader的调用过程

1） webpack默认只能打包处理.js结尾的文件，其他文件处理不了

2） 由于代码中包含了index.css，webpack默认处理不了

3）
当webpack发现有处理不了的文件时，就会查找webpack.config.js中的module.rule数组，看看是否有可以处理css的loader

4） webpack把index.css先转交给css-loader处理

5） css-loader处理之后，把结果转交给style-loader处理

6） style-loader处理完之后，发现没有其他加载器，于是将结果还给webpack

7）
webpack拿到结果之后，将结果合并到dist/bundle.js中，最终生成打包好的文件

7.3 打包处理css文件

1） 增加css文件，取消li前面的圆点

2） 在index.js中引入css文件，即：

import ‘./css/index.css’

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

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

module: {

rules: [

{ test: /.css$/, use: [‘style-loader’, ‘css-loader’] }

]

}

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

注意：

• use数组中制定的loader顺序是固定的

• 多个loader的顺序是从后往前调用

7.4 打包处理less文件

1） 增加less脚本

2） 在index.js中引入less文件

3） 运行 npm i less-loader@10.0.1 less@4.1.1 -D 安装相关的包

4） 在webpack.config.js的module->rules数组中添加loader 规则：

module: {

rules: [

{ test: /.less$/, use: [‘style-loader’, ‘css-loader’,
‘less-loader’] }

]

}

7.5 加载图片

1） 使用base64加载图片

通过网络工具可以将一张图片转换成base64代码，然后将它挂到img标签中，也可以实现图片的展示

<img

src=”data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAAAXNSR0IArs4c6QAABn5JREFUaEPtWW2MXGUVPs+5011WWBAKxQ9WAanoZjtz7460TVRcwSr+IDWSTYhQ0Aj4hRFMjKgRRKM/iNEgmCiEENsoqfUPq7EViTRA0o8wve+djWvqLiEUQsWiCW6RdXbv+5iz3mnGzW533mGnhtjzc+bMec7znvd8vGcgr3PB69x/OUngfx3B/9sIGHGu1OmPjIyUpqenz6nVaodDbXYUgeHh4SsOHDiwKxRsKf04jj9PciDLsq+F2uyIQBzH9wK4P03TLBRwoX65XD4VwJSqPpym6WdD7XVK4BcikjvntrQCVqvVN8zOzg6USqXTSJ7Z/I7ky1EUvdjf3//C7t2751p/kyTJN0l+G8D2NE2vPiEEkiTZ5b2/TFVj7/3VADZ476uquvp4DpDMReR5kpOqOklySkTuAHC6iDzinPvICSFQqVT2A7ikOLmNJCOSL6rqEZL/EJFXzBFVXUPyyyLyQ5J9AK4VkdOWcHK/c27DCSEQx7Gd3DtIWtX4FYBzReRNInIWgDNINp1cVTj8vIi8RHIIQGkxJy0qWZa980QR+LuIHLvjoaBLEDiSZdmaUFvBSTw6OhpNTk427IaEgi2TH7NZlvWG9pdgAuvXr1/daDReWknnm7YajUb/xMTE0RDbwQTiOF4rIn8OAWlX13s/UK/XLV/almAC5XJ5g6rubRshQDHP8/L4+Ph4wE/Cx2kbI7z3O0NA2tUF8IE0TR9vV9/0giMQx/EnROTnISDt6gLYnKbpWLv6HRGoVCo3A7gnBCRA95POuZ8F6IdHIEmS20neGQISoHuLc+7uAP1wAnEc/0BEbi1AtorIapIfBmBdN0Re8d4/rKrWED9a/PBO59y3Qox0kgMW4usKkB87525et27dmaVS6co8z7eo6uVL5ZYNcwD2ktw6MzPz0MGDB6fjOH5MREYKe3c7527pKoEkScZIXlmATPf29p63b98+G+DmpVwuX6CqRvCOFiJHAXw9z/Pt9Xr9ry26Q6raWja3Oueu7yqBOI6fFJH3toA8Q9Jmo2MCwEaCoZaPPADnvV/4DH0LgDe36I055zZ3lUC5XJ5Q1XeHgLSrC+CJNE0vbVff9IJzoFKpHAZgo/PHVHXAe79JRC5bbM4n+RcReSOAUxY65b0/pKq/E5HfFxH9EoDxNE3LXSUQx/GMiNgV+Z6IXOq9n4miaGee54fthSYiV1gqmBMk71HVEZLrSM4AeJzkIwAOkbyQ5IdUdXuRL+fZa805N9A1AoODgz09PT3/MgDv/VNRFNVIfqYJ6L3/k6ratuIpkqcD+JuIXADgOZKnWqRIbgJwdouT17R09qPOuf5uEjirp6fHnDLZCeBVkh9fDJDkqyLyZOGsRWbR60pyC4BtTRuNRqN3YmLC3httSVAOVKvVt+V5/mxh2ZrYhSLyvraQllACcD3JY+MDgDVpmh5p12YQgSRJBkn+sTD+fRGxfnBxC5iVSXPGHvXNzmxXp6fIiRiAvSeOiare5L3/SfOFR/LiLMvafm8EEYjj+BIR2V+gf1VEblvwNrZtha1NLiI5O1/mABsZ5q9EFEVj3vvv2MO/hcM3SN7azAuSG7Isa2IsG4hQAtbyrfWb3Cgi9x2nFN9lDa7Y+VhtX/SqkfwRACvD840PwKY0TR9d1vNCIYhApVL5IIA/FEDX2UxzHCCrVv8UkZdtS7fg1Ft/9kuSqwHYDGXV7V31ev1gVwhUq9Wz5+bmDgHos5P7z4Hhi+2CLaLXAHCD9/42AIO2Y3LOjYbYC4qAGa5UKp8C8IA5T/IBAE+LyHc76OqWGzdEUfQVksPe+0dXrVq1uVarWdTalmACZjlJkqu899ssEgB+TXJXcZejBcg2+BlG6/BnHfpIFEWf9t5bJbNt3M6+vr6r9uzZY70jSDoiYAjDw8Mb8zwfA3AOyb1RFN2b5/n9RqrpAcltqno+yfe3fPYsgC+IyE9F5K12ANPT06NTU1PzHT5UOiZQkLgoz/PfWm0naVPq7d57K6/Nrd0OABubs5GIvKCqd83NzT1om2xbqavqllqtNl9yO5HXRMAAh4aGzlXV36jqe4qZ579WLgBs0zbvIMlem52KKD24du3aG3fs2GEr947lNRMwZPuXJYqih1peass5dJ9z7nNWNZdTXO77FSFQgGi5XH47yXmbpVKpv7lK996f0pIbs8XyakX+JFxJAssdVle+P0mgK8caYPRkBAIOqyuq/waDHqFPrOhrpgAAAABJRU5ErkJggg==”

这种加载方式的好处是图片数据都存于img之内，可以直接解析成图片，不需要根据指定路径去请求图片。但由于专成base64之后，代码的占用空间会比原图更大，所以不适合用在大图片上，只适用于体积极小且需要频繁加载的icon上。

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

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

② 在webpack.config.js的module->rules添加规则：

module: {

rules: [

{ test: /.png|jpg|gif$/, use: [‘url-loader?limit=22229’] }

]

}

其中？之后的参数项：

• limit用来指定图片的大小，单位是字节（bytes）

• 只有<=limit大小的图片才会被转为base64格式的图片

7.6 webpack处理样式的过程

在js中接收css为变量，会发现打印出来的值为undefined。

import a from ‘./css/index.css’

import b from ‘./css/index.less’

console.log(a, b) // undefined undefined

因为加载器在加载css和less的时候并不会返回结果，所以接收没有任何意义。

我们可以打开dist/index.js看到css的最终生成结果：

通过一个____CSS_LOADER_EXPORT____数组将css代码保存起来，以js形式运行。

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

webpack只能打包处理一部分高级的Javascript语法。

对于那些webpack无法处理的高级js语法，需要借助babel-loader进行打包处理。

例如下面代码webpack就无法处理：

function info(target) {

target.info = ‘Person info’;

}

// 为Person添加装饰器info

@info

class Person {}

console.log(Person.info);

7.8 安装babel-loader相关的包

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

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

@babel/core和@babel/plugin-proposal-decorators代表babel-loader的依赖组件。

在webpack.config.js的module->rules数组中增加loader规则：

// exclude 用于指定那些文件夹不用打包

{ test: /.js$/, use: ‘babel-loader’, exclude: /node_modules/ }

7.9 配置babel-loader

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

module.exports = {

plugins: [[‘@babel/plugin-proposal-decorators’, { legacy: true
}]]

}

详情参考官网

八、 打包发布

8.1 为什么要打包发布

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

① 开发环境下，打包生成的文件存放与内存中，无法获取最终打包生成的文件

② 开发环境下，打包生成的文件不会进行代码压缩和性能优化

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

8.2 配置webpack的打包发布

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

“script”: {

“dev”: “webpack serve”,

“build”: “webpack –mode production”

}

–mode是一个参数项，用来指定webpack的运行模式。

production代表生产环境，会对打包生成的文件进行代码压缩和性能优化。

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

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

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

output: {

path: path.join(__dirname, ‘./dist’),

filename: ‘src/index.js’

}

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

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

{

test: /.jpg|png|gif$/,

use: {

loader: “url-loader”,

options: {

limit: 22228,

outputPath: “img”

}

}

}

不过这种写法并不推荐，我们可以使用更加简洁的写法：

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

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

为了每次打包发布时能够清理掉dist中的旧文件，可以安装并配置clean-webpack-plugin插件：

① 运行如下命令安装插件：

npm i clean-webpack-plugin@3.0.0 -D

② 在webpack.config.js中导入插件，并创建插件实例

// require(‘clean-webpack-plugin’)返回的是一个对象，{
CleanWebpackPlugin } 用于结构赋值，获得其中的function

const { CleanWebpackPlugin } = require(‘clean-webpack-plugin’);

const cleanPlugin = new CleanWebpakcPlugin();

③ 把创建的cleanPlugin实例对象，挂载到plugins节点中：

plugins: [‘htmlPlugin’, ‘cleanPlugin’]

九、Sourcemap

9.1 什么是Source Map

Source Map 就是一个信息文件，里面存储着位置信息。也就是说，Source
Map文件中存储着压缩混淆后的代码，所对应的转换前的位置。

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

9.2 默认Source Map的问题

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

9.3 解决默认Source Map问题

开发环境下，在webpack.config.js进行如下配置，即可保证运行时报错的行数和源代码行数一致：

module.export = {

mode: “development”,

devtool: “eval-source-map”

}

eval-source-map仅限在开发模式下使用，不建议在”生产环境”下使用。

9.4 生产环境下的Source Map

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

或者使用nosources-source-map参数，只定位行数，不暴露源码。

9.5 Source Map的最佳实践

① 开发环境下：

• 建议把devtool的值设置为eval-source-map

• 好处：可以精准定位到错误行

② 生产环境下：

• 建议关闭Source Map或将devtool的值设为nosources-source-map

• 好处：防止源码泄漏，提高网站的安全性

拓展：在webpack中使用@的原理和好处

在js脚本中引用模块，以往的写法是利用相对路径来指定文件位置，而相对路径是根据自身位置做的偏移，比如在index.js中引入隔壁文件夹img中的logo.png，就需要写成：

import logo from “../img/logo.png”

这样做有一个问题，就是一旦js脚本挪到了其他文件夹里面，那么js脚本中的相对路径都不得不进行重新校正。

更好的做法是，指定一个统一的根路径位置，所有路径都从根路径开始查找，这里使用了@。具体做法是在webpack.config.js中定义@的具体路径：

resolve: {

alias: {

‘@’: path.join(__dirname)

}

}

以后我们想要找到logo.png，就可以使用下面这种写法：

import logo from “@/img/logo.png”

注意：@不能用在webpack.config.js之中