一、简介
webpack 是一个现代 JavaScript 应用程序的静态模块打包器(module bundler)。主要是用来将前端资源打包、压缩、优化。
- webpack 打包原理:
当 webpack 处理应用程序时,不会根据 package.json 文件中的devDependencies 或者 Dependencies 的内容对文件进行打包。而是会根据入口文件做查询,加载其所依赖的包模块,它会递归地构建一个依赖关系图(dependency graph),其中包含应用程序需要的每个模块,然后将所有这些模块打包成一个或多个 bundle。 - 两个最核心的概念:
1.一切皆模块
正如js文件可以是一个模块(module)一样,其他的(如css、image或html)文件也可视作模块。因此,你可以require(‘myJSfile.js’)也可以require(‘myCSSfile.css’)。这意味着我们可以业务分割成更小的易于管理的片段,从而达到重复利用的目的。
2.按需加载
传统的模块打包工具(module bundlers)最终将所有的模块编译生成一个庞大的bundle.js文件。但是在真实的app里边,bundle.js文件可能有10M到15M之大,可能会导致应用一直处于加载中状态。因此Webpack使用许多特性来分割代码然后生成多个bundle文件,而且异步加载部分代码以实现按需加载。
二、安装
webpack支持使用npm 或者 yarn 方式进行安装。不推荐全局安装 webpack,这会将你项目中的 webpack 锁定到指定版本,并且在使用不同的 webpack 版本的项目中,可能会导致构建失败。本地安装可以使我们更容易对不同的项目进行分别升级。通常,webpack 通过运行一个或多个 npm scripts,会在本地 node_modules 目录中查找安装的 webpack:
"scripts": {
"start": "webpack"
}
如果使用 webpack 4+ 版本,还需要安装 CLI。webpack-cli 可以允许直接在控制台操作webpack命令。终端中输入 webpack --help,可以查看所有的帮助信息。
使用npm安装:
npm install webpack webpack-cli --save-dev
或者使用yarn安装:
yarn add webpack webpack-cli -D
三、webpack基本概念
以以下目录结构为例来了解以下webpack的基本概念:
- 入口 entry:在webpack.config.js配置文件中,通过设置entry字段的值,指定一个入口起点(或多个入口起点),不配置的话,默认入口起点为src目录下的index.js模块。
默认值为:
module.exports = {
entry: './src'
//相当于
entry:{ main:"/src/index.js" }
};
单页面配置:
module.exports = {
entry: './path/to/my/entry/file.js'
};
多页面配置:
module.exports = {
entry: {
'main': "./src/js/index.js",
'detail': "./src/js/detai.js"
}
};
- 输出output :output 属性告诉 webpack 在哪里输出它所创建的 bundles,以及如何命名这些文件,默认值为 ./dist。基本上,整个应用程序结构,都会被编译到指定的输出路径的文件夹中。可以通过在配置中指定一个 output 字段,来配置这些处理过程。
默认值为:
const path = require('path');
module.exports = {
output: {
//path需要为绝对路径
path: path.resolve(__dirname, './dist'),
filename: 'main.js'
}
};
自定义配置:output 的 filename属性中,使用[name]来表示entry中的key;使用[hash],会自动在文件名称后面添加hash值,并直接关联到html模板文件中。
const path = require('path');
module.exports = {
entry: {
'main': "./src/js/index.js",
'detail': "./src/js/detai.js"
},
output: {
path: path.resolve(__dirname, './dev'),
filename: '[name]-[hash].js'
},
};
- loader:loader 让 webpack 能够去处理那些非 JavaScript 文件(webpack 自身只理解 JavaScript)。简单来说,loader 就是一个翻译官,将浏览器不认识的语言,转化为浏览器能解析的语言,loader使用之前需要先安装。loader 能够 import 导入任何类型的模块(例如 .scss 文件),这是 webpack 特有的功能,其他打包程序或任务执行器的可能并不支持。
webpack.config.js文件:
module.exports = {
module: {
rules: [
{
test: /\.s[ac]ss$/,
//当 use 里有多个loader时,执行的顺序为从右向左
use: [
// 将 JS 字符串生成为 style 节点,插入html中,生成内联样式
'style-loader',
//将 CSS 转化成 CommonJS 模块,可以直接使用import/require导入
'css-loader',
//把.scss文件文件转换为.css文件
'sass-loader'
]
}
]
}
};
在webpack.config.js文件中,对一个单独的 module 对象定义了 rules 属性,里面包含两个必须属性:test 和 use。这告诉 webpack 编译器(compiler) 如下信息:当编译器碰到「在 require()/import 语句中被解析为 ‘.sass/.scss’ 的路径」时,在对它打包之前,先使用 sass-loader、css-loader、style-loader 转换一下。最终.scss文件会被转成内联样式,插入html页面中。
- plugins 插件:loader 被用于转换某些类型的模块,而插件则可以用于执行范围更广的任务,插件的范围包括,从打包优化和压缩,一直到重新定义环境中的变量。想要使用一个插件,只需要 require() 它,然后把它添加到 plugins 数组中。多数插件可以通过选项(option)自定义,也可以在一个配置文件中因为不同目的而多次使用同一个插件,这时需要通过使用 new 操作符来创建它的一个实例。
webpack.config.js文件:
//html-webpack-plugin 将html模板文件和js文件整合到一起
const htmlWebpackPlugin = require('html-webpack-plugin');
module.exports = {
plugins: [
new HtmlWebpackPlugin({
//模板文件路径
template: "./src/views/index.html",
//自动存储到output 配置的目录
filename: 'index.html',
chunks: ['main']
})
]
};
html-webpack-plugin 插件的作用是将html模板文件和js文件整合到一起,如果是多页面应用,则每个页面都需要有对应的new HtmlWebpackPlugin()。webpack在编译的时候,会把所有的 js 合并输出在一个js文件,而设置 chunks 属性的目的,就是让当前页面模板只加载当前页面所需要的模块。上面的写法表示,在编译./src/views/index.html 时,只需要加载main.js文件。
四、webpack配置
- mode 模式
mode 配置选项,告知 webpack 使用相应模式的内置优化。有两个值:development(开发模式不会对代码做压缩、优化,方便代码调试,会将 process.env.NODE_ENV 的值设为 development)和production(生产模式下会对代码做压缩、优化,会将 process.env.NODE_ENV 的值设为 production)。如果不配置mode,会有警告信息,但是不影响项目运行。
module.exports = {
mode:"development",
};
- devtool
开发模式通常配合devtool使用,可以在浏览器的控制台看到源代码,而不是解析后的代码。
module.exports = {
//代码调试,可以看到源代码
devtool: 'inline-source-map',
};
- webpack-dev-server
在开发模式下,新建一个开发服务器,并且当代码更新的时候自动刷新浏览器。可以使用webpack-dev-server插件。直接使用webpack执行,会对文件进行打包,并输出在指定目录下,默认为./dev下。使用webpack-dev-server执行,文件会放在内存里,不会生成整合后的文件,也不会将文件输出到指定目录里。
在webpack.config.js文件中配置
module.exports = {
devServer:{
contentBase:"./dist", //设置Http服务器的文件根目录
port:8088, //端口
open:true, //是否打开浏览器
proxy: { //配置代理
"/api": {
target: "http://localhost:3000",
pathRewrite: {"^/api" : ""}
}
}
}
};
- webpack.config.js
一个开发模式下,完整的webpack.config.js文件内容如下:
const path=require("path");
//将html模板和js文件整合在一起
const htmlWebpackPlugin=require("html-webpack-plugin");
//将css样式提取出来,使用Link标签导入
const miniCssExtractPlugin=require("mini-css-extract-plugin");
//将静态资源打包到输出目录中
const copyWebpackPlugin=require("copy-webpack-plugin");
module.exports={
mode:"development",
devtool:"inline-source-map",
entry:"./src/js/index.js",
output:{
path:path.resolve(__dirname+"./dev"),
filename:"[name]-[hash].js"
},
devServer:{
port:8088,
open:true,
proxy: { //配置代理
"/api": {
target: "http://localhost:3000",
pathRewrite: {"^/api" : ""}
}
}
},
plugins:[
new htmlWebpackPlugin({
title:"demo title",
template:"./src/views/index.html",
filename:"index.html",
chunks:["main"]
}),
new miniCssExtractPlugin({
filename:"[name]-[hash].css"
}),
new copyWebpackPlugin([
{from:"./src/static",to:"./static"}
])
],
module:{
rules:[
{
test:/\.s[ac]ss$/,
use:[
miniCssExtractPlugin.loader,
"css-loader",
"sass-loader"
]
},
{
test:/\.html$/,
use:["string-loader"]
}
]
}
}
package.json文件内容如下:
{
"name": "admin-fe",
"version": "1.0.0",
"description": "",
"main": "index.js",
"scripts": {
"dev": "webpack-dev-server --config webpack.config.js"
},
"keywords": [],
"author": "",
"license": "ISC",
"dependencies": {
"handlebars": "^4.7.3",
"sme-router": "^0.12.8"
},
"devDependencies": {
"copy-webpack-plugin": "^5.1.1",
"css-loader": "^3.4.2",
"html-webpack-plugin": "^4.0.1",
"mini-css-extract-plugin": "^0.9.0",
"node-sass": "^4.13.1",
"sass-loader": "^8.0.2",
"string-loader": "^0.0.1",
"style-loader": "^1.1.3",
"webpack": "^4.42.1",
"webpack-cli": "^3.3.11",
"webpack-dev-server": "^3.10.3"
}
}
五、webpack优势
与其他的构建工具相比,webpack具有如下的一些优势:
- 对 CommonJS 、 AMD 、ES6 的语法做了兼容
- 对 js、css、图片等资源文件都支持打包
- 串联式模块加载器以及插件机制,让其具有更好的灵活性和扩展性,例如提供对 CoffeeScript、ES6的支持
- 有独立的配置文件 webpack.config.js
- 可以将代码切割成不同的 chunk,实现按需加载,降低了初始化时间
- 支持 SourceUrls 和 SourceMaps,易于调试
- 具有强大的 Plugin 接口,大多是内部插件,使用起来比较灵活
- webpack 使用异步 IO 并具有多级缓存,这使得 webpack 很快且在增量编译上更加快