[JavaScript知识库]ES6模块化与异步编程高级用法

目标

• 能够知道如何使用 ES6 的模块化语法
• 能够知道如何使用 Promise 解决回调地狱的问题
• 能够知道如何使用 async/await 简化 Promise 的调用
• 能够说出什么是 EventLoop
• 能够说出宏任务和微任务的执行顺序

一、ES6 模块化

1. 回顾：node.js 中如何实现模块化

node.js 遵循了 CommonJS 的模块化规范。其中：

• 导入其它模块使用 require() 方法
• 模块对外共享成员使用 module.exports 对象

模块化的好处：

大家都遵守同样的模块化规范写代码，降低了沟通的成本，极大方便了各个模块之间的相互调用，利人利己。

2. 前端模块化规范的分类

在 ES6 模块化规范诞生之前，JavaScript 社区已经尝试并提出了 AMD、CMD、CommonJS 等模块化规范。

但是，这些由社区提出的模块化标准，还是存在一定的差异性与局限性、并不是浏览器与服务器通用的模块化标准，例如：

• AMD 和 CMD 适用于浏览器端的 Javascript 模块化
• CommonJS 适用于服务器端的 Javascript 模块化

太多的模块化规范给开发者增加了学习的难度与开发的成本。因此，大一统的 ES6 模块化规范诞生了！

3. 什么是 ES6 模块化规范

ES6 模块化规范是浏览器端与服务器端通用的模块化开发规范。它的出现极大的降低了前端开发者的模块化学习成本，开发者不需再额外学习 AMD、CMD 或 CommonJS 等模块化规范。

ES6 模块化规范中定义：

• 每个 js 文件都是一个独立的模块
• 导入其它模块成员使用 import 关键字
• 向外共享模块成员使用 export 关键字

4. 在 node.js 中体验 ES6 模块化

node.js 中默认仅支持 CommonJS 模块化规范，若想基于 node.js 体验与学习 ES6 的模块化语法，可以按照如下两个步骤进行配置：
① 确保安装了 v14.15.1 或更高版本的 node.js
② 在 package.json 的根节点中添加 "type": "module" 节点

快速初始化包管理配置文件：

$ npm init -y

{
 // --> 手动指定type为module
  "type": "module",
  "name": "node_study",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "license": "ISC"
}

5. ES6 模块化的基本语法

ES6 的模块化主要包含如下 3 种用法：
① 默认导出与默认导入
② 按需导出与按需导入
③ 直接导入并执行模块中的代码

5.1 默认导出与默认导入

5.1.1 默认导出

默认导出的语法： export default 默认导出的成员

01_m1.js：

5.1.2 默认导入

默认导入的语法： import 接收名称 from '模块标识符'

01_m2.js：

执行：

5.1.3 默认导出的注意事项

每个模块中，只允许使用唯一的一次 export default，否则会报错！

执行：

5.1.4 默认导入的注意事项

默认导入时的接收名称可以任意名称，只要是合法的成员名称即可：

5.2 按需导出与按需导入

5.2.1 按需导出

按需导出的语法： export 按需导出的成员

5.2.2 按需导入

按需导入的语法： import { s1 } from '模块标识符'

5.2.3 按需导出与按需导入的注意事项

① 每个模块中可以使用多次按需导出
② 按需导入的成员名称必须和按需导出的名称保持一致
③ 按需导入时，可以使用 as 关键字进行重命名
④ 按需导入可以和默认导入一起使用

02_m1.js:

export let s1 = "one"
export let s2 = "fine"

export function say() {
    console.log("Hello world!")
    return true
}

export default {
    a: 20
}

02_m2.js:

import info, { s1, s2 as str2, say } from './02_m1.js'

console.log(s1)
console.log(str2)
console.log(say())

console.log(info.a)

执行：

5.3 直接导入并执行模块中的代码

如果只想单纯地执行某个模块中的代码，并不需要得到模块中向外共享的成员。此时，可以直接导入并执行模块代码，示例代码如下：

03_m1.js:

// 在当前模块中执行一个for循环操作
for (let i = 0; i < 3; i++) {
    console.log(i)
}

03_m2.js:

// 直接导入并执行模块代码, 不需要得到模块向外共享的成员
import './03_m1.js'

执行：

二、Promise

1. 回调地狱

多层回调函数的相互嵌套，就形成了回调地狱。示例代码如下：

回调地狱的缺点：

• 代码耦合性太强，牵一发而动全身，难以维护
• 大量冗余的代码相互嵌套，代码的可读性变差

1.1 如何解决回调地狱的问题

为了解决回调地狱的问题，ES6（ECMAScript 2015）中新增了 Promise 的概念。

1.2 Promise 的基本概念

① Promise 是一个构造函数

• 我们可以创建 Promise 的实例 const p = new Promise()
• new 出来的 Promise 实例对象，代表一个异步操作

② Promise.prototype 上包含一个 .then() 方法

• 每一次 new Promise() 构造函数得到的实例对象，
• 都可以通过原型链的方式访问到 .then() 方法，例如 p.then()

③ .then() 方法用来预先指定成功和失败的回调函数

• p.then(成功的回调函数，失败的回调函数)
• p.then(result => { }, error => { })
• 调用 .then() 方法时，成功的回调函数是必选的、失败的回调函数是可选的

2. 基于回调函数按顺序读取文件内容

3. 基于 then-fs 读取文件内容

由于 node.js 官方提供的 fs 模块仅支持以回调函数的方式读取文件，不支持 Promise 的调用方式。因此，需要先运行如下的命令，安装 then-fs 这个第三方包，从而支持我们基于 Promise 的方式读取文件的内容：

$ npm install then-fs

3.1 then-fs 的基本使用

调用 then-fs 提供的 readFile() 方法，可以异步地读取文件的内容，它的返回值是 Promise 的实例对象。因此可以调用 .then() 方法为每个 Promise 异步操作指定成功和失败之后的回调函数。示例代码如下：

注意：上述的代码无法保证文件的读取顺序，需要做进一步的改进！

3.2 .then() 方法的特性

如果上一个 .then() 方法中返回了一个新的 Promise 实例对象，则可以通过下一个 .then() 继续进行处理。通过 .then() 方法的链式调用，就解决了回调地狱的问题。

3.3 基于 Promise 按顺序读取文件的内容

Promise 支持链式调用，从而来解决回调地狱的问题。示例代码如下：

3.4 通过 .catch 捕获错误

在 Promise 的链式操作中如果发生了错误，可以使用 Promise.prototype.catch 方法进行捕获和处理：

如果不希望前面的错误导致后续的 .then 无法正常执行，则可以将 .catch 的调用提前，示例代码如下：

3.5 Promise.all() 方法

Promise.all() 方法会发起并行的 Promise 异步操作，等所有的异步操作全部结束后才会执行下一步的 .then操作（等待机制）。示例代码如下：

注意：数组中 Promise 实例的顺序，就是最终结果的顺序！

3.6 Promise.race() 方法

Promise.race() 方法会发起并行的 Promise 异步操作，只要任何一个异步操作完成，就立即执行下一步的.then 操作（赛跑机制）。示例代码如下：

4. 基于 Promise 封装读文件的方法

方法的封装要求：
① 方法的名称要定义为 getFile
② 方法接收一个形参 fpath，表示要读取的文件的路径
③ 方法的返回值为 Promise 实例对象

4.1 getFile 方法的基本定义

注意：第 5 行代码中的 new Promise() 只是创建了一个形式上的异步操作。

4.2 创建具体的异步操作

如果想要创建具体的异步操作，则需要在 new Promise() 构造函数期间，传递一个 function 函数，将具体的异步操作定义到 function 函数内部。示例代码如下：

4.3 获取 .then 的两个实参

通过 .then() 指定的成功和失败的回调函数，可以在 function 的形参中进行接收，示例代码如下：

4.4 调用 resolve 和 reject 回调函数

Promise 异步操作的结果，可以调用 resolve 或 reject 回调函数进行处理。示例代码如下：

04_m.js:

import fs from 'fs'

function getFile(fpath) {
    return new Promise(function (resolve, reject) {
        fs.readFile(fpath, 'utf8', (err, dataStr) => {
            if (err)
                return reject(err)
            resolve(dataStr)
        })
    })
}

getFile('./files/1.txt').then(
    r => console.log(r),
    err => console.log(err.message)
)

三、async/await

1. 什么是 async/await

async/await 是 ES8（ECMAScript 2017）引入的新语法，用来简化 Promise 异步操作。在 async/await 出现之前，开发者只能通过链式 .then() 的方式处理 Promise 异步操作。示例代码如下：

• .then 链式调用的优点：解决了回调地狱的问题
• .then 链式调用的缺点：代码冗余、阅读性差、不易理解

2. async/await 的基本使用

使用 async/await 简化 Promise 异步操作的示例代码如下：

注：await作用于返回值为Promise的对象的方法前。

3. async/await 的使用注意事项

① 如果在 function 中使用了 await，则 function 必须被 async 修饰
② 在 async 方法中，第一个 await 之前的代码会同步执行，第一个await 之后的代码会异步执行

四、EventLoop

1. JavaScript 是单线程的语言

JavaScript 是一门单线程执行的编程语言。也就是说，同一时间只能做一件事情。

单线程执行任务队列的问题：

如果前一个任务非常耗时，则后续的任务就不得不一直等待，从而导致程序假死的问题。

2. 同步任务和异步任务

为了防止某个耗时任务导致程序假死的问题，JavaScript 把待执行的任务分为了两类：

① 同步任务（synchronous）

• 又叫做非耗时任务，指的是在主线程上排队执行的那些任务
• 只有前一个任务执行完毕，才能执行后一个任务

② 异步任务（asynchronous）

• 又叫做耗时任务，异步任务由 JavaScript 委托给宿主环境进行执行
• 当异步任务执行完成后，会通知 JavaScript 主线程执行异步任务的回调函数

3. 同步任务和异步任务的执行过程

① 同步任务由 JavaScript 主线程次序执行
② 异步任务委托给宿主环境执行
③ 已完成的异步任务对应的回调函数，会被加入到任务队列中等待执行
④ JavaScript 主线程的执行栈被清空后，会读取任务队列中的回调函数，次序执行
⑤ JavaScript 主线程不断重复上面的第 4 步

4. EventLoop 的基本概念

JavaScript 主线程从“任务队列”中读取异步任务的回调函数，放到执行栈中依次执行。这个过程是循环不断的，所以整个的这种运行机制又称为 EventLoop（事件循环）。

5. 结合 EventLoop 分析输出的顺序

正确的输出结果：ADCB。其中：

• A 和 D 属于同步任务。会根据代码的先后顺序依次被执行
• C 和 B 属于异步任务。它们的回调函数会被加入到任务队列中，等待主线程空闲时再执行

五、宏任务和微任务

1. 什么是宏任务和微任务

JavaScript 把异步任务又做了进一步的划分，异步任务又分为两类，分别是：

① 宏任务（macrotask）

• 异步 Ajax 请求、
• setTimeout、setInterval
• 文件操作
• 其它宏任务

② 微任务（microtask）

• Promise.then、.catch 和 .finally
• process.nextTick
• 其它微任务

2. 宏任务和微任务的执行顺序

每一个宏任务执行完之后，都会检查是否存在待执行的微任务，如果有，则执行完所有微任务之后，再继续执行下一个宏任务。

3. 去银行办业务的场景

① 小云和小腾去银行办业务。首先，需要取号之后进行排队

• 宏任务队列

② 假设当前银行网点只有一个柜员，小云在办理存款业务时，小腾只能等待

• 单线程，宏任务按次序执行

③ 小云办完存款业务后，柜员询问他是否还想办理其它业务？

• 当前宏任务执行完，检查是否有微任务

④ 小云告诉柜员：想要买理财产品、再办个信用卡、最后再兑换点马年纪念币？

• 执行微任务，后续宏任务被推迟

⑤ 小云离开柜台后，柜员开始为小腾办理业务

• 所有微任务执行完毕，开始执行下一个宏任务

4. 分析以下代码输出的顺序

注意：new Promise得到Promise实例后，里面的function会立即执行，这里function是一个同步任务

正确的输出顺序是：2431；分析：

① 先执行所有的同步任务

• 执行第 6 行、第 12 行代码

② 再执行微任务

• 执行第 9 行代码

③ 再执行下一个宏任务

• 执行第 2 行代码

5. 经典面试题

请分析以下代码输出的顺序 ：

console.log('1')  // 同步任务

setTimeout(function () {  // 宏任务
    console.log('2')

    new Promise(function (resolve) {
        console.log('3')
        resolve()
    }).then(function () {
        console.log('4')
    })
})

new Promise(function (resolve) {  // 同步任务
    console.log('5')
    resolve()
}).then(function () {  // 微任务
    console.log('6')
})


setTimeout(function () {  // 宏任务
    console.log('7')

    new Promise(function (resolve) {
        console.log('8')
        resolve()
    }).then(function () {
        console.log('9')
    })
})

正确的输出顺序是：15 6 234 789

六、API 接口案例

1. 案例需求

基于 MySQL 数据库 + Express 对外提供用户列表的 API 接口服务。用到的技术点如下：

• 第三方包 express 和 mysql2
• ES6 模块化
• Promise
• async/await

2. 主要的实现步骤

① 搭建项目的基本结构

② 创建基本的服务器

③ 创建 db 数据库操作模块

④ 创建 user_ctrl 业务模块

⑤ 创建 user_router 路由模块

3. 搭建项目的基本结构

① 启用 ES6 模块化支持

• 在 package.json 中声明 "type": "module"

② 安装第三方依赖包

• 运行 npm install express@4.17.1 mysql2@2.2.5

package.json:

{
  "type": "module",
  "name": "demo-code",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "dependencies": {
    "express": "^4.17.1",
    "mysql2": "^2.2.5"
  }
}

4. 创建基本的服务器

app.js:

// 使用 ES6 的默认导入语法
import express from 'express'
const app = express()

app.listen(80, () => {
    console.log('server running at http://127.0.0.1 ...')
})

运行：

demo-code> $ npm install -g nodemon
demo-code> $ nodemon app.js
[nodemon] 2.0.12
[nodemon] to restart at any time, enter `rs`
[nodemon] watching path(s): *.*
[nodemon] watching extensions: js,mjs,json
[nodemon] starting `node app.js`
server running at http://127.0.0.1 ...

5. 创建 db 数据库操作模块

db/index.js:

import mysql from 'mysql2'

const pool = mysql.createPool({
    host: '127.0.0.1',
    pool: '3306',
    database: 'my_db_01',  // 要操作的数据库名称
    user: 'root',
    password: 'root',

})

// 使用 默认导出 的方式导出一个支持 Promise API 的 pool
export default pool.promise()

附：

/*
 Navicat Premium Data Transfer

 Source Server         : 127.0.0.1
 Source Server Type    : MySQL
 Source Server Version : 100504
 Source Host           : localhost:3306
 Source Schema         : my_db_01

 Target Server Type    : MySQL
 Target Server Version : 100504
 File Encoding         : 65001

 Date: 23/09/2021 00:19:31
*/

SET NAMES utf8mb4;
SET FOREIGN_KEY_CHECKS = 0;

-- ----------------------------
-- Table structure for ev_users
-- ----------------------------
DROP TABLE IF EXISTS `ev_users`;
CREATE TABLE `ev_users`  (
  `id` int NOT NULL,
  `username` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL,
  `nickname` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL,
  PRIMARY KEY (`id`) USING BTREE
) ENGINE = InnoDB CHARACTER SET = utf8mb4 COLLATE = utf8mb4_general_ci ROW_FORMAT = Dynamic;

-- ----------------------------
-- Records of ev_users
-- ----------------------------
INSERT INTO `ev_users` VALUES (1, 'one', 'ione');
INSERT INTO `ev_users` VALUES (2, 'fine', 'ifine');
INSERT INTO `ev_users` VALUES (3, 'onefine', 'ionefine');

SET FOREIGN_KEY_CHECKS = 1;

6. 创建 user_ctrl 模块

controller/user_ctrl.js:

import db from '../db/index.js'

// 使用 ES6 的按需导出语法，导出方法
export async function getAllUser(req, res) {
    // db.query() 函数的返回值是Promise的实例对象。因此可以使用 async/await 进行简化
    const [rows] = await db.query('select id, username, nickname from ev_users')
    // console.log(rows)

    res.send({
        status: 0,
        message: '获取用户列表成功!',
        data: rows
    })
}

7. 创建 user_router 模块

router/user_router.js:

import express from 'express'
// 从 user_ctrl.js 模块中按需导入 getAllUser 函数
import { getAllUser } from '../controller/user_ctrl.js'

// 创建路由对象
const router = new express.Router()

// 挂载路由规则
router.get('/user', getAllUser)

// 使用 ES6 的默认导出语法, 将路由对象共享出去
export default router

8. 导入并挂载路由模块

app.js:

// 使用 ES6 的默认导入语法
import express from 'express'
// 使用默认导入导入路由对象
import userRouter from './router/user_router.js';

const app = express()

// 挂载用户路由模块
app.use('/api', userRouter)

app.listen(80, () => {
    console.log('server running at http://127.0.0.1 ...')
})

运行：

demo-code> $ nodemon app.js
[nodemon] 2.0.12
[nodemon] to restart at any time, enter `rs`
[nodemon] watching path(s): *.*
[nodemon] watching extensions: js,mjs,json
[nodemon] starting `node app.js`
server running at http://127.0.0.1 ...

9. 使用 try…catch 捕获异常

总结

① 能够知道如何使用 ES6 的模块化语法

• 默认导出与默认导入、按需导出与按需导入

② 能够知道如何使用 Promise 解决回调地狱问题

• promise.then()、promise.catch()

③ 能够使用 async/await 简化 Promise 的调用

• 方法中用到了 await，则方法需要被 async 修饰

④ 能够说出什么是 EventLoop

• EventLoop 示意图

⑤ 能够说出宏任务和微任务的执行顺序

• 在执行下一个宏任务之前，先检查是否有待执行的微任务