1. 概述
webpack 是一个流行的前端项目构建工具(打包工具),它提供了友好的模块化支持,以及代码压缩混淆、处理 js 兼容问题、性能优化等强大的功能。
2. webpack的基本使用
2.1 webpack安装及配置
- 下载webpack相关包:
npm install webpack webpack-cli –D
- 在项目根目录中,创建 webpack.config.js 的配置文件
- 在配置文件中,配置初始化
module.exports = {
mode: 'development' // mode 用来指定构建模式,有development、production两种模式
}
- 在 package.json 配置文件中的scripts节点下,做如下配置
"scripts": {
"dev": "webpack" //通过 npm run 执行
},
- 在终端中运行 npm run dev 命令,启动 webpack 进行项目打包。
2.2 webpack配置打包的入口及出口
webpack 的 4.x 版本中默认约定:
打包的入口文件为 src -> index.js
打包的输出文件为 dist -> main.js
修改打包文件的入口和出口,需在webpack.config.js新增一下配置信息:
//只有一个入口文件和一个出口文件
const path = require('path') // 导入 node.js 中专门操作路径的模块
module.exports = {
entry: path.join(__dirname, './src/index.js'), // 打包入口文件的路径
output: {
path: path.join(__dirname, './dist'), // 输出文件的存放路径
filename: 'bundle.js' // 输出文件的名称
} }
//有多个入口文件和多个出口文件
const path = require('path') // 导入 node.js 中专门操作路径的模块
module.exports = {
entry: path.join(__dirname, './src/index.js'), // 打包入口文件的路径
entry2: './src/index2.js',
output: {
path: path.join(__dirname, './dist'), // 输出文件的存放路径
filename: '[name].js' // 出口文件用name,说明文件名与入口文件名相同
} }
2.3 配置 webpack 的自动打包
- 安装支持项目自动打包的工具:
npm install webpack-dev-server –D
- 在 package.json 文件中,修改scripts下的dev
"scripts": {
"dev": "webpack-dev-server" //通过 npm run 执行
}
- 运行 npm run dev 命令,重新进行打包
- 在浏览器中访问 http://localhost:8080 地址,查看自动打包效果
注:- webpack-dev-server 会启动一个实时打包的 http 服务器
- webpack-dev-server 打包生成的输出文件,默认放到了项目根目录中,而且是虚拟的、看不见的
2.4 配置 html-webpack-plugin 生成预览页面
- 安装生成预览页面的插件
npm install html-webpack-plugin –D
- 修改 webpack.config.js 文件头部区域,添加如下配置信息:
// 导入生成预览页面的插件,得到一个构造函数
const HtmlWebpackPlugin = require('html-webpack-plugin')
const htmlPlugin = new HtmlWebpackPlugin({ // 创建插件的实例对象
template: './src/index.html', // 指定要用到的模板文件
filename: 'index.html' // 指定生成的文件的名称,该文件存在于内存中,在目录中不显示
})
- 修改 webpack.config.js 文件中向外暴露的配置对象,新增如下配置节点:
module.exports = {
plugins: [ htmlPlugin ] // plugins 数组是 webpack 打包期间会用到的一些插件列表
}
2.5 配置自动打包相关的参数
// package.json中的配置
// --open 打包完成后自动打开浏览器页面
// --host 配置 IP 地址
// --port 配置端口
"scripts": {
"dev": "webpack-dev-server --open --host 127.0.0.1 --port 8888"
},
3. webpack 中的加载器
3.1 通过 loader 打包非 js 模块
在实际开发过程中,webpack 默认只能打包处理以 .js 后缀名结尾的模块,其他非 .js 后缀名结
尾的模块,webpack 默认处理不了,需要调用 loader 加载器才可以正常打包,否则会报错!
loader 加载器可以协助 webpack 打包处理特定的文件模块,比如:
less-loader 可以打包处理 .less 相关的文件
sass-loader 可以打包处理 .scss 相关的文件
url-loader 可以打包处理 css 中与 url 路径相关的文件
3.2 webpack 中加载器的基本使用
3.2.1 处理css文件
- 安装处理 css 文件的 loader
npm i style-loader css-loader -D
- 在 webpack.config.js 的 module -> rules 数组中,添加 loader 规则如下:
// 所有第三方文件模块的匹配规则
module: {
rules: [
{ test: /\.css$/, use: ['style-loader', 'css-loader'] }
]
}
其中,test 表示匹配的文件类型, use 表示对应要调用的 loader
注:
- use 数组中指定的 loader 顺序是固定的
- 多个 loader 的调用顺序是:从后往前调用
3.2.2 处理 less 文件
- 安装处理 less 文件的 loader
npm i less-loader less -D
- 在 webpack.config.js 的 module -> rules 数组中,添加 loader 规则如下:
module: {
rules: [
{ test: /\.less$/, use: ['style-loader', 'css-loader', 'less-loader'] }
]
}
3.2.3 处理 scss 文件
- 安装处理 less 文件的 loader
npm i sass-loader node-sass -D
- 在 webpack.config.js 的 module -> rules 数组中,添加 loader 规则如下:
// 所有第三方文件模块的匹配规则
module: {
rules: [
{ test: /\.scss$/, use: ['style-loader', 'css-loader', 'sass-loader'] }
]
}
3.2.4 配置 postCSS 自动添加 css 的兼容前缀
- 安装如下包:
npm i postcss-loader autoprefixer -D
- 在项目根目录中创建 postcss 的配置文件 postcss.config.js,并初始化如下配置:
const autoprefixer = require('autoprefixer') // 导入自动添加前缀的插件
module.exports = {
plugins: [ autoprefixer ] // 挂载插件
}
- 在 webpack.config.js 的 module -> rules 数组中,修改 css 的 loader 规则如下:
module: {
rules: [
{ test:/\.css$/, use: ['style-loader', 'css-loader', 'postcss-loader'] }
]
}
3.2.5 打包样式表中的图片和字体文件
- 安装如下包:
npm i url-loader file-loader -D
- 在 webpack.config.js 的 module -> rules 数组中,添加 loader 规则如下:
module: {
rules: [
{
test: /\.jpg|png|gif|bmp|ttf|eot|svg|woff|woff2$/,
use: 'url-loader?limit=16940'
}
]
}
其中 ? 之后的是 loader 的参数项。
limit 用来指定图片的大小,单位是字节(byte),只有小于 limit 大小的图片,才会被转为 base64 图片
3.2.6 打包处理 js 文件中的高级语法
- 安装babel转换器相关的包
npm i babel-loader @babel/core @babel/runtime -D
- 安装babel语法插件相关的包
npm i @babel/preset-env @babel/plugin-transformruntime @babel/plugin-proposal-class-properties –D
- 在项目根目录中,创建 babel 配置文件 babel.config.js 并初始化基本配置如下:
module.exports = {
presets: [ '@babel/preset-env' ],
plugins: [ '@babel/plugin-transform-runtime', '@babel/plugin-proposalclass-properties’ ]
}
- 在 webpack.config.js 的 module -> rules 数组中,添加 loader 规则如下:
// exclude 为排除项,表示 babel-loader 不需要处理 node_modules 中的 js 文件
{ test: /\.js$/, use: 'babel-loader', exclude: /node_modules/ }
4. Vue单文件
- 安装vue 组件的加载器
npm i vue-loader vue-template-compiler -D
- 在 webpack.config.js 配置文件中,添加 vue-loader 的配置项如下:
const VueLoaderPlugin = require('vue-loader/lib/plugin')
module.exports = {
module: {
rules: [
// ... 其它规则
{ test: /\.vue$/, loader: 'vue-loader' }
]
},
plugins: [
// ... 其它插件
new VueLoaderPlugin() // 请确保引入这个插件!
] }
5. webpack打包发布
上线之前需要通过webpack将应用进行整体打包,可以通过 package.json 文件配置打包命令:
// 在package.json文件中配置 webpack 打包命令
// 该命令默认加载项目根目录中的 webpack.config.js 配置文件
"scripts": {
// 用于打包的命令
"build": "webpack -p",
// 用于开发调试的命令
"dev": "webpack-dev-server --open --host 127.0.0.1 --port 3000",
},