基本使用
创建列表隔行变色项目
- ① 新建项目空白目录,并运行 npm init –y 命令,初始化包管理配置文件 package.json
- ② 新建 src 源代码目录
- ③ 新建 src -> index.html 首页和 src -> index.js 脚本文件
- ④ 初始化首页基本的结构
- ⑤ 运行 npm install jquery –S 命令,安装 jQuery
- ⑥ 通过 ES6 模块化的方式导入 jQuery,实现列表隔行变色效果
在项目中安装 webpack
npm install webpack@5.42.1 webpack-cli@4.7.2 -D
在项目中配置 webpack
-
① 在项目根目录中,创建名为 webpack.config.js 的 webpack 配置文件,并初始化如下的基本配置:
module.exports = { mode: "development", }
-
② 在 package.json 的 scripts 节点下,新增 dev 脚本如下:
"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"); module.exports = { mode: "development", entry: path.join(__dirname, './src/index.js'), output: { path: path.join(__dirname, './dist'), filename: "bundle.js", } }
webpack 中的插件
1. webpack 插件的作用
-
通过安装和配置第三方的插件,可以拓展 webpack 的能力,从而让 webpack 用起来更方便。最常用的
-
webpack 插件有如下两个:
-
① webpack-dev-server
类似于 node.js 阶段用到的 nodemon 工具
每当修改了源代码,webpack 会自动进行项目的打包和构建
-
② html-webpack-plugin
webpack 中的 HTML 插件(类似于一个模板引擎插件)
可以通过此插件自定制 index.html 页面的内容
-
2. webpack-dev-server
- webpack-dev-server 可以让 webpack 监听项目源代码的变化,从而进行自动打包构建。
2.1 安装 webpack-dev-server
npm install webpack-dev-server@3.11.2 -D
npm i --save-dev webpack-cli
2.2 配置 webpack-dev-server
-
① 修改 package.json -> scripts 中的 dev 命令如下:
"scripts": { "dev": "webpack serve" },
-
② 再次运行 npm run dev 命令,重新进行项目的打包
-
③ 在浏览器中访问 http://localhost:8080 地址,查看自动打包效果
-
注意:webpack-dev-server 会启动一个实时打包的 http 服务器
2.3 打包生成的文件哪儿去了?
-
① 不配置 webpack-dev-server 的情况下,webpack 打包生成的文件,会存放到实际的物理磁盘上
严格遵守开发者在 webpack.config.js 中指定配置
根据 output 节点指定路径进行存放
-
② 配置了 webpack-dev-server 之后,打包生成的文件存放到了内存中
不再根据 output 节点指定的路径,存放到实际的物理磁盘上
提高了实时打包输出的性能,因为内存比物理磁盘速度快很多
2.4 生成到内存中的文件该如何访问?
- webpack-dev-server 生成到内存中的文件,默认放到了项目的根目录中,而且是虚拟的、不可见的。
- 可以直接用 / 表示项目根目录,后面跟上要访问的文件名称,即可访问内存中的文件
- 例如 /bundle.js 就表示要访问 webpack-dev-server 生成到内存中的 bundle.js 文件
3. html-webpack-plugin
- html-webpack-plugin 是 webpack 中的 HTML 插件,可以通过此插件自定制 index.html 页面的内容。
- 需求:通过 html-webpack-plugin 插件,将 src 目录下的 index.html 首页,复制到项目根目录中一份!
3.1 安装 html-webpack-plugin
-
运行如下的命令,即可在项目中安装此插件:
npm install html-webpack-plugin@5.3.2 -D
3.2 配置 html-webpack-plugin
webpack.config.js
const path = require("path");
const HtmlPlugin = require('html-webpack-plugin');
// 创建HTML插件的实力对象
const htmlPlugin = new HtmlPlugin({
template: './src/index.html', // 指定源文件的存放路径
filename: './index.html', // 指定生成的文件的存放路径
})
module.exports = {
mode: "development",
plugins: [htmlPlugin], // 通过plugins节点,使htmlPlugin插件生效
entry: path.join(__dirname, './src/index.js'),
output: {
path: path.join(__dirname, './dist'),
filename: "bundle.js",
},
}
4. devServer 节点
-
在 webpack.config.js 配置文件中,可以通过 devServer 节点对 webpack-dev-server 插件进行更多的配置,
-
示例代码如下:
module.exports = { ...... devServer: { open: true, host: '127.0.0.1', port: 8080 } }
-
注意:凡是修改了 webpack.config.js 配置文件,或修改了 package.json 配置文件,必须重启实时打包的服
务器,否则最新的配置文件无法生效!
webpack中的loader
1. loader 概述
- 在实际开发过程中,webpack 默认只能打包处理以 .js 后缀名结尾的模块。其他非 .js 后缀名结尾的模块
- webpack 默认处理不了,需要调用 loader 加载器才可以正常打包,否则会报错!
- loader 加载器的作用:协助 webpack 打包处理特定的文件模块。比如:
- css-loader 可以打包处理 .css 相关的文件
- less-loader 可以打包处理 .less 相关的文件
- babel-loader 可以打包处理 webpack 无法处理的高级 JS 语法
2. loader 的调用过程
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-SbxcHPyC-1674294647551)(./images/webpack_loader_01.png)]
3. 打包处理 css 文件
-
① 运行 npm i style-loader@3.0.0 css-loader@5.2.6 -D 命令,安装处理 css 文件的 loader
-
② 在 webpack.config.js 的 module -> rules 数组中,添加 loader 规则如下:
module.exports = { ...... module: { rules: [{ test: /\.css$/, use: ['style-loader', 'css-loader'] }], }, ...... }
-
其中,test 表示匹配的文件类型, use 表示对应要调用的 loader
-
注意:
- use 数组中指定的 loader 顺序是固定的
- 多个 loader 的调用顺序是:从后往前调用
-
例如,写一个
src/index.css
.container { width: 100px; height: 100px; background-color: deepskyblue; }
-
然后在
src/index.html
中调用它<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Document</title> </head> <body> <div class="container"> 111 </div> <script src="./index.js"></script> </body> </html>
-
再随便写个
src/index.js
console.log(1);
-
按照上面的说法,这里只配置了css,所以
webpack.config.js
const path = require("path"); const HtmlPlugin = require('html-webpack-plugin'); // 创建HTML插件的实力对象 const htmlPlugin = new HtmlPlugin({ template: './src/index.html', // 指定源文件的存放路径 filename: './index.html', // 指定生成的文件的存放路径 }) module.exports = { mode: "development", plugins: [htmlPlugin], // 通过plugins节点,使htmlPlugin插件生效 module: { rules: [{ test: /\.css$/, use: ['style-loader', 'css-loader'] }], }, entry: path.join(__dirname, 'main.js'), // 入口文件 output: { // 出口 path: path.join(__dirname, './dist'), filename: "bundle.js", }, devServer: { open: true, host: '127.0.0.1', port: 8080 } }
-
在这个以
/main.js
为入口的webpack项目,只能找到./src/index.css
,无法找到./src/index.js
-
当然,我们需要打包的文件,无论js,css等都需要在入口文件中引入。webpack会自动根据入口文件的依赖去打包对应文件。
/main.js
require('./src/index.css');
-
最后执行打包
npm run dev
-
可以看到页面中显示出了css样式,但是打开控制台,发现js是报错的
4.打包处理less文件
-
① 运行 npm i less-loader@10.0.1 less@4.1.1 -D 命令
-
② 在 webpack.config.js 的 module -> rules 数组中,添加 loader 规则如下:
module: { rules: [{ test: /\.css$/, use: ['style-loader', 'css-loader'] },{ test: /\.less$/, use: ['style-loader', 'css-loader', 'less-loader'] },], },
5. 打包处理样式表中与 url 路径相关的文件
-
① 运行 npm i url-loader@4.1.1 file-loader@6.2.0 -D 命令
-
② 在 webpack.config.js 的 module -> rules 数组中,添加 loader 规则如下:
module: { rules: [{ test: /\.css$/, use: ['style-loader', 'css-loader'] },{ test: /\.jpg|png|gif$/, use: ['url-loader?limit=102400'] },{ test: /\.less$/, use: ['style-loader', 'css-loader', 'less-loader'] },], },
-
其中 ? 之后的是 loader 的参数项:
- limit 用来指定图片的大小,单位是字节(byte)
- 只有 ≤ limit 大小的图片,才会被转为 base64 格式的图片
-
例如,上面已经能打包css了,但是现在在css上写文件路径
index.css
.container { margin: 0; padding: 0; width: 100vw; height: 100vh; background: url("../assets/images/test.png") fixed no-repeat; background-size: cover; }
index.html
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Document</title> </head> <body> <div class="container"> </div> <script src="./index.js"></script> </body> </html>
main.js
require('./src/index.css'); require('./src/index.js');
-
本来不设置url配置,页面上是无法显示图片的
-
加上了之后,css中的图片路径才能正常解析,才能正常显示
6. 打包处理 js 文件中的高级语法
-
webpack 只能打包处理一部分高级的 JavaScript 语法。
-
对于那些 webpack 无法处理的高级 js 语法,需要借助于 babel-loader 进行打包处理。
-
例如 webpack 无法处理下面的 JavaScript 代码:
function info(target){ target.info = 'Person info'; } @info class Person{} console.log(Person.info);
6.1 安装 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 规则如下:
{ test: /\.js$/, exclude: /node_modules/, // *业务代码里面可能会引入node_modules外部js,这些js不需要babel-loader编译,因此需要排除掉 use: ['babel-loader'], }
6.2 配置 babel-loader
-
在项目根目录下,创建名为 babel.config.js 的配置文件,定义 Babel 的配置项如下:
module.exports = { plugins: [ ['@babel/plugin-proposal-decorators', { legacy:true}] ] }
打包发布
1. 为什么要打包发布
- 项目开发完成之后,需要使用 webpack 对项目进行打包发布,主要原因有以下两点:
- ① 开发环境下,打包生成的文件存放于内存中,无法获取到最终打包生成的文件
- ② 开发环境下,打包生成的文件不会进行代码压缩和性能优化
- 为了让项目能够在生产环境中高性能的运行,因此需要对项目进行打包发布。
2. 配置 webpack 的打包发布
-
在 package.json 文件的 scripts 节点下,新增 build 命令如下:
"scripts": { "dev": "webpack serve", "build": "webpack --mode production" },
-
–mode 是一个参数项,用来指定 webpack 的运行模式。
-
production 代表生产环境,会对打包生成的文件进行代码压缩和性能优化。
-
注意:通过 --model 指定的参数项,会覆盖 webpack.config.js 中的 mode 选项。
3. 把 JavaScript 文件统一生成到 js 目录中
-
在 webpack.config.js 配置文件的 output 节点中,进行如下的配置:
output: { // 出口 path: path.join(__dirname, './dist'), filename: "js/bundle.js", },
4. 把图片文件统一生成到 image 目录中
-
修改 webpack.config.js 中的 url-loader 配置项,新增 outputPath 选项即可指定图片文件的输出路径:
{ test: /\.jpg|png|gif$/, use: { loader: "url-loader", options: { limit:102400, outputPath:'image', } } },
5. 自动清理 dist 目录下的旧文件
-
为了在每次打包发布时自动清理掉 dist 目录中的旧文件,可以安装并配置 clean-webpack-plugin 插件:
npm install clean-webpack-plugin@3.0.0 -D
-
配置
webpack.config.js
const { CleanWebpackPlugin } = require('clean-webpack-plugin'); module.exports = { mode: "development", plugins: [htmlPlugin, new CleanWebpackPlugin()], ...... }
-
打包发布
npm run build
Source Map
1. 生产环境遇到的问题
- 前端项目在投入生产环境之前,都需要对 JavaScript 源代码进行压缩混淆,从而减小文件的体积,提高文件的加载效率。此时就不可避免的产生了另一个问题:
- 对压缩混淆之后的代码除错(debug)是一件极其困难的事情
- 变量被替换成没有任何语义的名称
- 空行和注释被剔除
2. 什么是 Source Map
- Source Map 就是一个信息文件,里面储存着位置信息。
- 也就是说,Source Map 文件中存储着压缩混淆后的代码,所对应的转换前的位置。
- 有了它,出错的时候,除错工具将直接显示原始代码,而不是转换后的代码,能够极大的方便后期的调试。
3. webpack 开发环境下的 Source Map
-
在开发环境下,webpack 默认启用了 Source Map 功能。当程序运行出错时,可以直接在控制台提示错误行
的位置,并定位到具体的源代码:
3.1 默认 Source Map 的问题
-
开发环境下默认生成的 Source Map,记录的是生成后的代码的位置。会导致运行时报错的行数与源代码的行
数不一致的问题。
3.2 解决默认 Source Map 的问题
-
开发环境下,推荐在 webpack.config.js 中添加如下的配置,即可保证运行时报错的行数与源代码的行数
保持一致:
webpack.config.js
module.exports = { ...... devtool: 'eval-source-map' // devtool: 'nosources-source-map' }
4. webpack 生产环境下的 Source Map
- 在生产环境下,如果省略了 devtool 选项,则最终生成的文件中不包含 Source Map。
- 这能够防止原始代码通过 Source Map 的形式暴露给别有所图之人。
4.1 只定位行数不暴露源码
-
在生产环境下,如果只想定位报错的具体行数,且不想暴露源码。
-
此时可以将 devtool 的值设置为nosources-source-map。
webpack.config.js
module.exports = { ...... devtool: 'nosources-source-map' }
4.2 定位行数且暴露源码
- 在生产环境下,如果想在定位报错行数的同时,展示具体报错的源码。
- 此时可以将 devtool 的值设置为source-map。
- 这不和
eval-source-map
一样? - 采用此选项后:你应该将你的服务器配置为,不允许普通用户访问 source map 文件!
5. Source Map 的最佳实践
- ① 开发环境下:
- 建议把 devtool 的值设置为 eval-source-map
- 好处:可以精准定位到具体的错误行
- ② 生产环境下:
- 建议关闭 Source Map 或将 devtool 的值设置为 nosources-source-map
- 好处:防止源码泄露,提高网站的安全性