点此查看 所有教程、项目、源码导航
文章目录
- [1. 背景介绍](#1. 背景介绍)
- [2. 基础写法](#2. 基础写法)
- [3. 执行流程](#3. 执行流程)
- [4. next 传参](#4. next 传参)
- [5. return 与 throw](#5. return 与 throw)
-
- [5.1 return](#5.1 return)
- [5.2 throw](#5.2 throw)
- [6. for...of 遍历生成器](#6. for...of 遍历生成器)
- [7. yield*](#7. yield*)
- [8. 简单异步场景演示](#8. 简单异步场景演示)
- [9. 小结](#9. 小结)
1. 背景介绍
普通函数一旦开始执行,就会一口气跑完,中途没法暂停。生成器是 ES6 提供的一类特殊函数,可以暂停执行,之后又能从暂停的地方恢复运行。
生成器天然就是可迭代对象,和刚才学的迭代器关系紧密。早期社区甚至利用「生成器 + Promise」模拟出类似 async / await 的效果,弄懂它,就能理解异步语法糖背后的思路。
Promise、async / await后续会学习,此处了解即可。
2. 基础写法
声明生成器,要在 function 后面加一个星号 *;函数内部使用 yield 关键字设置暂停点。
js
function* gen() {
yield "第一段"
yield "第二段"
yield "第三段"
}
调用生成器函数,并不会立刻执行里面的代码,而是返回一个迭代器对象。我们调用它的 next(),才会往下执行,直到碰到 yield 就停下。
js
const g = gen()
console.log(g.next()) // { value: "第一段", done: false }
console.log(g.next()) // { value: "第二段", done: false }
console.log(g.next()) // { value: "第三段", done: false }
console.log(g.next()) // { value: undefined, done: true }
next 返回的结构和迭代器完全一致:
value:当前yield产出的值done:是否全部执行完毕
3. 执行流程
我们看这个例子,跟踪执行顺序:
js
function* gen() {
console.log("开始")
yield 1
console.log("走到中间")
yield 2
console.log("结束")
}
const g = gen()
g.next() // 打印开始,暂停在 yield 1
g.next() // 打印走到中间,暂停在 yield 2
g.next() // 打印结束,到达末尾
简单概括:
gen():只拿到迭代器,函数体不动- 第一次
next():执行到第一个 yield - 再次
next():从上一次暂停位置继续往下走 - 如果走到函数 return,或者全部代码跑完,
done变为 true
4. next 传参
next 还可以传入参数,这个参数会作为上一条 yield 的返回值。
js
function* gen() {
const res1 = yield "请传入第一个值"
console.log(res1)
const res2 = yield "请传入第二个值"
console.log(res2)
}
const g = gen()
g.next()
g.next("小明") // 打印 小明
g.next(18) // 打印 18
注意:第一次调用
next传入的数据没有接收者,因为还不存在上一个 yield。
5. return 与 throw
5.1 return
调用迭代器的 return(),可以直接终止生成器,后续 yield 不再执行。
js
function* gen() {
yield 1
yield 2
yield 3
}
const g = gen()
console.log(g.next())
console.log(g.return(99))
console.log(g.next())
5.2 throw
调用 throw(),可以在生成器内部抛出异常,我们可以用 try catch 在生成器内部捕获。
js
function* gen() {
try {
yield 1
yield 2
} catch (err) {
console.log("捕获错误:", err)
}
}
const g = gen()
g.next()
g.throw("出错啦")
6. for...of 遍历生成器
因为生成器返回的是可迭代对象,可以直接使用 for...of,它会自动调用 next,直到 done 为 true。
js
function* gen() {
yield 10
yield 20
yield 30
}
for (const item of gen()) {
console.log(item)
}
// 10
// 20
// 30
7. yield*
yield* 用来委托另一个可迭代对象,把遍历交给它,可以用来嵌套生成器。
js
function* inner() {
yield "a"
yield "b"
}
function* outer() {
yield 1
yield* inner()
yield 2
}
for (const v of outer()) {
console.log(v)
}
// 1
// a
// b
// 2
这个简单了解即可。
8. 简单异步场景演示
这个再后续学习Promise、 async / await后才好理解,此处简单了解即可。
这里用生成器配合 Promise,模拟串行异步,感受为什么它是 async / await 的前身。
js
function getUserId() {
return new Promise(resolve => {
setTimeout(() => resolve(1001), 1000)
})
}
function getUserInfo(id) {
return new Promise(resolve => {
setTimeout(() => resolve({ id, name: "小明" }), 1000)
})
}
function* task() {
const id = yield getUserId()
const info = yield getUserInfo(id)
console.log(info)
}
function run(generator) {
const g = generator()
function next(val) {
const res = g.next(val)
if (res.done) return
res.value.then(data => {
next(data)
})
}
next()
}
run(task)
当然,日常开发不会手写这套执行器,直接使用 async / await 即可。
9. 小结
- 生成器函数使用
function*定义,依靠yield设置暂停点,支持暂停、恢复。 - 调用生成器函数得到迭代器,依靠
next()驱动执行,还支持传参、提前终止、抛异常。 - 生成器属于可迭代对象,天然支持
for...of;yield*用来委托其他可迭代对象。 - 生成器可以用来编排异步,这也是 async / await 的底层灵感来源。
- 在业务开发中它使用频率不算很高,但阅读一些源码时经常会碰到。