Javascript 简明教程

JavaScript - Yield Operator

JavaScript Yield Operator

JavaScript 中的 yield 运算符用于异步暂停和恢复生成器函数。在 JavaScript 中, generator 函数是可在执行时暂停或恢复的特殊函数。生成器函数使用“function*”语法定义。 yield 关键字只能在包含它的生成器函数中使用。

yield 运算符暂停生成器函数的执行,并将其操作数(表达式)返回给生成器的调用方。

Syntax

JavaScript 中 yield 运算符的语法如下:

yield expression;

Paramter

  1. expression - 要通过迭代器协议从生成器函数中获取的值。如果省略表达式,则获取“undefined”。

Return value

它返回传递给生成器的 next() 方法的可选值,以恢复其执行。

Yield Operator in Genrator Function

为了理解 yield 运算符,让我们先了解生成器函数的工作原理。

当调用生成器函数时,它会返回一个生成器对象。当调用此生成器对象的 next() 方法时,它会恢复生成器函数的执行。当遇到 yield 表达式时,它会暂停执行,并将 yield 关键字后面的表达式返回给对象的调用方(next() 方法)。

生成器对象的 next() 方法返回一个具有两个属性的迭代器对象: valuedonevalue 是表达式的实际值,而 done 是一个布尔值。如果生成器函数已完全执行,则 done 属性为 true,否则为 false。

下面是带有 yield 关键字(运算符)的生成器函数的完整示例代码。

function* test() {
 // function code
 yield expression;
}
const genObj = test();
genObj.next();

在上面的语法中,“function*”用于创建一个名为 test 的生成器函数,yield 关键字用于从函数返回“expression”。

调用生成器函数 test,并将返回的生成器对象赋予变量 genObj。当遇到 yield 表达式时,next() 方法会恢复函数的执行并返回迭代器对象。

让我们执行以下 JavaScript 代码段:

function* test() {
    console.log("I'm before yield expression");
    yield 20;
}
const genObj = test();
console.log(genObj.next());

请注意,当我们调用 next() 方法时,它会先在控制台显示消息,然后显示迭代器对象。

I'm before yield expression
{ value: 20, done: false }

Example: Returning a value

在下文中,我们定义了 test() 生成器函数。我们在函数中 3 次使用 yield 运算符分别返回一个数字、一个数组和一个字符串。

然后,我们 4 次使用 next() 方法恢复函数的执行。每当控制流查找 yield 运算符时,它会停止执行并返回该值。

在输出中,你可以观察到它返回包含 yield 运算符的运算对象和布尔值。

function* test() {
    yield 20;
    yield [1,2,3];
    yield "Hello World";
}
let res = test();
console.log(res.next());
console.log(res.next());
console.log(res.next());
console.log(res.next());

Output

{ value: 20, done: false }
{ value: [ 1, 2, 3 ], done: false }
{ value: 'Hello World', done: false }
{ value: undefined, done: true }

Example: Returning undefined

当我们在 yield 关键字后面省略表达式时,它将返回未定义。

function* test() {
    yield;
}

let res = test();
console.log(res.next());
console.log(res.next());

Output

{ value: undefined, done: false }
{ value: undefined, done: true }

Example: Passing a value to the next() method

我们还可以将值传递给 next() 方法。在下面的示例中,我们已经将 30 传递给第二个 next() 方法。它将 yield 评估为 30。变量 result 被赋值 yield 的值为 30。

function* test() {
    let result = yield 20;
    console.log("default value paased to next() method " + result);
}

let res = test();
console.log(res.next());
console.log(res.next(30));

Output

{ value: 20, done: false }
default value paased to next() method 30
{ value: undefined, done: true }

Example

在下面的代码中,我们使用了循环,在每个操作中,我们使用 yield 运算符停止函数的执行。之后,我们使用 next() 方法启动生成器函数的执行。

// Generator function
function* test() {
    for (let p = 0; p < 6; p += 2) {
        yield p;
    }
}
let res = test();
console.log(res.next());
console.log(res.next());
console.log(res.next());
console.log(res.next());

Output

{ value: 0, done: false }
{ value: 2, done: false }
{ value: 4, done: false }
{ value: undefined, done: true }

在实时开发中,程序员将“yield”运算符用于异步操作、延迟评估、任务调度、遍历大型数据集、创建自定义迭代器等。