一、webpack基本使用
1.安装webpack
npm install webpack webpack-cli -D
2.在项目中安装webpack
①在项目根目录中,创建名为webpack.config.js的webpack配置文件,并初始化如下的基本配置
module.exports = {
mode: 'development' //mode用来指定构建模式,可选值有development和production
}
②在package.json的script节点下, 新增dev脚本如下:
"scripts": {
"dev": "webpack" //script节点下的脚本,可以通过npm run执行,例如npm run dev
}
③在终端中运行npm run dev 命令,启动webpack进行项目的打包构建
结论:开发的时候一定要用development,因为追求的是打包速度,而不是体积;发布上线的时候一定能要用production,因为上线追求的是体积小,而不是打包快
3.webpack中的默认约定
在webpack 4.x和5.x的版本中,有如下的默认约定:
①默认的打包入口文件为src ->index.js
②默认的输出文件路径为dist->main.js
注意:可以在webpack.config.js中修改打包的默认约定
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中的插件
通过安装和配置第三方插件,可以扩展webpack的能力,从而让webpack用起来更方便。最常用的webpack的插件有两个
① webpack-dev-server
- 类似于node.js阶段用到的nodemon工具
- 每当修改了源代码,webpack会自动进行项目的打包和构建
②html-webpack-plugin
- webpack中的HTML插件(类似于一个模板引擎插件)
- 可以通过此插件定制index.html的内容
1.安装webpack-dev-server
运行命令
npm install webpack-dev-server -D
2.配置webpack-dev-server
①修改package.json->script中的dev命令如下:
"scripts": {
"dev": "webpack serve", //script节点下的脚本,可以通过npm run执行
}
②再次运行npm run dev命令,重新进行项目的打包
③在浏览器中访问http://localhost:8080地址,查看自动打包效果
注意: webpack-dev-server会启动一个实时打包的http服务器
3.安装http-webpack-plugin
运行命令
npm install html-webpack-plugin -D
4.配置html-webpack-plugin
在webpack.config.js中配置
// 1.导入HTML插件,得到一个构造函数
const HtmlPlugin = require('html-webpack-plugin');
// 2.创建HTML插件的实例对象
const htmlPlugin = new HtmlPlugin({
template: './src/index.html', //指定原文件的存放路径
filename: './index.html', //指定生成的文件的存放路径
});
module.exports = {
mode: 'development',
plugins: [htmlPlugin], //3.通过plugins节点,使htmlPlugins插件生效
}
5.解惑html-webpack-plugin
①通过HTML插件复制到项目根目录中的index.html页面,也被放到了内存中
②HTML插件在生成的index.html页面,自动注入了打包的bundle.js文件
6.devserver节点
在webpack.config.js配置文件中,可以通过devserver节点对webpack-dev-server插件进行更多配置,示例代码:
devserver:{
open: true, //初次打包完成后,自动打开浏览器
host: '127.0.0.1', //实时打包所使用的主机地址
port: 80, //实时打包所使用的端口号
}
三、webpack中的loader
在实际开发过程中,webpack默认只能打包处理以.js为后缀名结尾的模块。其他非.js后缀名结尾的模块,webpack默认处理不了,需要调用loader加载器才可以正常打包,否则会报错
loader加载器的作用:协助webpack打包处理特定的文件模块。例如:
- css-loader可以打包处理.css相关的文件
- less-loader可以打包处理.less相关的文件
- babel-loader可以打包处理webpack无法处理的高级JS语法
1.打包处理css文件
①运行
npm i style-loader css-loader -D
②在webpack.config.js的module->rule数组中,添加loader规则如下:
module: { //所有第三方文件模块的匹配规则
rules: [ //文件后缀名的匹配规则
{ test: /\.css$/, use:['style-loader', 'css-loader']}
]
}
其中,test表示匹配的文件类型,use表示对应要调用的loader
注意:
- use数组中指定的loader顺序是固定的
- 多个loader的调用顺序是:从后往前调用
2.打包处理less文件
①运行
npm i less-loader less -d
②在webpack.config.js的module->rules数组中,添加loader规则如下:
module: { //所有第三方文件模块的匹配规则
rules: [ //文件后缀名的匹配规则
{ test: /\.less$/, use:['style-loader', 'css-loader', 'less-loader']}
]
}
3.打包处理样式表中与url路径相关的文件
①运行
npm i url-loader file-loader -d
②在webpack.config.js的module->rules数组中,添加loader规则如下:
module: { //所有第三方文件模块的匹配规则
rules: [ //文件后缀名的匹配规则
{ test: /\.jpg|png|gif$/, use:['style-loader?limit=22229']}
]
}
其中?之后的是loader的参数项:
- limit用来指定图片的大小,单位是字节(byte)
- 只有≤limit大小的图片,才会被转为base64格式的图片
4.打包处理js文件中的高级语法
webpack只能打包处理一部分高级的Javascript语法。对于那些webpack无法处理的高级js语法,需要借助于babel-loader进行打包处理。例如webpack无法处理下面的Javascript代码:
// 1.定义了名为info的装饰器
function info(target){
// 2.为目标添加静态属性info
target.info = 'Person info';
}
// 3.为Person类应用info装饰器
@info
class Person{}
// 4.打印Person的静态属性info
console.log(Person.info);
运行如下命令安装对应的依赖包
npm i babel-loader @babel/core @babel/plugin-proposal-decorators -d
②在webpack.config.js的module->rules数组中,添加loader规则如下:
// 注意:必须使用exclude指定排除项;因为node_modules目录下的第三方包不需要被打包
{test: /\.js$/, use:'babel-loader', exclude: /node_modules/}
四、打包发布
1.配置webpack的打包发布
在package.json文件的script节点下,新增build命令如下:
"script": {
"dev": "webpack server", //开发环境中,运行dev命令
"build": "webpack --mode production" //项目发布时,运行build命令
}
–model是一个参数项,用来指定webpack的运行模式。production代表生产环境,会对打包生成的文件进行代码压缩和性能优化。
注意:通过–model指定的参数项,会覆盖webpack.config.js中的model选项。
2.把Javascript文件统一生成到js目录中
在webpack.config.js配置文件的output节点中,进行如下的配置:
output:{
path: path.join(__dirname, 'dist');
// 明确告诉webpack把生成的bundle.js文件存放到dist目录下的js子目录中
filename: 'js/bundle.js'
}
3.把图片文件统一生成到image目录中
在webpack.config.js配置文件的url-loader配置项,新增outputPath选项即可指定图片文件的输出路径:
const { options } = require("less")
{
test: /\.jpg|png|gif$/,
use: {
loader: 'url-loader',
options: {
limit: 22228,
// 明确指定把打包生成的文件图片,存储到dist目录下的image文件夹中
outputPath: 'image',
},
},
}
3.自动清理打包dist目录下的旧文件
为了在每次打包发布时自动清理掉dist目录中的旧文件,可以安装并配置clean-webpack-plugin插件:
①安装清理dist目录的webpack插件
npm install clean-webpack-plugin -d
②按需导入插件、得到插件的构造函数之后,创建插件的实例对象
const { CleanWebpackPlugin } = require('clean-webpack-plugin');
const cleanPlugin = new CleanWebpackPlugin();
③把创建的cleanPlugin插件实例对昂,挂载到plugins中
plugins: [htmlPlugin, cleanPlugin], //挂载插件
五、Source Map
1、什么是Source Map
Source Map就是一个信息文件,里面储存着位置信息。也就是说,Source Map文件中存储着压缩混淆后的代码,所对应转换前的位置。
出错的时候,除错工具将直接显示源代码,而不是后端代码,能够极大地方便后期调试。
2、默认Source Map的问题
开发环境下默认生成的Source Map,记录的是生成后的代码位置。会导致运行时报错的行数与源代码的行数不一致的问题。
3.解决默认Source Map的问题
开发环境下,推荐在webpack.config.js中添加如下的配置,即可保证运行时报错的行数与源代码的行数保持一致:
module.exports = {
mode: 'development',
// eval-source-map仅限在“开发模式”下使用,不建议在“生产模式”下使用
// 此选项生成的Source Map能够保证“运行时报错的行数”与“源代码的行数”保持一致
devtool: 'eval-source-map',
// 省略其他配置项
}
4.0webpack生产环境下的Sorce Map
在生产环境下,如果省略了devtool选项,则最终生成的文件中不包含Sorce Map。这能够防止原始代码通过Source Map的形式暴露给别有所图之人
4.1只定位行数不暴露源码
在生产环境下,如果只想定位报错的具体行数,且不想暴露远吗,此时可以将devtool的值设为nosources-source-map。
5.Sorce Map的最佳实践
①开发环境下:
- 建议把devtool的值设为eval-source-map
- 好处:可以精准定位到具体的错误行
②生产环境下:
- 建议关闭Sorce Map或将devtool的值设为nosourse-sourse-map
- 好处:防止源码泄露,提高网站的安全性