概念:webpack 是前端项目工程化的具体解决方案。
主要功能:它提供了友好的前端模块化开发支持,以及代码压缩混淆、处理浏览器端 JavaScript 的兼容性、性能优化等强大的功能。
好处:让程序员把工作的重心放到具体功能的实现上,提高了前端开发效率和项目的可维护性。 注意:目前Vue,React 等前端项目,基本上都是基于webpack 进行工程化开发的。
① 新建项目空白目录,并运行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
-s是--save的简写
-D是--save-dev的简写
① 在项目根目录中,创建名为 webpack.config.js 的 webpack 配置文件,并初始化如下的基本配置:(Development是开发时设定;production是产品发布时设定)
② 在 package.json 的 scripts 节点下,新增 dev 脚本如下: ③ 在终端中运行npm run dev 命令,启动webpack 进行项目的打包构建
mode 节点的可选值有两个,分别是:
① development
② production
webpack.config.js 是 webpack 的配置文件。webpack 在真正开始打包构建之前,会先读取这个配置文件,从而基于给定的配置,对项目进行打包。
注意:由于 webpack 是基于 node.js 开发出来的打包工具,因此在它的配置文件中,支持使用 node.js 相关的语法和模块进行webpack 的个性化配置。
在 webpack 4.x 和 5.x 的版本中,有如下的默认约定:
① 默认的打包入口文件为 src -> index.js
② 默认的输出文件路径为dist -> main.js
注意:可以在webpack.config.js 中修改打包的默认约定
在 webpack.config.js 配置文件中,通过entry 节点指定打包的入口。通过output 节点指定打包的出口。 示例代码如下:
通过安装和配置第三方的插件,可以拓展webpack 的能力,从而让webpack 用起来更方便。最常用的webpack 插件有如下两个:
① webpack-dev-server
② html-webpack-plugin
webpack-dev-server 可以让webpack 监听项目源代码的变化,从而进行自动打包构建。
运行如下的命令,即可在项目中安装此插件:
npm install webpack-dev-server@3.11.2 -D
① 修改package.json -> scripts 中的dev 命令如下:
② 再次运行npm run dev 命令,重新进行项目的打包
③ 在浏览器中访问http://localhost:8080 地址,查看自动打包效果
注意:webpack-dev-server 会启动一个实时打包的http 服务器
① 不配置webpack-dev-server 的情况下,webpack 打包生成的文件,会存放到实际的物理磁盘上
② 配置了 webpack-dev-server 之后,打包生成的文件存放到了内存中
webpack-dev-server 生成到内存中的文件,默认放到了项目的根目录中,而且是虚拟的、不可见的。
html-webpack-plugin 是 webpack 中的HTML 插件,可以通过此插件自定制 index.html 页面的内容。 需求:通过html-webpack-plugin 插件,将 src 目录下的 index.html 首页,复制到项目根目录中一份!
npm install html-webpack-plugin@5.3.2 -D
① 通过HTML 插件复制到项目根目录中的 index.html 页面,也被放到了内存中
② HTML 插件在生成的 index.html 页面,自动注入了打包的bundle.js 文件
在 webpack.config.js 配置文件中,可以通过devServer 节点对webpack-dev-server 插件进行更多的配置, 示例代码如下:
注意:凡是修改了 webpack.config.js 配置文件,或修改了 package.json 配置文件,必须重启实时打包的服务器,否则最新的配置文件无法生效!
在实际开发过程中,webpack 默认只能打包处理以.js 后缀名结尾的模块。其他非.js 后缀名结尾的模块,webpack 默认处理不了,需要调用 loader 加载器才可以正常打包,否则会报错!
loader 加载器的作用:协助 webpack 打包处理特定的文件模块。比如:
① 运行npm i [email protected] [email protected] -D 命令,安装处理css 文件的 loader
② 在 webpack.config.js 的module -> rules 数组中,添加 loader 规则如下:
其中,test 表示匹配的文件类型, use 表示对应要调用的 loader
注意:
① 运行npm i [email protected] [email protected] -D 命令
② 在 webpack.config.js 的module -> rules 数组中,添加 loader 规则如下:
① 运行npm i [email protected] [email protected] -D 命令
② 在 webpack.config.js 的module -> rules 数组中,添加 loader 规则如下:
其中? 之后的是 loader 的参数项:
webpack 只能打包处理一部分高级的 JavaScript 语法。对于那些webpack 无法处理的高级 js 语法,需要借 助于babel-loader 进行打包处理。例如webpack 无法处理下面的 JavaScript 代码:
运行如下的命令安装对应的依赖包:
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 规则如下:
在项目根目录下,创建名为 babel.config.js 的配置文件,定义 Babel 的配置项如下:
详情请参考Babel 的官网https://babeljs.io/docs/en/babel-plugin-proposal-decorators
https://babeljs.io/docs/en/babel-plugin-proposal-decoratorshttps://babeljs.io/docs/en/babel-plugin-proposal-decorators
项目开发完成之后,需要使用webpack 对项目进行打包发布,主要原因有以下两点:
① 开发环境下,打包生成的文件存放于内存中,无法获取到最终打包生成的文件
② 开发环境下,打包生成的文件不会进行代码压缩和性能优化
为了让项目能够在生产环境中高性能的运行,因此需要对项目进行打包发布。
在 package.json 文件的 scripts 节点下,新增build 命令如下:
--model 是一个参数项,用来指定webpack 的运行模式。production 代表生产环境,会对打包生成的文件 进行代码压缩和性能优化。
注意:通过 --model 指定的参数项,会覆盖webpack.config.js 中的model 选项。
在 webpack.config.js 配置文件的output 节点中,进行如下的配置:
修改webpack.config.js 中的 url-loader 配置项,新增outputPath 选项即可指定图片文件的输出路径:
webpack5.2以上版本,可以在output里面加上clean:true选项,就可以实现这个插件的功能了
为了在每次打包发布时自动清理掉dist 目录中的旧文件,可以安装并配置clean-webpack-plugin 插件:
前端项目在投入生产环境之前,都需要对 JavaScript 源代码进行压缩混淆,从而减小文件的体积,提高文件的 加载效率。此时就不可避免的产生了另一个问题:
Source Map 就是一个信息文件,里面储存着位置信息。也就是说,Source Map 文件中存储着压缩混淆后的 代码,所对应的转换前的位置。
有了它,出错的时候,除错工具将直接显示原始代码,而不是转换后的代码,能够极大的方便后期的调试。
在开发环境下,webpack 默认启用了 Source Map 功能。当程序运行出错时,可以直接在控制台提示错误行 的位置,并定位到具体的源代码:
开发环境下默认生成的 Source Map,记录的是生成后的代码的位置。会导致运行时报错的行数与源代码的行 数不一致的问题。示意图如下:
开发环境下,推荐在webpack.config.js 中添加如下的配置,即可保证运行时报错的行数与源代码的行数 保持一致:
在生产环境下,如果省略了devtool 选项,则最终生成的文件中不包含 Source Map。这能够防止原始代码通 过 Source Map 的形式暴露给别有所图之人。
在生产环境下,如果只想定位报错的具体行数,且不想暴露源码。此时可以将 devtool 的值设置为
nosources-source-map。实际效果如图所示:
在生产环境下,如果想在定位报错行数的同时,展示具体报错的源码。此时可以将devtool 的值设置为source-map。实际效果如图所示:
采用此选项后:你应该将你的服务器配置为,不允许普通用户访问 source map 文件!
① 开发环境下:
② 生产环境下:
先在webpack文件中配置@指向
resolve: {
alias: {
// 告诉 webpack,程序员写的代码中,@ 符号表示 src 这一层目录
'@': path.join(__dirname, './src/')
}
}
在js文件中进行@的使用
// import msg from '../../msg'
import msg from '@/msg.js'
// 建议大家使用 @ 表示 src 源代码目录,从外往里查找;不要使用 ../ 从里往外查找
// @/msg.js
console.log(msg)
@在使用之前,要自己在webpack文件中配置好,才可以使用,已经配置好,无需再进行配置
总结
答案:不需要!
实际开发中会使命令行工具(俗称 CLI)一键生成带有 webpack 的项目
开箱即用,所有 webpack 配置项都是现成的!