Webpack 是 JavaScript 的模块建置工具,运行在 Node.js 上,它可以将零散的 JavaScript 文件用各式工具优化并打包起来,加快网页的加载时间。Webpack 也并不限于用在 JavaScript 上,举凡网页有用到的静态资源(如 JS、CSS、图片档等),甚至是 HTML 网页,Webpack 都有办法打包。
Webpack 官方网站:
官方网站上给的一张图例,简洁扼要地说明了 Webpack 的功用:
Webpack 的 Node.js 环境
Webpack 官方建议使用 Node.js 最新的 LTS 版本来运行 Webpack。Windows 的用户可以直接到 Node.js 官方网站下载到 Node.js 的安装档,而 Linux 操作系统或是 macOS 的用户可以参考这篇文章来安装指定版本的 Node.js。
创建 Webpack 项目
Webpack 可以被加进现有的 Node.js 项目中,在终端机运行以下指令来安装 webpack 和 webpack-cli 这两个套件。
指令中的 -D 参数即是 --save-dev。
接着在 package.json 中加入新的脚本指令:
{
...
"scripts": {
...
"build:webpack": "webpack --mode production",
...
},
...
}
production 其实就是 Webpack 预设的模式,它会将 NODE_ENV 设为 production,并且会自动激活它自带的一些相关插件。如果需要的话也可以使用 development,它会将 NODE_ENV 设为 development,也会自动激活它自带的一些相关插件。
再来就是在 Node.js 项目根目录中,添加 Webpack 的设置档 webpack.config.cjs,内容可以初始如下:
module.exports = {
plugins: [
],
module: {
rules: [
]
},
};
使用 npm 指令打包 Webpack 项目
由于我们已经事先在 package.json 中加入 build:webpack 脚本指令了,因此可以直接使用 npm run build:webpack 指令来运行它。
进入点(Entry Point)和输出
Webpack 会去运行某个或是某几个 JavaScript 文件作为进入点,预设的进入点只有一个,路径为 src/index.js,且其输出的 JS 文件的预设路径为 dist/main.js。搭配其它的加载器也可以使用非 JavaScript 作为进入点。
如果要修改进入点的路径,要在 webpack.config.cjs 设置档中,加上 entry 字段,设置方式如下:
module.exports = {
...
entry: "./path/to/js-file",
...
};
例如:
module.exports = {
...
entry: "./src/lib.js",
...
};
至于进入点的 JS 程序写法,稍后会再提到。
如果要修改输出的 JS 文件的路径,要在 webpack.config.cjs 设置档中,加上 output 字段,设置方式如下:
module.exports = {
...
output: {
path: "/path/to/folder",
filename: "./path/to/file",
},
...
};
output 字段中的 path 字段表示要保存输出档(不限于 JS 档)的目录,注意这个路径必须要是绝对路径!而 filename 字段则是输出的 JS 档(其它类型的文件会用其它方式设置)要保存的路径,注意这个路径必须要是相对路径,才能使输出档存在于 path 字段的绝对路径下。当然,如果您想要让输出档放置在 Node.js 项目的根目录下的 dist 目录的话,可以不必设置 path 字段。
例如:
const path = require("node:path");
module.exports = {
...
output: {
path: path.join(__dirname, "output"),
filename: "./js/bundle.min.js",
},
...
};
以上的 __dirname 即表示目前运行的 JS 文件(此处即 webpack.config.cjs)的所在目录之绝对路径(此处即 Node.js 项目的根目录)。
如果要设置多个进入点,entry 字段和 output 字段的设置方式如下:
const path = require("node:path");
module.exports = {
...
entry: {
"name-1": "./path/to/js-file-1",
"name-2": "./path/to/js-file-2",
"name-3": "./path/to/non-js-file-2",
},
output: {
path: path.join(__dirname, "output"),
filename: "./js/[name].min.js",
},
...
};
在 filename 字段的字符串中加入 [name],可以让 Webpack 自动用进入点的名称来取代它。如果 entry 字段有设置多个进入点,但是没有设置 output 字段的话,Webpack 预设的 output 字段值如下:
const path = require("node:path");
module.exports = {
...
output: {
path: path.join(__dirname, "dist"),
filename: "./[name].js",
},
...
};
如果网页的静态资源有需要使用 CDN (Content Delivery Network),output 字段值可以再加上 publicPath 字段,来替输出档的网址链接加上前缀,如此一来在 HTML 或是 CSS 中有用到的静态资源网址链接就可以被取代为 CDN 的网址链接。
例如:
const path = require("node:path");
module.exports = {
...
output: {
path: path.join(__dirname, "output"),
publicPath: "https://cdn.example.com/",
filename: "./js/bundle.min.js",
},
...
};
为了确保 HTML 或是 CSS 的版本和其链接到的静态资源的版本是一样的,我们可以在 path 和 publicPath 字段值的字符串中使用 [fullhash],让 Webpack 自动用项目的哈希值来取代它。
例如:
const path = require("node:path");
module.exports = {
...
output: {
path: path.join(__dirname, "output", "[fullhash]"),
publicPath: "https://cdn.example.com/[fullhash]/",
filename: "./js/bundle.min.js",
},
...
};
在打包前先清空目录
Webpack 在打包项目前预设并不会先将输出目录清空,因此一不小心就会留有前次产生出来但现在已经没有用到的文件。若要让 Webpack 将输出目录清空,可以将 output 字段的 clean 属性设为 true。
如下:
module.exports = {
...
output: {
...
clean: true,
...
},
...
};
打包 JavaScript 文件
Babel
现在开发 JavaScript 程序大多是靠 Node.js,Node.js 能够支持的 ECMAScript 版本很新(可以查看这个网页),但是主流的网页浏览器对于比较新的 ECMAScript 语法并没有完全支持(可以查看这个网页)。所以为了使 Node.js 开发的 JavaScript 程序能够在各大网页浏览器上正常运行,我们需要使用「Babel」这套工具来转换 JS 语法。
在终端机运行以下指令来安装 babel-loader、@babel/core、@babel/register 和 @babel/preset-env 这四个套件。
在 webpack.config.cjs 设置档中,于 module 字段的 rules 数组内,加入 Babel 的加载器(loader)规则。Webpack 会去读取进入点的 JS 文件所 require 或是 import 的文件,以及这些文件再引用的文件(例如被引用的 JS 文件又去引用其它的 JS 文件,或是被引用的 SCSS 文件又去引用其它的 SCSS 文件,又或是被引用的 CSS 文件又去引用其它的图片文件),这些静态资源的文件路径,除了 JS 文件外,都必须要在 rules 数组中被匹配到,并指派正确的加载器来负责处理,否则 Webpack 就无法成功打包项目。
虽然 JS 档可不必写在 rules 数组中来匹配,但是如果我们要指定别的加载器就得要写了。Babel 的加载器规则写法如下:
module.exports = {
...
module: {
rules: [
...
{
test: /\.js$/iu,
use: {
loader: "babel-loader",
options: { presets: ["@babel/preset-env"] },
},
},
...
]
},
...
};
混淆与最小化 JS 程序
为了避免我们辛苦开发的 JavaScript 代码被轻易盗用,同时也希望 Webpack 打包出来的 JS 文件可以愈小愈好,那就要替 Webpack 加上 terser-webpack-plugin 插件。Webpack 预设就有激活这个插件,如果我们要更改它的设置值,就要手动在 webpack.config.cjs 设置档中将其 require 进来,不过还要先运行以下指令将 terser-webpack-plugin 加入 devDependencies:
在 optimization 字段中,其底下还有个 minimizer 字段,值为一个数组,接着将 terser-webpack-plugin 的实体加进 minimizer 字段的数组中。
如下:
const TerserPlugin = require("terser-webpack-plugin");
module.exports = {
...
optimization: {
minimizer: [
new TerserPlugin({
extractComments: false,
terserOptions: { format: { comments: false } },
}),
]
},
...
};
以上设置可以让 npm run build:webpack 指令所输出的 JS 文件中完全没有注解。
打包任意文件
将文件引用至 JavaScript 中
JavaScript 原先的 require 函数和 import 关键字只能够引用 JavaScript 程序,但是在 Webpack 的框架下,它们要引用什么样的类型的文件都是可以的。因此如果要打包非 JS 文件的话,只要在进入点的 JS 文件中,加上如以下的程序即可:
import './path/to/file';
文件加载器
前面有提到过,静态资源的文件路径,除了 JS 文件外,都必须要在 webpack.config.cjs 设置档中的 rules 数组内被匹配到,并指派正确的加载器来负责处理,否则 Webpack 就无法成功打包项目。
Webpack 内置文件加载器,称为「资产模块」(Asset Module),分为如下几种类型:
asset/resource:在输出目录产生引用到的文件并修改 URL 指到那个文件。asset/inline:将文件内容转成 Data URI,嵌入至代码中。asset/source:将文件内容直接嵌入至代码中。asset:根据文件大小自动选择要用asset/inline还是asset/resource来打包文件。
在 webpack.config.cjs 设置档中,于 module 字段的 rules 数组内,加入资产规则。若是要加载如 SVG、JPEG、PNG、GIF、WEBP 等网页常用的图片格式,以及 EOT、WOFF、WOFF2、TTF、OTF、SVG 等网页常用的字体格式的话,规则如下:
module.exports = {
...
module: {
rules: [
...
{
test: /\.(eot|woff|woff2|[ot]tf)$/iu,
type: "asset/resource",
generator: { filename: "fonts/[name][ext]" },
},
{
test: /.*font.*\.svg$/iu,
type: "asset/resource",
generator: { filename: "fonts/[name][ext]" },
},
{
test: /^(?!.*font).*\.svg$/iu,
type: "asset/resource",
generator: { filename: "images/[name][ext]" },
},
{
test: /\.(jpe?g|png|gif|webp)$/iu,
type: "asset/resource",
generator: { filename: "images/[name][ext]" },
},
...
]
},
...
};
如果想保留静态资源文件的文件名和扩展名,就如上面规则中,把 generator 的 filename 字段值设为 xxx/[name][ext]。如果不设置 filename 字段,就会以哈希值当作是输出文件名,将文件输出到输出目录底下。
打包 SCSS/CSS 文件
SCSS 是用来产生 CSS 的程序,提供比 CSS 还要更方便的语法结构,也兼容原本的 CSS。若您原先只用 CSS,在使用 Webpack 时改用 SCSS,可以让 CSS 变得容易维护许多。SCSS (Sassy CSS)是 Sass 提供的一种新格式,而 Sass 原本在用的旧格式也称为 Sass。
Sass/SCSS 的官方网站:
为了能够让 Webpack 在打包时候去解析 SCSS/CSS 文件,我们不能直接指派文件加载器来处理 SCSS/CSS 文件。
Sass/SCSS/CSS 加载器
sass-loader 是一个能够读取 Sass、SCSS 和 CSS 文件的加载器,文件在被读取后会被转成 CSS 格式,可以在终端机运行以下指令来安装。
在 webpack.config.cjs 设置档中,于 module 字段的 rules 数组内,加入 Sass/SCSS/CSS 加载器的规则。如下:
module.exports = {
...
module: {
rules: [
...
{
test: /\.(sa|sc|c)ss$/iu,
use: ["sass-loader"],
},
...
]
},
...
};
在这边的规则中,use 字段值使用了数组结构,表示要使用多个加载器。接下来继续再介绍更多相关的加载器。
PostCSS 加载器
postcss-loader 是一个能对 CSS 做前处理的加载器。autoprefixer 是 postcss-loader 的插件,可以自动添加所有网页浏览器的 CSS 前缀。cssnano 也是 postcss-loader 的插件,可以最小化 CSS。在终端机运行以下指令来安装这些套件:
在 webpack.config.cjs 设置档中,于 sass-loader 之上,加入 PostCSS 加载器。如下:
module.exports = {
...
module: {
rules: [
...
{
test: /\.(sa|sc|c)ss$/iu,
use: [
{
loader: "postcss-loader",
options: {
postcssOptions: {
plugins: [
require("autoprefixer"),
require("cssnano")({ preset: ["default", { discardComments: { removeAll: true } }] }),
],
},
},
},
"sass-loader",
]
},
...
]
},
...
};
关于 autoprefixer 的作用,这边再举个例子。例如以下 CSS 语法:
.example {
display: grid;
transition: all .5s;
user-select: none;
background: linear-gradient(to bottom, white, black);
}
经过 postcss-loader 和 autoprefixer 处理后会变成:
.example {
display: grid;
-webkit-transition: all .5s;
transition: all .5s;
-webkit-user-select: none;
-moz-user-select: none;
-ms-user-select: none;
user-select: none;
background: -webkit-gradient(linear, left top, left bottom, from(white), to(black));
background: linear-gradient(to bottom, white, black);
}
如此一来就不必太担心同一个 CSS 到不同的网页浏览器上显示出来会有很大的不同啦!
CSS 加载器
css-loader 才是真正读取 CSS 的加载器,它会去寻找 CSS 中使用 @import 或是 url() 引用的其它 CSS 文件或是图片文件,将它们也丢给 Webpack 一起打包。在终端机运行以下指令来安装这个套件:
在 webpack.config.cjs 设置档中,于 postcss-loader 之上,加入 CSS 加载器。如下:
module.exports = {
...
module: {
rules: [
...
{
test: /\.(sa|sc|c)ss$/iu,
use: [
"css-loader",
{
loader: "postcss-loader",
options: {
postcssOptions: {
plugins: [
require("autoprefixer"),
require("cssnano")({ preset: ["default", { discardComments: { removeAll: true } }] }),
],
},
},
},
"sass-loader",
]
}
...
]
},
...
};
输出 CSS
光有 CSS 加载器的话会把 CSS 文件包进 JS 文件中一起输出(若再加上 style-loader,就能让 CSS 在 JS 运行之后被注入到 HTML 中,但笔者不太喜欢这样的作法),如果要把 CSS 文件从 JS 文件中分离出来的话,我们还需要加上 mini-css-extract-plugin 这个插件,可以在终端机运行以下指令来安装。
在 webpack.config.cjs 设置档中,将 mini-css-extract-plugin 的实体加进 plugins 字段的数组中。
如下:
const MiniCssExtractPlugin = require("mini-css-extract-plugin");
module.exports = {
...
plugins: [
...
new MiniCssExtractPlugin({
filename: "./path/to/css-file"
}),
...
],
...
};
filename 字段用来设置 CSS 文件的输出路径,其设置方式和 JS 文件的 filename 是一样的。如果不设置 filename 字段,默认值会是 ./[name].css。
接着也还需要在 webpack.config.cjs 设置档中,于 css-loader 之上,加入 mini-css-extract-plugin 提供的加载器。
如下:
const MiniCssExtractPlugin = require("mini-css-extract-plugin");
module.exports = {
...
module: {
rules: [
...
{
test: /\.(sa|sc|c)ss$/iu,
use: [
MiniCssExtractPlugin.loader,
"css-loader",
{
loader: "postcss-loader",
options: {
postcssOptions: {
plugins: [
require("autoprefixer"),
require("cssnano")({ preset: ["default", { discardComments: { removeAll: true } }] }),
],
},
},
},
"sass-loader",
]
}
...
]
},
...
};
移除无用的 CSS
现在开发网页很少自己从无到有把 CSS 写出来,通常会直接套用如 Bootstrap 等的 CSS 框架,但是我们不太可能将 CSS 框架提供的 CSS 全都应用上,肯定会留有完全没有被使用到的 CSS 设置。这些没有用到的 CSS 在没有经过特殊处理的情况下也还是会被网页浏览器给读取,不仅会占用服务器流量,网页的加载时间也会比较长。
为了移除没有用到的 CSS,我们需要安装 purgecss-webpack-plugin 插件,以及方便用来取得文件路径的 glob 套件。可以在终端机运行以下指令来安装这些套件:
在 webpack.config.cjs 设置档中,将 purgecss-webpack-plugin 的实体加进 plugins 字段的数组中。
如下:
const path = require("node:path");
const glob = require("glob");
const { PurgeCSSPlugin } = require("purgecss-webpack-plugin");
const PATHS = { views: path.resolve(__dirname, "/path/to/html-or-templates-folder") };
module.exports = {
...
plugins: [
...
new PurgeCSSPlugin({
paths: glob.globSync(`${PATHS.views}/**/*`, {nodir: true}),
safelist: {
standard: [],
deep: [],
greedy: [],
},
blocklist: [],
}),
...
],
...
};
以上程序中,用了 PATHS 变量来保存一些固定、可能会被重复使用的路径。views 这个路径是用来放置 HTML 网页文件或是 HTML 模板文件的目录。在 purgecss-webpack-plugin 插件的选项中,paths 字段的值为多个路径的字符串数组,一个路径应指向一个纯文字文件,purgecss-webpack-plugin 会自动从这些路径指到的多个纯文字文件中分析出现过的字词,并记录下来。如果 CSS 的元素名称并没有出现在这些字词中,该元素就会被删除,除非该名称存在于白名单之中。
而 purgecss-webpack-plugin 的白名单分为三种,用 safelist 字段来设置,这三种会被同时使用。
首先是 standard,这个是很单纯的名称对应。例如:
{
standard: ["example"],
deep: [],
greedy: [],
}
若输入的 CSS 为:
.example {
width: 100%;
}
.example p {
font-size: 15px;
}
#example {
width: 100%;
}
.example-2 {
width: 100%;
}
经过白名单的检查之后,只会剩下:
.example {
width: 100%;
}
#example {
width: 100%;
}
如果将白名单改为:
{
standard: ["example", "p"],
deep: [],
greedy: [],
}
继续使用以上的例子,最后它被保留的 CSS 元素则为:
.example {
width: 100%;
}
.example p {
font-size: 15px;
}
#example {
width: 100%;
}
再来是第二种白名单 deep,这个也是用来对应名称,但是可以使用正则表达式来匹配元素名称,而且匹配成功的名称之后的其它名称都不会再被检查,所以连它的子元素的 CSS 也会被保留下来。例如:
{
standard: [],
deep: [/^example/],
greedy: [],
}
继续使用同样的例子,最后例子中所有的 CSS 元素都可以被保留下来。注意这边连 .example p 也被保留了!因为 .example 被匹配到之后,就不会再去检查后面的 p 这个名称。
不过,deep 白名单是从选择器的第一个名称开始依序检查,如果在遇到匹配成功的名称之前,就先遇到了没有被使用到的名称,整个选择器还是会被删除。例如 .container .example,若 container 这个名称并没有出现在 paths 字段所指到的文件中,即便 example 可以被 deep 白名单匹配到,这个选择器也还是会被删除。
如果想要让 .container .example 也被保留下来,可以使用第三种白名单 greedy,只要选择器中有任何一个名称被这个白名单的正则表达式匹配成功,整个选择器就会被保留下来。
HTML 网页
Webpack 的 HTML 网页大致上可以分为两种,一种是将主要的 CSS 语法甚至是 HTML 语法都写进 JavaScript 中,而 HTML 文件内只有撰写如下的内容:
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8"/>
<title>Title</title>
<!-- 可能会有简单的CSS -->
</head>
<body>
<!-- 可能会有读取画面 -->
<script type="text/javascript" src="./path/to/bundle.min.js"></script>
</body>
</html>
当网页浏览器打开这个 HTML 网页时,网页浏览器就会下载 JavaScript 文件来运行,接着将 HTML 和 CSS 注入到 HTML 网页中,此时网页才会显示出真正的内容。
这种网页通常会利用大量的 JavaScript 程序来完成画面的操作流程,让用户在操作网页时不太需要加载新网页,但这种网页在打开的时候通常会有一个等待时间。这部份的用法可以参考这篇文章:
这篇文章要介绍的是第二种的网页,就是传统将 HTML 语法直接写在 HTML 文件内的作法。例如:
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8"/>
<title>Title</title>
<script type="text/javascript" src="./path/to/bundle.min.js"></script>
<link href="./path/to/bundle.min.css" rel="stylesheet">
</head>
<body>
<main class="container">
<h1 class="mt-5">欢迎</h1>
<p class="lead">这是我用Webpack做的第一个网页。</p>
<p>如果你也有兴趣的话可以浏览<a href="https://magiclen.org/webpack/">这篇文章</a>。</p>
</main>
<footer class="footer">
<div class="container">
<span class="text-muted">没有著作权,欢迎分享</span>
</div>
</footer>
</body>
</html>
其实这种网页,HTML 的部份也不太需要用 Webpack 来打包,不过放进 Webpack 框架中有个最大的好处,那就是可以让它被最小化!
最小化 HTML 网页
html-webpack-plugin 插件可以帮助我们产生 HTML 文件(如刚才提到的第一种网页),或是将现有的 HTML 文件最小化。可以在终端机运行以下指令来安装这个套件:
在 webpack.config.cjs 设置档中,将 html-webpack-plugin 的实体加进 plugins 字段的数组中,有几个 HTML 文件就加几个 html-webpack-plugin 的实体。
如下:
const HtmlWebpackPlugin = require("html-webpack-plugin");
module.exports = {
...
plugins: [
...
new HtmlWebpackPlugin({
template: "./path/to/original-html-file",
filename: "./path/to/output-html-file",
minify: {
collapseBooleanAttributes: true,
collapseWhitespace: true,
removeAttributeQuotes: true,
removeComments: true,
removeEmptyAttributes: true,
removeRedundantAttributes: true,
removeScriptTypeAttributes: true,
removeStyleLinkTypeAttributes: true,
minifyCSS: true,
minifyJS: true,
sortAttributes: true,
useShortDoctype: true,
},
inject: false,
}),
...
]
...
};
filename 字段用来设置 HTML 文件的输出路径,其设置方式和 JS 文件的 filename 是一样的。
如此一来,经过 Webpack 打包后就会得到最小化的 HTML 文件。
把 HTML 文件当作进入点来用
事实上有个 html-loader 加载器,它可以去解析 HTML 中有链接用到的静态资源网址,并且如 css-loader 加载器一样可以做到取代网址的动作。换句话说,利用它可以使 HTML 文件也能够作为进入点,去打包其有用到的静态文件。不过这个加载器的问题有点多,不去用它还比较省时间。
举一些例子来说明常见问题
关于 libraryTarget
现在 Node.js 项目中有以下几个文件。
export function greet(name) {
alert(`Hello, ${name}!`);
}
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8"/>
<title>Greeting</title>
<script src="./js/bundle.min.js"></script>
</head>
<body>
You should see an alert message.
<script>
greet("Webpack");
</script>
</body>
</html>
const TerserPlugin = require("terser-webpack-plugin");
const HtmlWebpackPlugin = require("html-webpack-plugin");
module.exports = {
output: {
clean: true,
filename: "./js/bundle.min.js",
},
plugins: [
new HtmlWebpackPlugin({
template: "./views/index.html",
filename: "./index.html",
minify: {
collapseBooleanAttributes: true,
collapseWhitespace: true,
removeAttributeQuotes: true,
removeComments: true,
removeEmptyAttributes: true,
removeRedundantAttributes: true,
removeScriptTypeAttributes: true,
removeStyleLinkTypeAttributes: true,
minifyCSS: true,
minifyJS: true,
sortAttributes: true,
useShortDoctype: true,
},
inject: false,
}),
],
module: {
rules: [
{
test: /\.js$/iu,
use: {
loader: "babel-loader",
options: { presets: ["@babel/preset-env"] },
},
},
],
},
optimization: {
minimizer: [
new TerserPlugin({
extractComments: false,
terserOptions: { format: { comments: false } },
}),
]
},
};
记得用以下指令安装所需的套件:
在运行 npm run build:webpack 之后,用网页浏览器打开 dist/index.html。我们预期会看到一个对话框,上面写着 Hello, Webpack!,然而实际上并没有,而且网页浏览器的主控台(console)还跳出错误消息,说是 greet 函数没有定义。
这个其实是因为我们在 webpack.config.cjs 的 output 字段中,并没有去设置 library 字段的值,如果我们将 library 字段的值设为 lib,如下:
module.exports = {
...
output: {
...
library: "lib",
...
}
...
};
就可以将 HTML 语法改成以下这样来调用到 greet 函数。
...
<body>
...
<script>
lib.greet("Webpack");
</script>
</body>
...
为什么会这样?这是因为若我们没有在 webpack.config.cjs 的 output 字段中设置 libraryTarget 字段的值,这个值预设为 var,在 var 模式下,用来设置全域变量的 library 字段的值若没有设置,就无法正常使用了,因为没有一个 JS 全域变量有保存到我们的 JS 模块。
如果要将我们的 JS 模块指派给网页浏览器下的 window 对象来保存的话,可以将 libraryTarget 字段的值改为 window,此时的 library 字段的值就代表我们的 JS 模块会存在 window 对象的哪个字段。例如:
module.exports = {
...
output: {
...
libraryTarget: "window",
library: "lib"
...
}
...
};
...
<body>
...
<script>
window.lib.greet("Webpack");
</script>
</body>
...
不过由于网页中的 JavaScript 会自动去看没有被定义的变量是否是 window 对象的属性,所以 HTML 中的 JS 程序其实也可以写成最一开始的模样:
...
<body>
...
<script>
lib.greet("Webpack");
</script>
</body>
...
若 libraryTarget 字段的值为 window,但没有设置 library 字段的值的话,我们的 JS 模块内有被暴露(export)的项目会被塞给 window 对象。如此一来就可以直接在网页中调用 greet 函数了!
...
<body>
...
<script>
greet("Webpack");
</script>
</body>
...
不过最多人喜欢使用的 libraryTarget 字段值应该是 umd,它除了有支持 root( 即 window 或 global,要看 webpack.config.cjs 的 target 是设为 Node.js 还是网页浏览器,预设为 web,即网页浏览器)外,还支持 AMD(Asynchronous Module Definition,用 define 来引用模块;用 return 来暴露)、CommonJS(用 require 来引用模块;用 module.exports 或 exports 来暴露)等 JS 模块化的机制。
如果 library 字段值为 lib,它的 JS 输出格式会像是这样:
(function webpackUniversalModuleDefinition(root, factory) {
if(typeof exports === 'object' && typeof module === 'object') // CommonJS
module.exports = factory();
else if(typeof define === 'function' && define.amd) // AMD
define([], factory);
else if(typeof exports === 'object') // CommonJS
exports["lib"] = factory();
else // root
root["lib"] = factory();
})(window /* or global */, ...);
如果 library 字段没有设置,它的 JS 输出格式会像是这样:
(function webpackUniversalModuleDefinition(root, factory) {
if(typeof exports === 'object' && typeof module === 'object') // CommonJS
module.exports = factory();
else if(typeof define === 'function' && define.amd) // AMD
define([], factory);
else { // root
var a = factory();
for(var i in a) (typeof exports === 'object' ? exports : root)[i] = a[i];
}
})(window /* or global */, ...);
在 Webpack 中用 Vue.js
Vue.js 是一个非常方便、可在前端或后端运作的框架兼模板引擎。
现在 Node.js 项目中有以下几个文件。
import * as Vue from "vue";
const main = {
data() {
return { message: "Hello, Webpack!" };
},
mounted() {
alert("Mounted!");
},
};
export function init() {
Vue.createApp(main).mount("#main");
}
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8"/>
<title>Greeting</title>
<script src="./js/bundle.min.js"></script>
</head>
<body>
<div id="main">
{{message}}
</div>
<script>
init();
</script>
</body>
</html>
const TerserPlugin = require("terser-webpack-plugin");
const HtmlWebpackPlugin = require("html-webpack-plugin");
module.exports = {
output: {
clean: true,
filename: "./js/bundle.min.js",
libraryTarget: "window",
},
plugins: [
new HtmlWebpackPlugin({
template: "./views/index.html",
filename: "./index.html",
minify: {
collapseBooleanAttributes: true,
collapseWhitespace: true,
removeAttributeQuotes: true,
removeComments: true,
removeEmptyAttributes: true,
removeRedundantAttributes: true,
removeScriptTypeAttributes: true,
removeStyleLinkTypeAttributes: true,
minifyCSS: true,
minifyJS: true,
sortAttributes: true,
useShortDoctype: true,
},
inject: false,
}),
],
module: {
rules: [
{
test: /\.js$/iu,
use: {
loader: "babel-loader",
options: { presets: ["@babel/preset-env"] },
},
},
],
},
optimization: {
minimizer: [
new TerserPlugin({
extractComments: false,
terserOptions: { format: { comments: false } },
}),
]
},
};
记得用以下指令安装所需的套件:
也记得要安装 Vue.js:
在运行 npm run build:webpack 之后,用网页浏览器打开 dist/index.html。我们会看到一个对话框,上面写着 Mounted!。
用 Webpack 打包 Font Awesome
Font Awesome 是非常多人用的 Icon Font,但是它在 Webpack 下使用时有个地方需要注意,否则无法正常打包。
现在 Node.js 项目中有以下几个文件。
@import "~@fortawesome/fontawesome-free/scss/fontawesome";
@import "~@fortawesome/fontawesome-free/scss/solid";
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8"/>
<title>Apple</title>
<link href="./css/bundle.min.css" rel="stylesheet">
</head>
<body>
<i class="fas fa-apple-alt fa-10x"></i>
</body>
</html>
const MiniCssExtractPlugin = require("mini-css-extract-plugin");
const HtmlWebpackPlugin = require("html-webpack-plugin");
module.exports = {
entry: "./src/index.scss",
output: {
clean: true,
},
plugins: [
new HtmlWebpackPlugin({
template: "./views/index.html",
filename: "./index.html",
minify: {
collapseBooleanAttributes: true,
collapseWhitespace: true,
removeAttributeQuotes: true,
removeComments: true,
removeEmptyAttributes: true,
removeRedundantAttributes: true,
removeScriptTypeAttributes: true,
removeStyleLinkTypeAttributes: true,
minifyCSS: true,
minifyJS: true,
sortAttributes: true,
useShortDoctype: true,
},
inject: false,
}),
new MiniCssExtractPlugin({ filename: "./css/bundle.min.css" }),
],
module: {
rules: [
{
test: /\.(sa|sc|c)ss$/i,
use: [
MiniCssExtractPlugin.loader,
"css-loader",
{
loader: "postcss-loader",
options: {
postcssOptions: {
plugins: [
require("autoprefixer"),
require("cssnano")({ preset: ["default", { discardComments: { removeAll: true } }] }),
],
},
},
},
"sass-loader",
],
},
{
test: /\.(eot|woff|woff2|[ot]tf)$/iu,
type: "asset/resource",
generator: { filename: "fonts/[name][ext]" },
},
{
test: /.*font.*\.svg$/iu,
type: "asset/resource",
generator: { filename: "fonts/[name][ext]" },
},
],
},
};
记得用以下指令安装所需的套件:
也记得要安装 Font Awesome:
但在运行 npm run build:webpack 时,会出现如下的错误消息:
这个是因为 Sass/SCSS 在使用 @import 关键字引用其它 Sass/SCSS 文件(不包含 CSS 文件)时,貌似是直接拿目标文件的内容来取代掉那行 @import 关键字,所以如果目标文件的内容有用到相对路径就会出问题。解决的方法有两种,第一种就是改成去 @import CSS 文件(如果有的话),如下:
@import "~@fortawesome/fontawesome-free/css/fontawesome.css";
@import "~@fortawesome/fontawesome-free/css/solid.css";
第二种就是去设置 Sass/SCSS 中保存着路径前缀的变量,以 Font Awesome 来说,这个变量为 $font-path。早期的 Sass/SCSS 可以直接在 @import 外面设置变量去影响 @import 的文件所使用的变量,但新版的模块机制改用 @use 来引用 Sass/SCSS,有不一样的变量设置方式,而 fontawesome 在 v7 之后也使用了新的机制啰!所以要改用以下的方式来引用:
@use "~@fortawesome/fontawesome-free/scss/variables" with (
$font-path: "~@fortawesome/fontawesome-free/webfonts"
);
@use "~@fortawesome/fontawesome-free/scss/fontawesome";
@use "~@fortawesome/fontawesome-free/scss/solid";
改写之后 npm run build:webpack 就可以正常被运行。用网页浏览器打开 dist/index.html,就可以看到大大的苹果图标。

