概念

从v4.00开始,webpack可以不用再引入一个配置文件来打包项目,然而,它仍然有着高度可配置性,可以很好满足你的需求

打包命令npx webpack 前提配置好webpack.config.js 文件,否则默认打包方式

准备工作

文件和文件夹解析:

  • dist 文件夹 :用于存放之后打包的文件,也可不创建,在打包时可以生成
  • src 文件夹:用于存放我们写的源文件
  • package.json: 通过npm init 初始化生成,npm包管理文件

入口

入口起点指示 webpack 应该使用哪个模块,来作为构建其内部依赖图的开始。进入入口起点后,webpack会找出有哪些模块和库是入口起点(直接和间接)依赖的。

默认值是./src/index.js,但是你可以通过webpack configuration中配置entry属性

webpack.config.js

1
2
3
module.exports = {
entry: './path/to/my/entry/file.js',
};

输出

output 属性告诉 webpack 在哪里输出它所创建的 bundle,以及如何命名这些文件。主要输出文件的默认值是 ./dist/main.js,其他生成文件默认放置在 ./dist 文件夹中。

你可以通过在配置中指定一个 output 字段,来配置这些处理过程:

webpack.config.js

1
2
3
4
5
6
7
8
9
const path = require('path'); //获取路径

module.exports = {
entry: './path/to/my/entry/file.js', //入口
output: {
path: path.resolve(__dirname, 'dist'), //path是绝对路径,通过path获取
filename: 'my-first-webpack.bundle.js', //打包bundle.js的命名
},
};

在上面的示例中,我们通过 output.filenameoutput.path 属性,来告诉 webpack bundle 的名称,以及我们想要 bundle 生成到哪里。可能你想要了解在代码最上面导入的 path 模块是什么,它是一个 Node.js 核心模块,用于操作文件路径。

配置好简单的webpack文件,试着打包一下我们的项目

打包项目示例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
// ./src/main.js
// main.js写了一些变量、函数、对象,进行ES6导出操作
let name = '小明'
let age = 18
let obj ={
name: '小华',
age: '19'
}
function add(num1,num2){
return num1 + num2;
}

function mul(num1,num2){
return num1 * num2;
}

export{
add,
mul,
name,
age,
obj
}
1
2
3
4
5
6
7
8
9
10
// ./src/index.js
// 导入刚才main.js导出的变量函数等
import {add,mul,name,age,obj} from './main.js'

console.log(name + '的年龄:');
console.log(age);
console.log(obj.name + '的年龄:');
console.log(obj.age);
console.log(name + '和' + obj.name + '的年纪相加等于' + '=' + add(age, obj.age));
console.log(name + '和' + obj.name + '的年纪相乘等于' + '=' + mul(age, obj.age));
1
2
3
4
5
6
7
8
9
10
11
// 配置文件 webpack.config.js,
const path = require('path');

// _dirname: 是node里面的webpack.config.js的绝对路径, 然后加一个dist文件
module.exports = {
entry: './src/index.js',
output: {
path: path.resolve(__dirname, 'dist'),
filename: 'my-first-webpack.bundle.js',
},
};
1
2
3
4
5
<!--创建一个index.html文件引用打包的js-->
<body>
<script src="dist/my-first-webpack.bundle.js" type="text/javascript" charset="utf-8">
</script>
</body>

打包命令npx webpack 前提配置好webpack.config.js 文件,否则默认打包方式

loader

webpack 只能理解 JavaScript 和 JSON 文件,这是 webpack 开箱可用的自带能力。loader 让 webpack 能够去处理其他类型的文件,并将它们转换为有效 模块,以供应用程序使用,以及被添加到依赖图中。

注意,loader 能够 import 导入任何类型的模块(例如 .css 文件),这是 webpack 特有的功能,其他打包程序或任务执行器的可能并不支持。我们认为这种语言扩展是很有必要的,因为这可以使开发人员创建出更准确的依赖关系图。

在更高层面,在 webpack 的配置中,loader 有两个属性:

  1. test 属性,识别出哪些文件会被转换。使用正则表达式匹配后缀名文件
  2. use 属性,定义出在进行转换时,应该使用哪个 loader。

webpack.config.js

1
2
3
4
5
6
7
8
9
10
11
12
const path = require('path');

module.exports = {
output: {
filename: 'my-first-webpack.bundle.js',
},
module: {
rules: [{ test: /\.txt$/, use: 'raw-loader' }],
},
//使用多个loader时:use: ['style-loader,'css.loader']
//逐渐webpack解析是从右到左的,先加载css.loader,再加载style-loader
};

以上配置中,对一个单独的 module 对象定义了 rules 属性,里面包含两个必须属性:testuse。这告诉 webpack 编译器(compiler) 如下信息:

“嘿,webpack 编译器,当你碰到「在 require()/import 语句中被解析为 ‘.txt’ 的路径」时,在你对它打包之前,先 use(使用) raw-loader 转换一下。”

演示一下

请一定要输入正确的配置名,否则报错你都不知道为什么

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
// ./src/index.js
// 导入刚才main.js导出的变量函数等
// import { add, mul, name, age, obj } from './main.js'
const { add, mul, name, age, obj } = require('./main.js')

console.log(name + '的年龄:');
console.log(age);
console.log(obj.name + '的年龄:');
console.log(obj.age);
console.log(name + '和' + obj.name + '的年纪相加等于' + '=' + add(age, obj.age));
console.log(name + '和' + obj.name + '的年纪相乘等于' + '=' + mul(age, obj.age));


// 我们定义了一个css文件,index.css
// 来让index.js文件 依赖index.css文件
require('./css/index.css')
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
const path = require('path');

module.exports = {
entry: './src/index.js',
output: {
path: path.resolve(__dirname, 'dist'),
filename: 'my-first-webpack.bundle.js',
},
module: {
rules: [{
test: /\.css$/,
use: ['style-loader', 'css-loader']
}]
}
};

我使用了两个loader,因此我们需要允许之前安装一下loader

npm install --save-dev style-loader

npm install --save-dev css-loader

通过这个两个命令安装style-loadercss-loader ,前者负责解析css文件,后者负责打包依赖文件

使用命令进行打包:npm run build 启动本地webpack


重要的是要记住,在 webpack 配置中定义 rules 时,要定义在 module.rules 而不是 rules 中。为了使你便于理解,如果没有按照正确方式去做,webpack 会给出警告。

请记住,使用正则表达式匹配文件时,你不要为它添加引号。也就是说,/\.txt$/'/\.txt$/'"/\.txt$/" 不一样。前者指示 webpack 匹配任何以 .txt 结尾的文件,后者指示 webpack 匹配具有绝对路径 ‘.txt’ 的单个文件; 这可能不符合你的意图。

插件

loader 用于转换某些类型的模块,而插件则可以用于执行范围更广的任务。包括:打包优化,资源管理,注入环境变量。

想要使用一个插件,你只需要 require() 它,然后把它添加到 plugins 数组中。多数插件可以通过选项(option)自定义。你也可以在一个配置文件中因为不同目的而多次使用同一个插件,这时需要通过使用 new 操作符来创建一个插件实例。

webpack.config.js

1
2
3
4
5
6
7
8
9
const HtmlWebpackPlugin = require('html-webpack-plugin'); // 通过 npm 安装
const webpack = require('webpack'); // 用于访问内置插件

module.exports = {
module: {
rules: [{ test: /\.txt$/, use: 'raw-loader' }],
},
plugins: [new HtmlWebpackPlugin({ template: './src/index.html' })],
};

在上面的示例中,html-webpack-plugin 为应用程序生成一个 HTML 文件,并自动注入所有生成的 bundle。

在 webpack 配置中使用插件是简单直接的。然而,也有很多值得我们进一步探讨的用例。查看这里了解更多

模式

通过选择 development, productionnone 之中的一个,来设置 mode 参数,你可以启用 webpack 内置在相应环境下的优化。其默认值为 production

1
2
3
4
5
6
// development 开发者模式,打包后可以清晰看到webpack结构
// production 产品模式,无法看清webpack结构
// 当你需要看webpack打包的内容,请选择开发者模式
module.exports = {
mode: 'production',
};

想要了解更多,请查阅 mode 配置,这里有具体每个值相应的优化行为。

浏览器兼容性

webpack 支持所有符合 ES5 标准 的浏览器(不支持 IE8 及以下版本)。webpack 的 import()require.ensure() 需要 Promise。如果你想要支持旧版本浏览器,在使用这些表达式之前,还需要 提前加载 polyfill

环境

webpack 5 运行于 Node.js v10.13.0+ 的版本。