Node.js のタイマーと仕組み

Node.js のタイマーモジュールには、一定期間後にコードを実行する関数が含まれています。ブラウザの JavaScript API をエミュレートするためにすべてのメソッドがグローバルに利用可能であるため、 require() を介してタイマーをインポートする必要はありません。タイマー関数がいつ実行されるかを完全に理解するためには、 Node.js のイベントループを読むことをお勧めします。

Node.js を使って連続した時間を制御する

Node.js APIには、現時点以降のある時点でコードを実行するようにスケジューリングする方法がいくつかあります。以下の関数はほとんどのブラウザで利用可能であるためおなじみのように思われるかもしれませんが、 Node.js は実際にはこれらのメソッドの独自の実装を提供します。タイマーはシステムと非常に密接に統合されており、 API がブラウザ API を反映しているという事実があるにもかかわらず、実装にはいくつかの違いがあります。

"そう言うとき" 実行する ~ `setTimeout()`

setTimeout() を使用して、指定したミリ秒後にコードの実行をスケジュールすることができます。この関数はブラウザの JavaScript API の window.setTimeout()に似ていますが、コードの文字列を渡して実行することはできません。

setTimeout() は、最初の引数として実行する関数と、 2番目の引数として数値として定義されたミリ秒の遅延を受け入れます。追加の引数も含めることができ、これらは関数に渡されます。これはその一例です:

function myFunc(arg) {
  console.log(`arg was => ${arg}`);
}

setTimeout(myFunc, 1500, 'funky');

上記の関数 myFunc() は、setTimeout() の呼び出しにより、可能な限り 1500 ミリ秒 (または 1.5 秒) くらいで実行されます。

設定されたタイムアウト間隔は、その正確なミリ秒数の後に実行することに依存することはできません。これは、イベントループをブロックまたは保留している他の実行コードがタイムアウトの実行を遅らせるためです。唯一保証されているのは、タイムアウトが宣言されたタイムアウト間隔より早く実行されないということです。

setTimeout() は、設定されたタイムアウトを参照するために使用できる Timeout オブジェクトを返します。この返されたオブジェクトを使用して、タイムアウトをキャンセル (下記の clearTimeout() を参照) し、実行動作を変更 (下記のunref() を参照) することができます。

"この直後に" 実行する ~ `setImmediate()`

setImmediate() は現在のイベントループサイクルの終わりにコードを実行します。このコードは、現在のイベントループ内の I/O 操作の後、および次のイベントループのためにスケジュールされたタイマーの前に実行されます。このコードの実行は「この直後」に行われると考えることができます。つまり、setImmediate() 関数呼び出しに続くコードは、 setImmediate()関数引数の前に実行されます。

setImmediate() の最初の引数は実行する関数になります。それ以降の引数は、実行時に関数に渡されます。これが例です:

console.log('before immediate');

setImmediate((arg) => {
  console.log(`executing immediate: ${arg}`);
}, 'so immediate');

console.log('after immediate');

setImmediate() に渡された上記の関数は、すべての実行可能コードが実行された後に実行され、コンソール出力は次のようになります:

before immediate
after immediate
executing immediate: so immediate

setImmediate() は Immediate オブジェクトを返します。これを使用して、スケジュールされた Immediate をキャンセル (下記の clearImmediate() を参照) できます。

注意: setImmediate() を process.nextTick() と混同しないでください。いくつかの大きな違いがあります。 1つ目は、process.nextTick() は、設定されている Immediate やスケジュールされている I/O の前に実行されるということです。 2つ目は、process.nextTick() は消去不可能であるということです。つまり、一度 process.nextTick() でコードを実行するようにスケジュールされると、通常の関数のように実行を停止することはできません。 process.nextTick() の操作をよく理解するためにこのガイドを参照してください。

"無限ループ" 実行 ~ `setInterval()`

複数回実行する必要があるコードブロックがある場合、 setInterval() を使用してそのコードを実行できます。 setInterval() は2番目の引数として指定されたミリ秒の遅れで無限回実行する関数の引数を取ります。 setTimeout() と同じように、遅延を超えて追加の引数を追加することができ、それらは関数呼び出しに渡されます。 setTimeout() と同様に、イベントループに耐えることができる操作のために遅延を保証することはできません。したがっておおよその遅延として扱われるべきです。以下の例を参照してください。

function intervalFunc() {
  console.log('Cant stop me now!');
}

setInterval(intervalFunc, 1500);

上の例では、intervalFunc() は停止されるまで約 1500 ミリ秒 (1.5秒) ごとに実行されます(下記参照)。

setTimeout() と同様に、 setInterval() もまた設定された間隔を参照したり修正したりするのに使用できる Timeout オブジェクトを返します。

未来をクリアする

Timeout または Immediate オブジェクトをキャンセルする必要がある場合はどうすればいいですか？ setTimeout()、setImmediate()、および setInterval() は、 set Timeoutまたは Immediate オブジェクトを参照するために使用できるタイマーオブジェクトを返します。前述のオブジェクトをそれぞれの clear 関数に渡すことによって、そのオブジェクトの実行は完全に停止されます。それぞれの関数は clearTimeout()、clearImmediate()、そして clearInterval() です。それぞれの例については、以下の例を参照してください:

const timeoutObj = setTimeout(() => {
  console.log('timeout beyond time');
}, 1500);

const immediateObj = setImmediate(() => {
  console.log('immediately executing immediate');
});

const intervalObj = setInterval(() => {
  console.log('interviewing the interval');
}, 500);

clearTimeout(timeoutObj);
clearImmediate(immediateObj);
clearInterval(intervalObj);

後ろにタイムアウトを残す

Timeout オブジェクトは setTimeout と setInterval によって返されることを忘れないでください。 Timeout オブジェクトは unref() と ref() で Timeout の振る舞いを増強することを目的とした2つの関数を提供します。 set 関数を使ってスケジュールされた Timeout オブジェクトがあれば、そのオブジェクトに対して unref() を呼び出すことができます。これはふるまいをわずかに変えます、そしてそれが実行する最後のコードであるなら Timeout オブジェクトを呼ばないでください。 Timeout オブジェクトはプロセスを実行し続け、実行するのを待ちません。

同様に、unref() が呼び出された Timeout オブジェクトは、同じ Timeout オブジェクトに対して ref() を呼び出すことでその振る舞いを取り除くことができ、それによってその実行が保証されます。ただし、パフォーマンス上の理由から、これによって初期の動作が正確に復元されるわけではないことに注意してください。両方の例については、以下を参照してください。

const timerObj = setTimeout(() => {
  console.log('will i run?');
});

// このままにしておくと、
// タイムアウトがプログラムの終了を妨げる唯一のものになるので、
// このステートメントで上記のタイムアウトを実行しないようにします。
timerObj.unref();

// immediate 内で ref() を呼び出すことでそれを元の状態に
// 戻すことができます。
setImmediate(() => {
  timerObj.ref();
});

イベントループのさらに下へ

このガイドでカバーしてきた以上にイベントループとタイマーにはもっとたくさんのものがあります。 Node.js イベントループの内部と、実行中のタイマーの動作の詳細については、この Node.js ガイド Node.js イベントループ、タイマー、および process.nextTick() を参照してください。