虽然在撰写程序的时候,在大部份的情况下我们都想要让程序运行速度愈快愈好。但有时候在写测试程序或是爬虫时,我们会希望让程序等待一段时间再继续运行,以模拟 I/O 延迟或是真人操作延迟的效果。不过 JavaScript 并没有直接提供让线程睡眠(sleep)的功能,要怎么模拟出 sleep 函数呢?

先看看以下的程序:

let counter = 1;

for (;;) {
    console.log(counter);
    counter += 1;
}

以上程序会以飞快的速度印出不断加一的数字。

如果我们想要借由在循环内加上一个 sleep 函数来控制数字印出的速度,这个 sleep 函数该怎么实作呢?

let counter = 1;

for (;;) {
    console.log(counter);
    sleep(1000); // wait for 1000ms
    counter += 1;
}

有些人可能会写出如下的 sleep 函数:

// 不要用,这是烂Code!
const sleep = (milliseconds: number) => {
    const now = Date.now();

    while (Date.now() < now + milliseconds) {
        // do nothing
    }
};

这种实作方式虽然简单直觉,但会使一个 CPU 逻辑内核的使用率变成 100%,十分吃硬件资源,称为忙碌等待(busy waiting)。程序会在没多少干扰下不断地循环运行循环的条件式,最好不要写出这样的程序。

比较好的作法是利用 Promise 和 setTimeout 函数来完成这个 sleep 函数。程序如下:

const sleep = (milliseconds: number): Promise<void> => new Promise((resolve) => {
    setTimeout(resolve, milliseconds);
});

但如果我们用以上代码直接替换掉原本的 sleep 函数,重新运行主程序,却会发现循环的运行速度根本就没有被成功控制。因为现在这个 sleep 函数是异步(asynchronous)运行的,它睡它的,程序依然还在运行。

我们可以利用 async/await 语法来改写主程序,使主程序运行在异步函数中,并且去对 sleep 函数做 await 的动作。程序改写如下:

const sleep = (milliseconds: number): Promise<void> => new Promise((resolve) => {
    setTimeout(resolve, milliseconds);
});

const main = async () => {
    let counter = 1;

    for (;;) {
        console.log(counter);
    
        await sleep(1000);
    
        counter += 1;
    }
};

void main();

您也可以观察一下,在运行 Promise 版的 sleep 函数时的 CPU 占用率,会发现它几乎不占用 CPU 了!

如果您还是想要一个同步(synchronous)版本的 sleep 函数,可以使用 Atomics.wait 函数来实作,同样几乎不占用 CPU。实作方式如下:

const sleep = (milliseconds: number) => {
    Atomics.wait(new Int32Array(new SharedArrayBuffer(4)), 0, 0, milliseconds);
};

let counter = 1;

for (;;) {
    console.log(counter);
    
    sleep(1000);
    
    counter += 1;
}

不过,SharedArrayBuffer 虽然可以在 Node.js 的环境下被使用,但是在网页浏览器上,只有在网页有设置 Cross-Origin-Opener-Policy: same-origin 和 Cross-Origin-Embedder-Policy: require-corp 这两个 HTTP 标头时才可以被使用。

调用 Atomics.wait 函数需传入四个参数,第一个参数是一个只有一个元素的 Int32Array(即数组长度为 1,因为 SharedArrayBuffer 的单位是字节,需要 4 个字节才能组成一个 32 比特的 int),第二个参数则是设置要监看前面那个 Int32Array 的哪个索引位置,第三个参数则是设置监看的索引位置的值是否是 Int32Array 的那个索引位置的值。如果是的话,就等待第四个参数所设置的时间长度(毫秒),然后回传字符串 timed-out;如果不是的话,就立刻回传字符串 not-equal。