Webpack
Webpack
1. webpack简介
1.1 Webpack
webpack 是一种前端资源构建工具,一个静态模块打包器(module bundler)。
在 webpack 看来, 前端的所有资源文件(js/json/css/img/less/...)都会作为模块处理。
它将根据模块的依赖关系进行静态分析,打包生成对应的静态资源(bundle)。
1.2 webpack 五个核心概念
1.2.1 Entry
入口(Entry)指示 webpack 以哪个文件为入口起点开始打包,分析构建内部依赖图。
1.2.2 Output
输出(Output)指示 webpack 打包后的资源 bundles 输出到哪里去,以及如何命名。
1.2.3 Loader
Loader 让 webpack 能够去处理那些非 JavaScript 文件 (webpack 自身只理解 JavaScript)
1.2.4 Plugins
插件(Plugins)可以用于执行范围更广的任务。插件的范围包括,从打包优化和压缩,一直到重新定义环境中的变量等。
1.2.5 Mode
模式(Mode)指示 webpack 使用相应模式的配置。
选项 | 描述 | 特点 |
---|---|---|
development | 会将 DefinePlugin 中 p | 能让代码本地调试运行的环境 |
production | 会将 DefinePlugin 中 p | 能让代码优化上线运行的环境 |
2. 使用 Webpack
2.1 安装
webpack 可以在项目中进行本地的安装,也可以进行全局的安装,一般我们都是使用本地安装的 webpack
# 先初始化项目
npm init -y
# 本地安装,webpack4.x中需要同时安装webpack和webpack-cli
npm i webpack webpack-cli -D
# 项目根目录自行创建webpack.config.js文件
**注:**webpack 可以进行零配置,也就是说安装好之后就可以直接进行打包命令,使用npx webpack
就可以直接让 webpack 进行打包了,默认会找到根目录下的src
目录下的index.js
进行打包(默认只支持 js 模块),打包后会生成一个dist
目录,打包后的 js 文件会整合到一个main.js
文件中
2.2 编译打包应用
创建文件
运行指令
开发环境指令:webpack src/js/index.js -o build/js/built.js --mode=development
功能:webpack 能够编译打包 js 和 json 文件,并且能将 es6 的模块化语法转换成浏览器能识别的语法。
生产环境指令:webpack src/js/index.js -o build/js/built.js --mode=production
功能:在开发配置功能上多一个功能,压缩代码。
结论
webpack 能够编译打包 js 和 json 文件。
能将 es6 的模块化语法转换成浏览器能识别的语法。能压缩代码。
问题
不能编译打包 css、img 等文件。不能将 js 的 es6 基本语法转化为 es5 以下语法。
3. 配置 Webpack
webpack 默认的零配置功能很弱,所以大多数时候都是需要我们手动进行配置
3.1 运行打包命令
在 webpack 中默认的配置文件是webpack.config.js
或者是webpackfile.js
,一般情况下会选择前者。
当然,我们也可以手动控制 webpack 执行自定义命名的配置文件
使用npx webpack --config
自定义的配置文件名就能手动控制 webpack 找到对应的配置文件
一般情况下,我们打包都是通过npm run bulid
这样的方法进行配置的,这种就需要在package.json
中自己配置自定义脚本了,在下面的scripts
中配置脚本
{
"name": "webpack",
"version": "1.0.0",
"description": "",
"main": "index.js",
"scripts": {
"build": "webpack --config webpack.config.js",
"test": "echo \"Error: no test specified\" && exit 1"
},
"keywords": [],
"author": "",
"license": "ISC",
"devDependencies": {
"webpack": "^4.39.2",
"webpack-cli": "^3.3.6"
}
}
注:
在自定义的脚本中运行 webpack 的指令前面后面写参数就不需要加上
npx
了也可以直接只在 build 后面写一个 webpack,在打包的时候传入参数就行了(不过一般我们不会这么做),不过不能普通地进行拼接,还需要在
npm run build
后面加上两个--
才能正常传参,如npm run build --config webpack.config.js
,不然 npm 并不会认为后面传的东西是一个参数
3.2 基础配置
3.2.1 一般配置
webpack 是 node 写出来的,所以我们需要使用 node 的语法来进行配置,下面是 webpack 的基本配置,仅能够对 js 文件进行打包
// webpack.config.js
// node内置核心模块,用来处理路径问题。
let path = require("path");
// 开始配置
module.exports = {
/**
* mode是打包后的模式,默认有两种,production和development
* production模式会压缩代码,是生产环境后打包的
* 而development不会压缩代码,便于开发者观察打包后的结果
*/
mode: "development", // 这个模式只对压缩的js文件有效
entry: "./src/index.js", // 打包程序的入口
output: {
filename: "main.js", // 打包后的文件名
/**
* filename: 'main.[hash].js',生成hash文件名,写成这种方式可以防止覆盖和缓存,每次生成的文件都不一样
* filename: 'main.[hash:8].js'// 生成8位的hash文件名
*/
path: path.resolve(__dirname, "dist"),
/**
* 打包后的路径,注意,该路径必须是绝对路径
* path.resolve方法会将生成的文件路径拼接成一个绝对路径,该路径默认是以整个系统盘为路径的
* 可以在前面加一个__dirname参数改变成以当前根目录为绝对路径
*/
},
};
webpack 中三种三种 hash 值区别:webpack 三种哈希区别
3.2.1 简单打包后的文件
这个如果不想了解原理可略过
(function(modules) {
// webpackBootstrap
// The module cache 先定义一个缓存
var installedModules = {};
// The require function 配置实现了require函数
function __webpack_require__(moduleId) {
// 参数"./src/index.js"
// Check if module is in cache 模块是否在缓存中
if (installedModules[moduleId]) {
return installedModules[moduleId].exports;
}
// Create a new module (and put it into the cache)
var module = (installedModules[moduleId] = {
i: moduleId,
l: false,
exports: {},
});
// Execute the module function 执行传入this指向,模块,模块的空对象exports: {},require方法
modules[moduleId].call(
module.exports,
module,
module.exports,
__webpack_require__
);
// Flag the module as loaded
module.l = true;
// Return the exports of the module
return module.exports;
}
// expose the modules object (__webpack_modules__)
__webpack_require__.m = modules;
// expose the module cache
__webpack_require__.c = installedModules;
// define getter function for harmony exports
__webpack_require__.d = function(exports, name, getter) {
if (!__webpack_require__.o(exports, name)) {
Object.defineProperty(exports, name, { enumerable: true, get: getter });
}
};
// define __esModule on exports
__webpack_require__.r = function(exports) {
if (typeof Symbol !== "undefined" && Symbol.toStringTag) {
Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
}
Object.defineProperty(exports, "__esModule", { value: true });
};
// create a fake namespace object
// mode & 1: value is a module id, require it
// mode & 2: merge all properties of value into the ns
// mode & 4: return value when already ns object
// mode & 8|1: behave like require
__webpack_require__.t = function(value, mode) {
if (mode & 1) value = __webpack_require__(value);
if (mode & 8) return value;
if (mode & 4 && typeof value === "object" && value && value.__esModule)
return value;
var ns = Object.create(null);
__webpack_require__.r(ns);
Object.defineProperty(ns, "default", { enumerable: true, value: value });
if (mode & 2 && typeof value != "string")
for (var key in value)
__webpack_require__.d(
ns,
key,
function(key) {
return value[key];
}.bind(null, key)
);
return ns;
};
// getDefaultExport function for compatibility with non-harmony modules
__webpack_require__.n = function(module) {
var getter =
module && module.__esModule
? function getDefault() {
return module["default"];
}
: function getModuleExports() {
return module;
};
__webpack_require__.d(getter, "a", getter);
return getter;
};
// Object.prototype.hasOwnProperty.call
__webpack_require__.o = function(object, property) {
return Object.prototype.hasOwnProperty.call(object, property);
};
// __webpack_public_path__
__webpack_require__.p = "";
// Load entry module and return exports
return __webpack_require__((__webpack_require__.s = "./src/index.js")); // 传入入口模块
})(
// 自执行函数传入一个对象即modules
{
// key
"./src/a.js": function(module, exports) {
// value
eval(
"module.exports = 'a_moudle'\n\n//# sourceURL=webpack:///./src/a.js?"
);
},
"./src/index.js": function(module, exports, __webpack_require__) {
eval(
'let str = __webpack_require__(/*! ./a.js */ "./src/a.js")\r\n\r\nconsole.log(str)\n\n//# sourceURL=webpack:///./src/index.js?'
);
},
}
);
3.2.2 实时打包
如果想要 webpack 监听工作区中文件的改变而实时的打包出新的代码,可以使用 webpack 自带的 watch 选项
// webpack.config.js
module.exports = {
watch: true,
// 监听的配置项
watchOptions: {
poll: 1000 // 每秒询问100次
aggregateTimeout: 500, //防抖
ignored: /node_modules/ //忽略文件
}
}
3.3 本地服务
在之前的打包过程中我们只能通过打包好文件然后双击文件来在浏览器中运行打包后的代码,而我们再开发的时候更希望能通过本地服务器的方式进行访问,这时候我们需要借助第三方插件来生成这个服务,在 webpack 中内置了一个开发服务webpack-dev-server
**注意:**该服务进行的不是实际的打包,所以不会在 dist 目录中生成文件,而是进行的内存打包,生成的文件之间运行在服务器上,我们是看不到这些文件的,在实际开发中我们都是用的这种内存的打包
npm i webpack-dev-server -D
安装完成后运行npx webpack-dev-server
就能开启该服务(一般也是在 package.json 文件中配置自己的脚本,如npm run dev
),默认的端口为localhost:8080
,当然也可以在webpack.config.js
配置文件中进行配置,服务配置写在devServer
中
{
"name": "webpack",
"version": "1.0.0",
"description": "",
"main": "webpack.config.js",
"scripts": {
"dev": "webpack-dev-server",
"build": "webpack --config webpack.config.js",
"test": "echo \"Error: no test specified\" && exit 1"
},
"keywords": [],
"author": "",
"license": "ISC",
"devDependencies": {
"webpack": "^4.39.2",
"webpack-cli": "^3.3.7",
"webpack-dev-server": "^3.8.0"
}
}
// webpack.config.js
module.exports = {
// 开发服务器的配置
devServer: {
port: 3000, // 改变开启的端口号
progress: true, // 开启内存打包中的进度条,这样我们能清楚地看到打包的进程
open: true, // 自动打开浏览器
contentBase: "./build",
/**
* 内存打包指向的目录
* 开启服务器指向的入口打包文件的地址
* 默认是index.html文件,到目前需要自己创建该html文件和引入对应打包后的js文件,之后会有自动创建
*/
compress: true, //压缩
},
};
**注意:**上面的contentBase
对应的路径中一定要有这个 html 文件,不然就会找不到,但是我们在实际开发中其实是没有这个文件的,也不会打包好后再去开启服务,我们希望的是在启动服务时自动在内存中创建这个文件,这样我们就能在服务端上直接访问了,这个时候我们就需要一个 html 插件解决这个问题
3.4 支持模板 html
使用第三方的 webpackl 插件html-webpack-plugin
可以帮我们自动建立一个模板 html 文件打包到内存中,然后将主要要打包的文件加入到我们设置的模板 html(设置的模板 html 文件中的代码会原封不动的打包输出,所有的配置文件只是针对格式的,内部并不会发生变化,也就是说连注释都会输出过去)里面,并且把结果放在devServer
指定的打包指定目录下
npm i html-webpack-plugin -D
安装完成后,在plugins
内部添加一个对象来实现使用
let HTMLWebpackPlugin = require("html-webpack-plugin");
module.exports = {
// plugins是一个数组,放着所有的webpack插件,注意是从下到上,如果有关联项需要考虑位置
plugins: [
new HTMLWebpackPlugin({
template: "./src/index.html", // html模板,会去找到这个模板
filename: "index.html", // 打包后的文件名,默认不写也是index.html
// 对打包的html模板进行压缩
minify: {
removeAttributeQuotes: true, // 删除属性的双引号,除了一些特殊的删除不了以外都能删除
collapseWhitespace: true, // 折叠空行将所有代码变成一行
removeComments: true, // 移除注释
},
hash: true, // 给打包后在模板中引入的文件名生成hash戳,防止缓存
}),
],
};
其余具体的插件参数选项见:html-webpack-plugin#options
<!--打包前的模板-->
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta http-equiv="X-UA-Compatible" content="ie=edge" />
<title>Document</title>
</head>
<body>
<!-- 模板 -->
</body>
</html>
<!--加了上述参数后打包后的文件-->
<!DOCTYPE html><html lang=en><head><meta charset=UTF-8><meta name=viewport content="width=device-width,initial-scale=1"><meta http-equiv=X-UA-Compatible content="ie=edge"><title>Document</title></head><body><!-- 模板 --><script type=text/javascript src=main.js?9a08db68a07b35e1f58a></script></body></html>
3.5 样式处理
在进行引入样式处理时也需要进行额外的配置,需要在module
模块中写入对应的 css 规则,给对应匹配上的规则添加 loader,然后直接在入口的 js 文件中使用引用模块 import 或 require 引用文件即可(不引用是不会打包的)
**注意:**该 css 的 loader 会将解析后的 css 内容插入到页面 head 标签的最后,如果自己写了对于的 css 样式可能会覆盖掉,如果想要自己在模板 html 中写的样式生效,可以在style-loader
的 options 选项中改变样式插入到模板 html 的 head 标签的位置(暂时只能通过这种样式写法,后面会有抽离成文件的插件)
loader 的用法
如果只有一个 loader,可以写成单个字符串
如果有多个 loader,需要写成字符串数组
loader 还可以写成对象的形式,
loader
属性对应要写的 loader,而还有一个 options 属性则是可以传入对应的参数loader 的顺序默认是从右向左,从下到上执行(执行顺序非常重要,如必须要先执行
css-loader
才能执行style-loader
)
3.5.1 处理 css
处理普通的 css 文件只需要下载 css-loader 与 style-loader 就可以实现
npm i css-loader style-loader -D
module.exports = {
// 模块配置
module: {
// 配置规则
rules: [
/**
* css-loader解析css中的语法,如@import这种
* style-loader用于把css插入到模板html的head标签中
* 至于为什么要两个,是因为loader的能力尽量要求单一
*/
{
// 匹配css结尾的文件
test: /\.css$/,
use: [
{
// 创建style标签,将js的样式资源插入进行,添加到head中生效
loader: "style-loader",
options: {
// 改变样式插入的位置为head标签的顶部
insertAt: "top",
},
},
// 将css变成commonjs模块加入到js中,里面的内容是字符串
"css-loader", // 主要解析@import这种路径
],
},
],
},
};
3.5.2 处理 css 预处理器
使用 css 预处理器除了要下载 css-loader 与 style-loader,还需要额外下载对应预处理器需要的 loader,如sass-loader
、less-loader
与stylus-loader
,用法都相同,这里仅以 less 为例
# 下载less-loader肯定是要使用less的,所以一般是一起下载了
npm i less less-loader -D
# 下载scss-loader肯定是要使用scss的,所以一般是一起下载了
npm i scss scss-loader -D
module.exports = {
// 模块配置
module: {
// 配置规则
rules: [
/**
* css-loader解析css中的语法,如@import这种
* style-loader用于把css插入到模板html的head标签中
* 至于为什么要两个,是因为loader的能力尽量要求单一
*/
{
// 匹配css结尾的文件
test: /\.css$/,
use: [
{
// 创建style标签,将js的样式资源插入进行,添加到head中生效
loader: "style-loader",
options: {
// 改变样式插入的位置为head标签的顶部
insertAt: "top",
},
},
// 将css变成commonjs模块加入到js中,里面的内容是字符串
"css-loader", // 主要解析@import这种路径
],
},
// 可以解析less文件
{
test: /\.less$/,
use: [
{
loader: "style-loader",
options: {
// 改变样式插入的位置为head标签的顶部
insertAt: "top",
},
},
"css-loader", // 主要解析@import这种路径
"less-loader", // 主要把less转换为css
],
},
// 可以解析scss文件
{
test: /\.scss$/,
use: [
{
loader: "style-loader",
options: {
// 改变样式插入的位置为head标签的顶部
insertAt: "top",
},
},
"css-loader", // 主要解析@import这种路径
"scss-loader", // 主要把less转换为css
],
},
],
},
};
其余的 less-loader 的配置详见:less-loader
3.5.3 抽离样式
默认情况下样式文件是放在 js 中的,如果想要将添加到 html 模板中的 css 样式单独作为一个文件抽离出来,自动通过 link 标签进行引入,还需要引入专门抽离 css 样式的插件mini-css-extract-plugin
npm i mini-css-extract-plugin -D
// 引入插件
let MiniCssExtractPlugin = require('mini-css-extract-plugin')
module.exports = {
plugins: [
/*
注意,如果想要分为多个不同的css文件,那么就require引入多次插件,取不同的名字,然后都在这使用,通常这种方式是要区分各个预处理器转换后的文件
*/
new MiniCssExtractPlugin({
filename: 'css/main.css' //要抽离后在打包后目录中的文件名
})
],
module: {
{
test: /\.css$/,
use: [
// 将style-loader替换为插件的loader,因为style-loader是将js中的css变成style标签插入html中
// MiniCssExtractPlugin.loader, 可以直接这样写,这个loader直接是个字符串
{
loader: MiniCssExtractPlugin.loader
},
'css-loader' //主要解析@import这种路径
]
}
]
}
}
其余 mini-css-extract-plugin 的配置信息详见:mini-css-extract-plugin
3.5.4 压缩 css 与 js
通过改变压缩项
要压缩抽离出来
mini-css-extract-plugin
的 css 文件就必须要打乱 webpack 默认的压缩 js 文件的规则(webpackl 默认调用了一个压缩 js 的插件 terser-webpack-plugin 进行压缩),这时候压缩 js 文件需要直接引用插件来进行优化注意:
要看到压缩效果需要改为生产环境观察,否则如果是开发环境将直接跳过优化项
# terser-webpack-plugin不需要安装,webpack本身就自带了 npm i optimize-css-assets-webpack-plugin -D
//这三个插件进行组合可以打包压缩css和js
let MiniCssExtractPlugin = require("mini-css-extract-plugin");
let TerserJSPlugin = require("terser-webpack-plugin");
let OptimizeCSSAssetsPlugin = require("optimize-css-assets-webpack-plugin");
module.exports = {
// 优化代码属性
optimization: {
// 压缩代码的选项,传入压缩js与压缩css的插件
minimizer: [new TerserJSPlugin({}), new OptimizeCSSAssetsPlugin({})],
},
plugins: [
/*
注意,如果想要分为多个不同的css文件,那么就require引入多次插件,取不同的名字,然后都在这使用,通常这种方式是要区分各个预处理器转换后的文件
*/
new MiniCssExtractPlugin({
filename: "main.css", //要抽离后的文件名
}),
],
module: {
rules: [
{
test: /\.css$/,
use: [
{
loader: MiniCssExtractPlugin.loader,
},
"css-loader",
],
},
],
},
};
通过插件引入
let MiniCssExtractPlugin = require("mini-css-extract-plugin"); let OptimizeCSSAssetsPlugin = require("optimize-css-assets-webpack-plugin"); module.exports = { plugins: [ /* 注意,如果想要分为多个不同的css文件,那么就require引入多次插件,取不同的名字,然后都在这使用,通常这种方式是要区分各个预处理器转换后的文件 */ new MiniCssExtractPlugin({ filename: "main.css", //要抽离后的文件名 }), // 压缩css new OptimizeCSSAssetsPlugin(), ], module: { rules: [ { test: /\.css$/, use: [ { loader: MiniCssExtractPlugin.loader, }, "css-loader", ], }, ], }, };
3.5.5 添加浏览器前缀
一般来说处理 css 相关的文件以及转换,我们都会使用postcss
一系列的插件
使用 postcss-loader 与 postcss-preset-env
npm i postcss-loader postcss-preset-env -D
let MiniCssExtractPlugin = require("mini-css-extract-plugin"); // postcss默认会找browserslist中的production的配置项,如果想要使用开发环境的配置项,需要设置NODE_ENV process.env.NODE_ENV = "development"; module.exports = { module: { rules: [ { test: /\.css$/, use: [ { loader: MiniCssExtractPlugin.loader, }, "css-loader", { // 帮postcss找到package.json中的browserslist里面的配置来加载执行兼容样式 loader: "postcss-loader", options: { ident: "postcss", plugins: () => { //postcss插件 require("postcss-preset-env")(); }, }, }, ], }, ], }, };
{ "browserslist": { "development": [ "last 1 chrome version", "last 1 firefox version", "last 1 safari version", ], "production": [ ">0.2%", "not dead", "not op_mino all" ] } }
要为打包后的 css 文件自动兼容其余浏览器(也就是要在前面添加前缀),需要引入 postcss-loader 与 css 优化插件 autoprefixer
#postcss-loader是专门优化css的loader,而autoprefixer只是其中的一个插件
npm i postcss-loader autoprefixer -D
let MiniCssExtractPlugin = require("mini-css-extract-plugin");
module.exports = {
module: {
rules: [
{
test: /\.css$/,
use: [
{
loader: MiniCssExtractPlugin.loader,
},
"css-loader",
"postcss-loader",
//postcss-loader自动为浏览器添加前缀,不过需要先处理这个loader再处理css-loader
],
},
//可以解析less文件
{
test: /\.less$/,
use: [
{
loader: "style-loader",
options: {
//改变样式插入的位置为head标签的顶部
insertAt: "top",
},
},
"css-loader",
"postcss-loader", //要处理less文件也是一样
"less-loader",
],
},
],
},
};
上面只是分配了 postcss-loader,下面还需要处理 postcss-loader 对应的插件,postcss-loader 需要我们有一个postcss.config.js
的文件来处理该 loader
// postcss.config.js`
module.exports = {
plugins: [
//导出postcss-loader需要的插件,该插件属性是一个数组,装有需要解析的插件
require("autoprefixer")({ overrideBrowserslist: ["last 10 versions"] }),
// 引入并直接使用autoprefixer,方法的对象参数是对应要支持的浏览器版本,具体看文档
],
};
其余 postcss-loader 的配置信息详见:postcss-loader
3.6 高级 js 转换 ES5
将高级的 js 转换为 ES5 都需要用到 babel
# 需要使用babel-loader对高级语法进行转换,@babel/core 则是babel核心模块,调用transform方法进行转换
npm i babel-loader @babel/core -D
3.6.1 基本转换
将 ES6 转换为 ES5 还需要配置 babel 的转换模块@babel/preset-env
,该模块将一些标准的 js 语法转换为低级的语法
#所以要ES6转换为ES5需要这三个
npm i babel-loader @babel/core @babel/preset-env -D
let path = require("path");
module.exports = {
module: {
rules: [
{
test: /\.js$/,
use: {
loader: "babel-loader",
options: {
//用babel-loader需要把ES6转换为ES5,为loader添加预设选项,该选项就能解决狭义的ES6语法
presets: ["@babel/preset-env"],
cacheDirectory: true, // 开启babel缓存,第二次构建时会读取之前的缓存
},
},
// 这里的js转换只包括src目录下的
include: path.resolve(__dirname, "src"),
// 排除node_modules目录
exclude: /node_modules/,
},
],
},
};
**注意:**只是用@babel/preset-env
只能转换基本的 ES6 语法,很多高级 api 是不能转换的,比如 Promise
3.6.2 全部转换
**babel 默认只会转换内置的高级的语法,但是不能转换该语法内置的 api,就算转换了内置的 api 也不会内置转换的方法,**也就是说一些高级的 js 语法是由低级语法的 api 实现的,但是 babel 只是将该 api 转换了出来,但是低级的 api 本身不在代码中,**这时候还需要用到一个插件包@babel/plugin-transform-runtime
,**该插件是一个开发时用的插件,但是,如果要上线还会为生产后的代码中输出一些脚本,这时,还需要另外一个@babel/runtime
在上线的时候为我们添加该插件(注意这个插件是要在生产环境使用的,因为我们是要转换到生产环境使用的,需要--save
)
npm i @babel/plugin-transform-runtime -D
npm i @babel/runtime -S
let path = require("path");
module.exports = {
module: {
rules: [
{
test: /\.js$/,
use: {
loader: "babel-loader",
options: {
presets: ["@babel/preset-env"],
plugins: [
["@babel/plugin-proposal-decorators", { legacy: true }],
["@babel/plugin-proposal-class-properties", { loose: true }],
"@babel/plugin-transform-runtime",
],
},
},
},
],
},
};
但是,上面的方法不能够解决高级的实例方法,如arr.includes()
。
如果想解决这个问题,只需要一个@babel/polyfill
模块(可以不使用@babel/plugin-transform-runtime
了),还是因为是要在生产环境中使用,并且该模块会在代码中使用,所有我们使用--save
使用@babel/polyfill
将 ES6 的语法全部兼容
# 该插件不是在webpack中配置,而是在入口js文件前直接引入即可
npm i @babel/polyfill -S
// index.js
import "@babel/polyfill";
**使用问题:**该方法会将所有的高级 js 语法全部转换,会造成项目体积过大的问题,如果只想解决部分兼容性问题并不推荐这样做
3.6.3 按需转换
因为使用@babel/polyfill
兼容所有 ES6 语法会有项目体积过大的问题,我们可以使用按需加载的方法来处理,使用core-js
插件
npm i core-js -D
module.exports = {
module: {
rules: [
{
test: /\.js$/,
use: {
loader: "babel-loader",
options: {
presets: [
"@babel/preset-env",
{
// 按需加载
useBuiltIns: "usage",
// 指定core-js版本
corejs: {
version: 3,
},
// 指定兼容哪个版本浏览器
targets: {
chrome: "60",
firefox: "60",
ie: "9",
safari: "10",
edge: "17",
},
},
],
},
},
},
],
},
};
3.6.4 ES7 转换为 ES5
如果要兼容一些 ES6 以上的语法,需要按照对应语法解析的插件,如 ES7 的在类中 constructor 外直接写实例属性、使用装饰器修饰类
@log
class A {
a = 1;
}
let a = new A();
console.log(a.a);
function log(target) {
console.log(target);
}
这种语法需要@babel/plugin-proposal-class-properties
这个类的转换插件和@@babel/plugin-proposal-decorators
这个装饰器插件
# 解析ES7类的语法与装饰器语法
npm i @babel/plugin-proposal-class-properties @babel/plugin-proposal-decorators -D
let path = require("path");
module.exports = {
module: {
rules: [
{
test: /\.js$/,
use: {
loader: "babel-loader",
options: {
//用babek-loader需要把ES6转换为ES5
presets: ["@babel/preset-env"],
// 预设是一个大插件的集合,在预设下我们还可以自己配置自己需要的小插件
plugins: [
//'@babel/plugin-proposal-class-properties', 如果只解析类可以直接写字符串这样写
["@babel/plugin-proposal-decorators", { legacy: true }],
["@babel/plugin-proposal-class-properties", { loose: true }],
/*
上面如果要解析修饰类的装饰器必须使用这种顺序,也就是必须先解析class语法,否则会报错
*/
],
},
},
},
],
},
};
3.7 语法校验
3.7.1 Eslint
语法校验在我们编程中其实很常见,使用 ESLint 就能帮我们校验代码,ESLint 与 css 和 js 一样都需要配置想要的 loader
npm i eslint eslint-loader -D
eslint 需要一个自己制定的校验代码的规则,需要创建一个.eslintrc.json
的配置文件,下面是一个 eslint 项目的配置文件
{
"parserOptions": {
"ecmaVersion": 5,
"sourceType": "script",
"ecmaFeatures": {}
},
"rules": {
"constructor-super": 2,
"for-direction": 2,
"getter-return": 2,
"no-async-promise-executor": 2,
"no-case-declarations": 2,
"no-class-assign": 2,
"no-compare-neg-zero": 2,
"no-cond-assign": 2,
"no-const-assign": 2,
"no-constant-condition": 2,
"no-control-regex": 2,
"no-debugger": 2,
"no-delete-var": 2,
"no-dupe-args": 2,
"no-dupe-class-members": 2,
"no-dupe-keys": 2,
"no-duplicate-case": 2,
"no-empty": 2,
"no-empty-character-class": 2,
"no-empty-pattern": 2,
"no-ex-assign": 2,
"no-extra-boolean-cast": 2,
"no-extra-semi": 2,
"no-fallthrough": 2,
"no-func-assign": 2,
"no-global-assign": 2,
"no-inner-declarations": 2,
"no-invalid-regexp": 2,
"no-irregular-whitespace": 2,
"no-misleading-character-class": 2,
"no-mixed-spaces-and-tabs": 2,
"no-new-symbol": 2,
"no-obj-calls": 2,
"no-octal": 2,
"no-prototype-builtins": 2,
"no-redeclare": 2,
"no-regex-spaces": 2,
"no-self-assign": 2,
"no-shadow-restricted-names": 2,
"no-sparse-arrays": 2,
"no-this-before-super": 2,
"no-undef": 2,
"no-unexpected-multiline": 2,
"no-unreachable": 2,
"no-unsafe-finally": 2,
"no-unsafe-negation": 2,
"no-unused-labels": 2,
"no-unused-vars": 2,
"no-useless-catch": 2,
"no-useless-escape": 2,
"no-with": 2,
"require-atomic-updates": 2,
"require-yield": 2,
"use-isnan": 2,
"valid-typeof": 2
},
"env": {}
}
module.exports = {
module: {
rules: [
{
test: /.js$/,
use: {
loader: "eslint-loader",
//我们应该先校验js再转换为ES5代码,所以正常来说这个应该写在下面,也就是要先执行
options: {
fix: true, //自动修复
enforce: "pre", //previous,强制让这个loader在最先执行,还可以写post让这个loader强制最后执行
},
},
exclude: /node_modules/, //不检验node_modules中的代码
},
//相同的loader可以写多个,符合从上到下,从左到右的默认规则
{
test: /\.js$/,
use: {
loader: "babel-loader", //普通的loader
options: {
presets: ["@babel/preset-env"],
plugins: [
["@babel/plugin-proposal-decorators", { legacy: true }],
["@babel/plugin-proposal-class-properties", { loose: true }],
"@babel/plugin-transform-runtime",
],
},
},
include: path.resolve(__dirname, "src"),
exclude: /node_modules/,
},
],
},
};
3.7.2 使用 airbnb 风格
airbnb 是一个非常有名的 js 风格语法,我们可以使用 eslint 来让我们书写的代码符合这种规范
npm i eslint-loader eslint eslint-config-airhnb-base eslint-plugin-import-eslint -D
module.exports = {
rules: [
{
test: /\.js$/,
exclude: /node_modules/,
loader: "eslint-loader",
options: {
fix: true,
},
},
],
};
然后需要在package.json
中增加:
{
"eslintConfig": {
"extend": "airbnb-base",
"env": {
"browser": true // 支持浏览器的全局变量
}
}
}
3.8 全局变量引入
在 webpack 中引入全局变量主要有四种形式:
直接引入全局变量后使用 window 来接收全局变量
使用
expose-loader
将全局变量暴露给 window 对象和模块中,也就是说使用这个在所有模块都可以使用window.暴露对象
或直接使用暴露对象使用
webpack.providePlugin
插件为每个模块注入全局对象(此时并没有挂载到 window 上,只是为每个模块注入了全局变量)在模板 html 中通过 script 标签引入
**注:**这里的全局变量都以 jquery 的$符合为例
npm i jquery -S
3.8.1 直接接收
// index.js
import $ from "jquery";
window.$ = $;
conosle.log(window.$);
3.8.2 使用 expose-loader
expose-loader 可以直接写在项目代码中,也可以写在 webpack 的配置项中,因为这种特性,这类 loader 又被叫做内联 loader
**注:**配置了这个在所有的模块都能使用
npm i expose-loader -D
内联使用
// index.js,直接在项目入口引入全局变量 import "expose-loader?$!jquery"; // 不需要使用import from 语法,因为不需要获取到暴露的对象 /* 是通过expose-loader的类似查询字符串的写法,全局暴露jquery为$符号,可以使用window.$或直接使用$来获取jquery对象 */ console.log($); console.log(window.$);
在 webpack 配置文件中添加
module.exports = { module: { rules: [ { //配置loader,这种loader的验证规则是只要在模块中引用的jquery就会对应上这个loader test: require.resolve("jquery"), use: "expose-loader?$", //然后使用expose-loader将引入的jquery对象变为$在全局使用 }, ], }, };
// index.js import "jquery"; console.log($); console.log(window.$);
3.8.3 在每个模块中注入
如果我们要使用很多全局变量,而又不想自己配,又不想暴露给 window 对象造成污染,可以通过 webpack 插件自动为每一个模块注入该全局变量
//webpack也是一个模块
let webpack = require("webpack");
module.exports = {
plugins: [
new webpack.ProvidePlugin({
$: "jquery", // 在每个模块中将会jquery的对象都注入为$符,这个jquery是在node_modules中获取的
}),
],
};
// index.js
// 现在在文件中不需要进行引入就能使用了,不过不会暴露给window对象
console.log($);
console.log(window.$); // undefined
3.8.4 在 script 标签引用
通过 script 标签引用的对象会自动挂载到 window 对象上,也可以直接在模块内部使用
但是,在模板 html 中通过script
标签引入jquery
, 但是在js
中,如果又想再次引入是用import
引用一次 jquery,会重新打包jquery
,而我们所想的应该是如果使用了 script 标签引用了的全局变量应该不被打包,所以我们可以使用 webpack 提供的externals
功能,进行变量挂载,从而使用 index.html 中引入的 cdn 库,避免了打包时将复杂的第三方库打包
// 我们不希望通过这样使用
const $ = window.$;
// 我们只希望这样引用
const $ = require("jquery");
module.exports = {
externals: {
// 下面这种externals无论在哪使用jquery都会匹配,并且使用$才能够生效
jquery: "$", //将jquery库中的对象赋给全局的$变量,如果没用script标签引入都会报错
},
};
// index.js
import $ from "jquery"; //引入不打包,所以这段代码没有实际意义,只是给编译器看的
console.log($); // 如果没有用script标签引入就会报错,上面的代码没有意义
3.9 图片处理
一般来说有三种方式创建图片:
使用 H5 的 API 在 JS 中创建图片
在 css 中使用 background-image 导入背景图片
在 img 标签中引用图片
在 webpack 中使用图片时,因为是要形成打包后的文件,所以路径就会有问题
一般通过 require 直接引入图片,这时会创建一个存在内存中的新的图片地址,通过这种方式才能在打包后使用该图片,不过引入图片就要配置与引入静态文件相关的 loader
我们这里使用 url-loader 和 file-loader(只对于在 JS 中引入图片和在 js 中引入了 css,css 又引入了背景图片的行为)。实际使用 url-loader,不过 url-loader 依赖于 file-loader
3.9.1 在不同环境下使用
npm i url-loader file-loader -D
module.exports = {
module: {
rules: [
{
test: /\.(png|jpg|gif)$/,
// 当图片小于多少,用base64,否则用url-loader产生真实的图片
/*
优点:减少请求数量(减轻服务器压力)
缺点:图片体积会更大(文件请求速度更慢)
*/
use: {
loader: "url-loader",
options: {
// 用作限制
limit: 8 * 1024, // 8kb之内用base64
},
},
},
],
},
};
flie-lodaer 默认会在内部生成一张图片到 build 的目录下,并且把生成图片的名字返回出来
第一种情况: 图片地址要
import
引入,直接写图片的地址,会默认为字符串
import logo from "./logo.png"; console.log(logo); let image = new Image(); image.src = logo; document.body.appendChild(image);
第二种情况:
css - loader;
会将
css
里面的图片转为require
的格式div { background: url("./logo.png"); /* require("./logo.png") */ }
第三种情况: 解析
html
中的image
使用
html-withimg-loader
npm i html-withimg-loader -D
module.exports = { module: { rules: [ { test: /\.html$/, // 处理html的img图片(负责引入img,从而能被url-loader进行处理) use: "html-withimg-loader", }, ], }, };
使用
html-loader
npm i html-loader -D
module.exports = { module: { rules: [ { test: /\.(png|jpg|gif)$/, use: { loader: "url-loader", options: { limit: 8 * 1024, // 使用html-loader时需要将url的esModule关闭,因为url-loader默认是使用es6模块解析,而html-loader使用的commonjs,解析时会出现[Object Module] esModule: false, }, }, }, { test: /\.html$/, // 处理html的img图片(负责引入img,从而能被url-loader进行处理) use: "html-loader", }, ], }, };
3.9.2 打包文件分类
如果我们先想要把文件资源分类处理,添加配置项,webpack 也会自动的加打包后的路径转换
module.exports = {
module: {
rules: [
{
test: /\.(png|jpg|gif)$/,
// 当图片小于多少,用base64,否则用file-loader产生真实的图片
use: {
loader: "url-loader",
options: {
// 用作限制
limit: 1, // 200k 200 * 1024
outputPath: "img/", // 打包后输出地址 在dist/img
},
},
},
],
},
};
同时,在我们前面的 CSS 插件中,也可以直接写入要分类的目录
module.exports = {
plugins: [
new MiniCssExtractPlugin({
filename: "css/main.css",
}),
],
};
3.9.3 加入 CDN 前缀
如果我们希望输出的时候,给这些css\img
加上前缀,传到服务器也能访问,可以为output
加上publicPath
属性
module.exports = {
output: {
filename: "bundle.[hash:8].js", // hash: 8只显示8位
path: path.resolve(__dirname, "dist"),
publicPath: "http://www.mayufo.cn", // 给静态资源统一加
},
};
如果我们只希望处理某一类文件,比如图片:
module.exports = {
module: {
rules: [
{
test: /\.(png|jpg|gif)$/,
// 当图片小于多少,用base64,否则用file-loader产生真实的图片
use: {
loader: "url-loader",
options: {
limit: 1, // 200k 200 * 1024
outputPath: "/img/", // 打包后输出地址
publicPath: "http://www.baidu.com",
},
},
},
],
},
};
3.10 打包其他资源
除了直接指定需要打包的资源外,我们还可以通过直接使用exclude
选项来打包其他资源
module.exports = {
module: {
rules: [
{
exclude: /\.(css|js|html0)$/, // 假设只有这三种资源为主要资源
loader: "file-lodaer",
options: {
name: "[hash:10].[ext]",
},
},
],
},
};
4. webpack 性能优化
4.1 HMR
HMR(hot module replacement)意为热模板替换,能够在一个模块发生变化时值重新打包这个模块,而不是打包所有模块,极大的提高构建速度,一般用于开发环境使用。
样式文件:因为 style-loader 内部实现了 hmr 功能,所以默认可以用使用 hmr 功能(所以开发环境不需要将样式文件打包)
js 文件:
默认不支持 hmr 功能
// index.js if (module.hot) { // 一旦module.hot为true,说明开启了hmr功能 module.hot.accept("./log.js", () => { // 方法会监听 log.js文件的变化,一旦变化就触发回调函数,其他文件就不会被重新打包,否者就会打包所有的文件 // dosomething }); }
注意:hmr 功能 js 的处理,只能处理非入口 js 文件的其他文件。
html 文件:
默认不支持 hmr 功能,同时 html 文件是默认是不能热更新的。
注:
因为项目中一般都只有一个 html 文件,所以我们是不需要为 html 文件做 hmr 的,改变 html 文件项目就一定要重新打包。
解决热更新:
修改 entry 入口,将 html 文件引入,这样每次修改 html 文件的时候都会重新打包项目。
// 多入口 let path = require("path"); let HtmlWebpackPlugin = require("html-webpack-plugin"); module.exports = { entry: ["./src/index.js", "/public/index.htnl"], };
4.2 source-map
source-map 是一种提供源代码到构建后代码映射技术(如果代码出错了,通过映射可以追踪代码错误)
module.exports = {
mode: "development",
devtool: "source-map",
};
可选值有[inline-|hidden-|eval-][nosources-][cheap-[module-]]source-map
大体有以下大类,还有一些是通过下面的大类组合而来的:
**source-map:**外部,能够提示出错误代码的准确信息和源代码的错误位置
**inline-source-map:**内联,只生成一个内联 source-map,能够提示出错误代码的准确信息和源代码的错误位置
**hidden-source-map:**外部 source-map,能够提示错误代码的错误原因,但是没有错误位置,不能追踪到源代码错误,只能提示到构建后代码的错误位置(只隐藏源代码,不隐藏构建后的代码)
**eval-source-map:**内联,但每一个文件都会生成对应的 source-map 在 eval 中,能够提示出错误代码的准确信息和源代码的错误位置
**nosource-source-map:**外部,能找到错误代码的准确信息,但是没有任何源代码信息(隐藏所有代码)
**cheap-source-map:**外部,能够提示出错误代码的准确信息和源代码的错误位置,但是只能精确到某一行,不能找到某一行中的哪一个错误
**cheap-module-source-map:**外部,能够提示出错误代码的准确信息和源代码的错误位置
内联与外部的区别
外部生成了对应的文件,而内联没有
内联的构建速度更快
两种环境的选择
- 开发环境:需要速度快,调试更友好。
速度快:由于
eval>inline>cheap>...
,所以可以选择eval-cheap-source-map
和eval-source-map
调试更友好:可以选择
source-map
、cheap-module-source-map
和cheap-source-map
综上:一般可以选择eval-source-map
(Vue 和 React 脚手架默认就是这种)或者eval-cheap-module-source-map
- 生产环境:需要考虑是否隐藏源代码,是否需要调试友好。同时要注意的是生产环境不要用内联,这样会使得文件体积增大
调试友好:可以使用
source-map
和cheap-module-source-map
需要隐藏源代码:可以使用
nosource-source-map
和hidden-source-map
4.3 oneof
在之前我们配置 loader 的时候,其实每一个文件都会对每一个 loader 进行对比适配,不管是否能匹配上,这样做会很消耗性能,而 oneof 就可以帮助我们提高性能,它作用类似于 switch,在匹配上一个之后就不会继续往下面匹配了。
const path = require("path");
const HtmlWebpackPlugin = require("html-webpack-plugin");
const MiniCssExtractPlugin = require("mini-css-extract-plugin");
const optimizeCssAssetsWebpackPlugin = require("optimize-css-assets-webpack-plugin");
process.env.NODE_ENV = process.env.NODE_ENV
? process.env.NODE_ENV
: "development";
const isDev = process.env.NODE_ENV === "development" ? true : false;
// 复用loader
const commonCSSLoader = [
MiniCssExtractPlugin.loader,
"css-loader",
{
loader: "postcss-loader",
options: {
ident: "postcss",
plugins: () => {
require("postcss-preset-env");
},
},
},
];
module.exports = {
module: {
rules: [
// loader
{
test: /\.js$/,
exclude: /node_modules/,
loader: "eslint-loader",
// 优先执行
enforce: "pre",
/*
package.json里面写上"eslintConfig":{
"extends":'airbnb-base"
}
*/
options: {
fix: true,
},
},
{
// 但是需要注意不能同时有两个配置匹配同一类型的文件,所有拿出一个js配置到外面
oneOf: [
{
test: /\.less$/,
use: [
...(isDev ? ["style-loader", "css-loader"] : commonCSSLoader),
"less-loader",
],
},
{
test: /\.css$/,
use: [
...(isDev ? ["style-loader", "css-loader"] : commonCSSLoader),
],
},
{
test: /\.js$/,
exclude: /node_modules/,
loader: "babel-loader",
options: {
presets: [
"@babel/preset-env",
{
// 按需加载
useBuiltIns: "usage",
// 指定core-js版本
corejs: {
version: 3,
},
// 指定兼容哪个版本浏览器
targets: {
chrome: "60",
firefox: "60",
ie: "9",
safari: "10",
edge: "17",
},
},
],
},
},
{
test: /\.(jpg|png|gif)$/,
loader: "url-loader",
options: {
limit: 8 * 1024,
name: "[hash:10].[ext]",
esModule: false,
outputPath: "imgs",
},
},
{
// html资源
test: /\.html$/,
loader: "html-loader",
},
{
exclude: /\.(html|css|less|js|jpg|png|gif)$/,
loader: "file-loader",
options: {
name: "[hash:10].[ext]",
outputPath: "media",
},
},
],
},
],
},
};
4.4 缓存
为了使得项目性能更加优化,很多地方都会使用缓存,但是有些时候缓存不能起到预定的效果,需要根据实际来使用缓存
babel 缓存: 之前在处理 ES6 的时候写到过,它内置可以开启
cacheDirectory:true
,让第二次打包构建速度更快文件资源缓存: 该缓存是默认存在于 webpack 打包中的,但是这种缓存在很多时候会让我们想要修改的数据无效,需要我们自己为打包后的文件设置哈希值来清除缓存。文件资源缓存的作用是让代码上线运行缓存更好使用
- **hash:**每次 webpack 构建时会生成一个唯一的 hash 值。 **问题:**因为 js 和 css 同时使用一个 hash 值,如果重新打包,会导致所有缓存失效,但是用户却只想要修改一个文件
- **chunkhash:**根据 chunk 生成的 hash 值,如果打包来源于同一个 chunk,那么 hash 值就一样 **问题:**js 和 css 的 hash 值还是一样的,因为 css 是在 js 中引入,所以属于同一个 chunk
- **contenthash:**根据文件的内容生成 hash 值,不同文件 hash 值一定不相同
4.5 tree shaking
tree shaking
的作用是去除无用的代码,减少代码的体积。
但是使用tree shaking
需要有两个前提:
必须使用 ES6 模块化
需要开启 production 环境
**注意:**有些时候我们开启tree shaking
时可能会把我们项目中的css、@babel/polyfill
文件消除掉
在package.json
中:
{
"sideEffects":false // 当开启为false时会让所有代码都没有副作用,tree shaking就会将css文件一起删除掉
}
{
"sideEffects":["*.css", "*.less"] // 我们最好手动配置清除
}
4.6 代码分割
4.6.1 打包多页应用
打包多页应用的方式很简单,使用多个入口和多个模板就能完成多个页面的打包
// 多入口
let path = require("path");
let HtmlWebpackPlugin = require("html-webpack-plugin");
module.exports = {
mode: "development",
entry: {
home: "./src/index.js",
other: "./src/other.js",
},
output: {
// 使用[name]会让各在入口文件输出各自的出口文件
filename: "[name].js",
path: path.resolve(__dirname, "dist2"),
},
plugins: [
new HtmlWebpackPlugin({
template: "./index.html",
filename: "home.html",
// 模板要引入哪些入口文件
chunks: ["home"],
}),
new HtmlWebpackPlugin({
template: "./index.html",
filename: "other.html",
chunks: ["other", "home"], // other.html 里面有 other.js & home.js
}),
],
};
4.6.2 配置 node_modules 的 chunk
// 多入口
let path = require("path");
let HtmlWebpackPlugin = require("html-webpack-plugin");
module.exports = {
mode: "production",
entry: {
home: "./src/index.js",
other: "./src/other.js",
},
output: {
// 使用[name]会让各在入口文件输出各自的出口文件
filename: "[name].js",
path: path.resolve(__dirname, "dist2"),
},
plugins: [
new HtmlWebpackPlugin({
template: "./index.html",
minify: {
collapseWhitespace: true,
removeComments: true,
},
}),
],
/*
1.如果是单文件,可以自动将node_modules中代码单独打包一个chunk最终输出
2.自动分析多入口chunk中有没有公共文件,如果有会单独打包成一个chunk用来共用
*/
optimizaion: {
splitChunks: {
chunks: "all",
},
},
};
4.6.3 js 代码打包
通过 js 代码的注释效果能够将 webpack 的打包机制将相同 chunk 名字的代码打包在一起
/*
通过js代码,让某个文件单独打包为一个chunk:
使用import动态导入的语法,能让一个文件单独被打包,但是默认是随机的id,可以在前面加上注释生成想要的名字
*/
import(/* webpackChunkName: 'test' */)
.then((res) => {
console.log(res);
})
.catch(() => {
console.log("文件加载失败");
});
4.7 懒加载与预加载
懒加载:
js 中使用懒加载其实非常简单,我们只需要使用
import()
这样的语法通过
.then()
的方式获取回调就能够实现这样的效果。同时该方法也不会重复加载模块,第二次使用会引用缓存中的。
document.getElementById("btn").onclick = function() { import(/* webpackChunkName: 'test' */).then((res) => { console.log(res); }); };
预加载:
预加载(prefetch)会在使用之前,提前加载 js 文件,正常的加载可以认为是并行加载(同一时间加载多个文件),而预加载是等其他资源加载完成之后,浏览器空闲时偷偷进行加载资源。
document.getElementById("btn").onclick = function() { // 使用webpackPrefetch开启预加载 import(/* webpackChunkName: 'test', webpackPrefetch: true */).then( (res) => { console.log(res); } ); };
4.8 PWA(离线可访问)
PWA(渐进式网络开发应用程序)可以为我们提供即使离线状态下浏览器也可以访问网站的能力。
要在 webpack 中启用 PWA,我们需要下载workbox-webpack-plugin
作为插件使用
npm i workbox-webpack-plugin -D
const workboxWebpackPlugin = require("workbox-webpack-plugin ");
module.exports = {
plugins: [
/*
该插件最终会帮我们生成一个serviceworker配置文件
下面两个配置的作用:
1.帮助serviceworker快速启动
2.删除旧的serviceworker
*/
new workboxWebpackPlugin({
clientClaim: true,
skipWaiting: true,
}),
],
};
// index.js
/*
注册serviceworker
处理兼容性问题
*/
if ("serviceWorker" in navigator) {
window.addEventListener("load", () => {
navigator.serviceWorker
.register("/service-worker.js")
.then(() => {
console.log("注册成功");
})
.catch(() => {
console.log("注册失败");
});
});
}
4.9 多进程打包
webpack 中启用多进程打包需要使用thread-loader
**注意:**开启多进程打包不一定会让打包速度更加快,因为进程启动和通信之间也有时间开销,只有当工作消耗时间比较长,比如有很多 js 代码的时候,才需要多进程打包
npm i thread-lodaer -D
module.exports = {
module: {
rules: [
{
// 但是需要注意不能同时有两个配置匹配同一类型的文件,所有拿出一个js配置到外面
oneOf: [
{
test: /\.js$/,
exclude: /node_modules/,
use: [
// 一般多进程打包都是和babel一起使用
{
loader: 'thread-loader',
options: {
workers: 2 // 两个进程
}
},
{
loader: 'babel-loader',
options: {
presets: [
'@babel/preset-env',
{
// 按需加载
useBuiltIns: 'usage',
// 指定core-js版本
corejs: {
version: 3
},
// 指定兼容哪个版本浏览器
targets: {
chrome: '60',
firefox: '60',
ie: '9',
safari: '10',
edge: '17'
}
}
],
cacheDirectory: true // 开启babel缓存,第二次构建时会读取之前的缓存
}
}
]
}
]
}
]
}
}
4.10 externals
在前面也说到过,当我们引入全局的库的时候我们可能会使用 externals,使用 externals 可以让 webpack 强制不打包内部指定的包,要使用的时候直接从 script 标签获取,起到减少打包体积的作用。
4.11 dll
**使用 dll 技术,对某些库(第三方库:jquery、react、vue...)等进行单独打包。**dll 已经由 webpack 进行集成过了
// webpack.dll.js
/*
该文件名为webpack.dll.js,所以在运行打包时是 webpack --config webpack.dll.js 来打包外部库
*/
const { resolve } = require("path");
const webpack = require("webpack");
module.exports = {
entry: {
// 最终打包生成的[name] --> jquery
// ['jquery'] --> 要打包生成的库叫jquery
jquery: ["jquery"],
},
output: {
filename: "[name].js",
path: resolve(__dirname, "dll"),
library: "[name]_[hash]", // 打包的库里面向外面暴露出去的内容叫什么名字,相当于就是全局变量名
},
plugins: [
new webpack.DllPlugin({
name: "[name]_[hash]", // 映射库的暴露的内容名称
path: resolve(__dirname, "dll"), // 输出的文件路径
}),
],
mode: "production",
};
// webpack.config.js
const { resolve } = require("path");
const HtmlWebpackPlugin = require("html-webpack-plugin");
const AddAssetHtmlWebpackPlugin = require("add-asset-html-webpack-plugin");
const webpack = require("webpack");
module.exports = {
entry: "./src/index.js",
output: {
filename: "built.js",
path: resolve(__dirname, "build"),
},
plugins: [
new HtmlWebpackPlugin({
template: "./src/index.html",
}),
// 告诉webpack哪些库不参与打包,同时使用名称也会改变
new webpack.DllReferencePlugin({
// 通过映射来寻找
manifest: resolve(__dirname, "dll/manifest.json"),
}),
// 将某个文件打包出去,比你html资源中引入
new AddAssetHtmlWebpackPlugin({
filename: resolve(__dirname, "dll/jquery.js"),
}),
],
mode: "development",
};
5. 配置详解
5.1 entry
entry 是 webpack 打包的入口起点 ,该入口可以使用多种形式打包:
string:
单入口,打包形成一个 chunk,输出一个 bundle 文件,此时 chunk 的名称默认是 main
module.exports = { entry: "./src/index.js", };
[]:string:
多入口,所有入口文件最终会形成一个 chunk,输出一个 bundle 文件,一般可以用来处理 hmr 中的 html 热更新的问题
module.exports = { entry: ["./src/index.js", "./src/home.js"], };
object:
多入口,有几个入口文件就形成几个 chunk,会输出多个 bundle 文件,此时 chunk 的名称为 key
module.exports = { // 下面的代码最终会行2个bundle文件 entry: { // 多入口,所有入口文件最终会形成一个chunk,输出一个bundle文件,文件名为index index: ["./src/index.js", "./src/home.js"], // 形成一个chunk,输出一个bundle add: " ./src/add.js", }, };
一般这种情况可以让我们单独打包第三方库:
module.exports = { entry: { jquery: ["jquery"], react: ["react", "react-dom", "react-router-dom"], }, };
5.2 output
output 是 webpack 打包的出口
const { resolve } = require('path')
module.exports = {
entry: './src/index.js'
output: {
// 文件名称(指定名称+目录)
filename: 'js/[name].js',
// 输出文件目录(将来所有资源输出的公共目录)
path: resolve(__dirname, 'build'),
// 所有资源引入公共路径,如将前面我们写的js/[name].js,在引入的时候会成为/js/[name].js
publicPath: '/',
chunkFilename: 'js/[name]_chunk.js', // 非入口chunk的名称
library: '[name]', // 向外暴露库的变量名
libraryTarget: 'window' // 变量名添加到那个对象下(不填就为一个全局变量的形式)
/*
如:
browser:window
node:global
commonjs模块内部引入:commonjs
*/
}
}
5.3 module
const { resolve } = require("path");
module.exports = {
module: {
rules: [
// loader配置
{
test: /\.css$/,
// 多个loader使用use
use: ["style-loader", "css-loader"],
},
{
test: /\.js$/,
// 排除node_modules下的js文件
exclude: /node_modules/,
// 只检查src下的js文件
include: resolve(__dirname, "src"),
// 优先执行
enforce: "pre",
// 延后执行
// enforce: 'post'
loader: "eslint-loader", // 单个loader使用loader,可以配置options
options: {},
},
],
},
};
5.4 resolve
resolve 用于配置 webpack 解析模块规则
const { resolve } = require('path')
module.exports = {
// 解析模块的规则
resolve: {
// 配置解析模块路径别名。优点:简写路径。缺点:没有路径智能提示。(可以使用ts或编译器配置)
alias: {
$css: resolve(__dirname, 'src/css')
}.
// 配置省略文件路径的后缀名,按照数组顺序依次寻找
extensions: ['.js', '.jsx', '.json', '.css']
// 告诉webpack解析模块是去哪个目录寻找
modules: [resolve(__dirname, 'node_modules'), 'node_modules']
}
}
5.5 devServer
devServer 专门用来配置 webpack 开发环境的服务配置
const { resolve } = require("path");
module.exports = {
mode: "development",
devServer: {
// 运行代码的目录
contentBase: resolve(__dirname, "build"),
// 监视contentBase目录下的所有文件,一旦文件发生变化就会reload
watchContentBase: true,
watchOptions: {
// 忽略文件
ignored: /node_modules/,
},
// 启动gzip压缩
compress: true,
// 端口号
port: 3000,
// 域名
host: "localhost",
// 自动打开浏览器
open: true,
// 开启hmr功能
hot: true,
// 不需要显示启动服务器日志信息
clientLogLevel: "none",
// 除了一些基本启动信息以为,不打印其他内容
quiet: true,
// 如果出错了,不需要全屏提示
overlay: false,
// 服务器代理
proxy: {
"/api": {
// 代理地址
target: "http://localhost:3000",
// 路径重写
pathRewrite: {
"^/api": "",
},
},
},
},
};
5.6 optimization
optimization 专门用来处理 webpack 打包时性能优化的部分
let TerserWebpackPlugin = require("terser-webpack-plugin");
module.exports = {
mode: "production",
optimization: {
// 处理公共代码打包
splitChunks: {
chunks: "all",
// 下面的配置都是默认值
/*
minSize: 30 * 1024, // 分割的chunk最小为30kb
maxSize: 0, // 最大没有限制
minChunks: 1, // 要提取的chunk最少被引用一次
maxAsyncRequests: 5, // 按需加载时并行加载文件的最大数量
maxInitialRequests: 3, // 入口js最大并行请求数量
name: true, // 可以使用命名规则,开启后下面的命名相关的声明规则就可以生效
automaticNameDelimiter: '~', // 名称连接符,打包后文件名以~连接
cacheGroups: { // 分割chunk的组
// 下面的键是分割后组的名称
// node_modules文件会被打包到vendors组的chunk中,生成vendors~xxx.js
// 同时所有分组均满足上面所写的所有规则,如果在下面重复写了会覆盖掉上面的
vendors: {
// 只分割node_modules中的
test: /[\\/]node_modules[\\/]/,
// 优先级,冲突时会根据优先级大小打包
priority: -10
},
default: {
// 要提取的chunk最少被引用2次
minChunks: 2,
priority: -20,
// 如果当前被打包的模块和已被提出的模块是同一个,就不会重复打包
reuseExistingChunk: true
}
}
*/
},
// 将当前模块的记录其他模块的hash单独打包为一个文件runtime,用于解决修改a文件时导致b文件contenthash变化所产生的影响
runtimeChunk: {
name: (entrypoint) => `runtime-${entrypoint}`,
},
minimizer: [
// 配置生产环境的压缩方案:js和css
/*
在webpack 4.2.6之后使用的是terser-webpack-plugin进行代码压缩
*/
new TerserWebpackPlugin({
// 开启缓存
cache: true,
// 开启多进程打包
parallel: true,
// 启动source-map
sourceMap: true,
}),
],
},
};
6. webpack 配置模板
6.1 基本模板
const path = require('path')
const HtmlWebpackPlugin = require('html-webpack-plugin')
const MiniCssExtractPlugin = require('mini-css-extract-plugin')
const optimizeCssAssetsWebpackPlugin = require('optimize-css-assets-webpack-plugin')
process.env.NODE_ENV = process.env.NODE_ENV
? process.env.NODE_ENV
: 'development'
const isDev = process.env.NODE_ENV === 'development' ? true : false
// 复用loader
const commonCSSLoader = [
MiniCssExtractPlugin.loader,
'css-loader',
{
loader: 'postcss-loader',
options: {
ident: 'postcss',
plugins: () => {
require('postcss-preset-env')
}
}
}
]
module.exports = {
mode: 'development',
entry: './src/index.js',
output: {
filename: 'js/built.js',
path: path.resolve(__dirname, 'build')
},
module: {
rules: [
// loader
{
test: /\.js$/,
exclude: /node_modules/,
loader: 'eslint-loader',
// 优先执行
enforce: 'pre',
/*
package.json里面写上"eslintConfig":{
"extends":'airbnb-base"
}
*/
options: {
fix: true
}
},
{
// 但是需要注意不能同时有两个配置匹配同一类型的文件,所有拿出一个js配置到外面
oneOf: [
{
test: /\.less$/,
use: [
...(isDev ? ['style-loader', 'css-loader'] : commonCSSLoader),
'less-loader'
]
},
{
test: /\.css$/,
use: [...(isDev ? ['style-loader', 'css-loader'] : commonCSSLoader)]
},
{
test: /\.js$/,
exclude: /node_modules/,
loader: 'babel-loader',
options: {
presets: [
'@babel/preset-env',
{
// 按需加载
useBuiltIns: 'usage',
// 指定core-js版本
corejs: {
version: 3
},
// 指定兼容哪个版本浏览器
targets: {
chrome: '60',
firefox: '60',
ie: '9',
safari: '10',
edge: '17'
}
}
],
cacheDirectory: true // 开启babel缓存,第二次构建时会读取之前的缓存
}
},
{
test: /\.(jpg|png|gif)$/,
loader: 'url-loader',
options: {
limit: 8 * 1024,
name: '[hash:10].[ext]',
esModule: false,
outputPath: 'imgs'
}
},
{
// html资源
test: /\.html$/,
loader: 'html-loader'
},
{
exclude: /\.(html|css|less|js|jpg|png|gif)$/,
loader: 'file-loader',
options: {
name: '[hash:10].[ext]',
outputPath: 'media'
}
}
]
}
]
},
plugins: [
new HtmlWebpackPlugin({
template: './src/index.html',
minify: {
removeAttributeQuotes: true, // 删除属性的双引号,除了一些特殊的删除不了以外都能删除
collapseWhitespace: true, // 折叠空行将所有代码变成一行
removeComments: true // 移除注释
}
}),
// 抽离css
new MiniCssExtractPlugin([{ filename: 'css/built.css' }]),
// 压榨css
new optimizeCssAssetsWebpackPlugin()
],
devServer: {
contentBase: path.resolve(__dirname, 'build'),
compress: true,
port: 3000,
open: true
}
}
6.2 开发环境的基本配置
const { resolve } = require("path");
const HtmlWebpackPlugin = require("html-webpack-plugin");
module.exports = {
entry: "./src/js/index.js",
output: {
filename: "js/built.js",
path: resolve(__dirname, "build"),
},
module: {
rules: [
// loader的配置
{
// 处理less资源
test: /\.less$/,
use: ["style-loader", "css-loader", "less-loader"],
},
{
// 处理css资源
test: /\.css$/,
use: ["style-loader", "css-loader"],
},
{
// 处理图片资源
test: /\.(jpg|png|gif)$/,
loader: "url-loader",
options: {
limit: 8 * 1024,
name: "[hash:10].[ext]",
// 关闭es6模块化 esModule: false, outputPath: 'imgs'
},
},
{
// 处理html中img资源
test: /\.html$/,
loader: "html-loader",
},
{
// 处理其他资源
exclude: /\.(html|js|css|less|jpg|png|gif)/,
loader: "file-loader",
options: {
name: "[hash:10].[ext]",
outputPath: "media",
},
},
],
},
plugins: [
// plugins的配置
new HtmlWebpackPlugin({
template: "./src/index.html",
}),
],
mode: "development",
devServer: {
contentBase: resolve(__dirname, "build"),
compress: true,
port: 3000,
open: true,
},
};
6.3 生产环境的配置
const {
resolve
} = require('path');
const MiniCssExtractPlugin = require('mini-css-extract-plugin');
const OptimizeCssAssetsWebpackPlugin = require('optimize-css-assets-webpack-plugin');
const HtmlWebpackPlugin = require('html-webpack-plugin');
// 定义nodejs环境变量:决定使用browserslist的哪个环境
process.env.NODE_ENV = 'production';
// 复用loader const commonCssLoader = [
MiniCssExtractPlugin.loader,
'css-loader', {
// 还需要在package.json中定义browserslist loader: 'postcss-loader', options: { ident: 'postcss',
plugins: () => [require('postcss-preset-env')()]
}
}];
module.exports = {
entry: './src/js/index.js',
output: {
filename: 'js/built.js',
path: resolve(__dirname, 'build')
},
module: {
rules: [{
test: /\.css$/,
use: [...commonCssLoader]
},
{
test: /\.less$/,
use: [...commonCssLoader, 'less-loader']
},
/*
正常来讲,一个文件只能被一个loader处理。
当一个文件要被多个loader处理,那么一定要指定loader执行的先后顺序:
先执行eslint 在执行babel
*/
{
// 在package.json中eslintConfig --> airbnb test: /\.js$/, exclude: /node_modules/,
// 优先执行
enforce: 'pre',
loader: 'eslint-loader',
options: {
fix: true
}
},
{
test: /\.js$/,
exclude: /node_modules/,
loader: 'babel-loader',
options: {
presets: [
[
'@babel/preset-env',
{
useBuiltIns: 'usage',
corejs: {
version: 3
},
targets: {
chrome: '60',
firefox: '50'
}
}
]
]
}
},
{
test: /\.(jpg|png|gif)/,
loader: 'url-loader',
options: {
limit: 8 * 1024,
name: '[hash:10].[ext]',
outputPath: 'imgs',
esModule: false
}
},
{
test: /\.html$/,
loader: 'html-loader'
},
{
exclude: /\.(js|css|less|html|jpg|png|gif)/,
loader: 'file-loader',
options: {
outputPath: 'media'
}
}
]
},
plugins: [new MiniCssExtractPlugin({
filename: 'css/built.css'
}),
new OptimizeCssAssetsWebpackPlugin(), new HtmlWebpackPlugin({
template: './src/index.html',
minify: {
collapseWhitespace: true,
removeComments: true
}
})
],
mode: 'production'
};