スケジューリング: setTimeout と setInterval

setTimeout

構文:

let timerId = setTimeout(func|code, delay[, arg1, arg2...])

パラメータ:

func|code

関数もしくは実行するコードの文字列。 通常は関数です。歴史的な理由で、コードの文字列も渡すことができますが、推奨されません。

delay

実行前の遅延時間で、ミリ秒単位です (1000 ms = 1 秒).

arg1, arg2…

関数の引数です(IE9-ではサポートされていません)

例えば、このコードは1秒後に sayHi() を呼びます:

function sayHi() {
  alert('Hello');
}

setTimeout(sayHi, 1000);

引数がある場合はこちら:

function sayHi(phrase, who) {
  alert( phrase + ', ' + who );
}

setTimeout(sayHi, 1000, "Hello", "John"); // Hello, John

もし最初の引数が文字列の場合、JavaScript はそれから関数を作ります。

従って、これも動作します:

setTimeout("alert('Hello')", 1000);

しかし、文字列を使うことは推奨されていません。次のように、それらの代わりに関数を使ってください。:

setTimeout(() => alert('Hello'), 1000);

// wrong!
setTimeout(sayHi(), 1000);

clearTimeout を使ったキャンセル

setTimeout の呼び出しは、実行を取り消すために使用できる “タイマー識別子” timerId を返します。

キャンセルするための構文は次の通りです:

let timerId = setTimeout(...);
clearTimeout(timerId);

下のコードでは、私たちは関数をスケジュールし、その後キャンセルしています。結果としては、何も起きません:

let timerId = setTimeout(() => alert("never happens"), 1000);
alert(timerId); // timer 識別子

clearTimeout(timerId);
alert(timerId); // 同じ 識別子 (キャンセル後 null にはなりません)

alert の出力から分かるように、ブラウザではタイマー識別子は数値です。他の環境では、それは他の何かの場合があります。例えば、Node.JS だと、追加メソッドを持つタイマーオブジェクトを返します。

改めて、それらのメソッドのための普遍的な仕様はありませんので問題ありません。

ブラウザの場合、タイマーはHTML5標準のtimers section で説明されています。

setInterval

メソッド setInterval は setTimeout と同じ構文を持っています:

let timerId = setInterval(func|code, delay[, arg1, arg2...])

すべての引数が同じ意味です。しかし setTimeout とは異なり、関数を1回ではなく定期的に与えられた時間間隔で実行します。

これ以上の呼び出しを止めるためには、clearInterval(timerId) を呼ぶ必要があります。

次の例は、2秒毎にメッセージを表示し、5秒後に表示は停止されます。:

// 2秒のインターバルで繰り返し
let timerId = setInterval(() => alert('tick'), 2000);

// 5秒後に停止
setTimeout(() => { clearInterval(timerId); alert('stop'); }, 5000);

再帰的な setTimeout

何かを定期的に実行するのに 2つの方法があります。

1つは、setInterval です。もう1つは、再帰的な setTimeout で、このようになります:

/** 次の代わり:
let timerId = setInterval(() => alert('tick'), 2000);
*/

let timerId = setTimeout(function tick() {
  alert('tick');
  timerId = setTimeout(tick, 2000); // (*)
}, 2000);

上の setTimeout は現在の実行の最後の (*) で次の呼び出しをスケジュールします。

再帰的な setTimeout は setInterval よりも柔軟です。この方法は、現在の呼び出しの結果に応じて、次の呼び出しのスケジュールが異なる場合があります。

例えば、5秒毎にデータを確認するためにサーバへリクエストを送るサービスを書く必要があるとします。しかし、サーバが高負荷である場合には、間隔を 10, 20, 40 秒… と言ったように増やす必用があります。

これは、その疑似コードです:

let delay = 5000;

let timerId = setTimeout(function request() {
  ...send request...

  if (request failed due to server overload) {
    // 次の実行のためにインターバルを増加させる
    delay *= 2;
  }

  timerId = setTimeout(request, delay);

}, delay);

また、もしも定期的にCPUを必要とするタスクを持っている場合には、実行にかかった時間を計測し次の呼び出しを計画することが出来ます。

再帰的な setTimeout は実行の間の遅延を保証しますが、setInterval は保証しません

2つのコードを比較してみましょう。最初の例は setInterval を使います。:

let i = 1;
setInterval(function() {
  func(i);
}, 100);

2つ目は再帰的な setTimeout を使います:

let i = 1;
setTimeout(function run() {
  func(i);
  setTimeout(run, 100);
}, 100);

setInterval では、内部スケジューラは100ms秒毎に func(i) を実行します。:

気づきましたか…？

setInterval での func 呼び出し間の実際の遅延はコード内のそれよりも短いです!

それは当然のことです、なぜなら func の実行にかかる時間はインターバルの一部を “消費” するためです。

func の実行が予想していたよりも長くなり、100ms を超える可能性があります。

このケースでは、エンジンは func の完了を待ちます。その後、スケジューラをチェックして時間が経過していた場合は すぐに それを再度実行します。

エッジケースですが、もし関数が常に delay ms よりも長く実行される場合、呼び出しは全く停止することなく起こります。

次に、これは再帰的な setTimeout の図です:

再帰的な setInterval は固定の遅延 (ここでは 100ms) を保証します。

新しい呼び出しは、以前の呼び出しの終わりに計画されるためです。

// 関数はスケジューラが呼び出すまでメモリ内に留まります
setTimeout(function() {...}, 100);

setTimeout(…,0)

特別なユースケースがあります: setTimeout(func, 0) です。

これは func をできるだけ速く実行するようスケジュールします。しかし、スケジューラは現在のコードが完了した後にそれを実行します。

なので、関数は現在のコードの “すぐ後” に実行するようスケジュールされています。言い換えると、非同期 です。

例えば、これは “Hello” を出力し、その後すぐに “World” を表示します。:

setTimeout(() => alert("World"), 0);

alert("Hello");

最初の行は “0ms 後のカレンダーに呼び出しを置いています”。しかし、スケジューラは現在のコードが完了した後に “カレンダーのチェック” をします。そのため、 "Hello" が最初で、"World" が後になります。

CPUを必要とするタスクの分割

setTimeout を使ってCPUを必要とするタスクを分割するトリックがあります。

たとえば、構文強調表示スクリプト（このページのコード例を色分けするために使用されます）はかなりCPUが重いです。 コードを強調表示するために、分析を実行し、多くの色の要素を作成し、文書に追加します。 ブラウザが “ハングアップ” することさえあり、それは容認できません。

そこで、私たちは長いテキストを小さく分割することができます。setTimeout(...,0) を使って、最初の100行、次の100行を計画する、と言ったように。

わかりやすくするために、より単純な例を考えてみましょう。 1 から 1000000000 まで数える関数があります。

それを実行する場合、CPUはハングアップするでしょう。サーバサイド JS だと容易に気付き、ブラウザで実行した場合にはページ上の他のボタンをクリックしようとしても – 実際にはJavaScript全体が一時停止しています。

let i = 0;

let start = Date.now();

function count() {

  // 重い処理を実行
  for (let j = 0; j < 1e9; j++) {
    i++;
  }

  alert("Done in " + (Date.now() - start) + 'ms');
}

count();

ブラウザは “スクリプトが時間がかかりすぎている” 警告を出す場合があります。

入れ子の setTimeout を使ってジョブを分割しましょう:

let i = 0;

let start = Date.now();

function count() {

  // 重い処理の一部を実行 (*)
  do {
    i++;
  } while (i % 1e6 != 0);

  if (i == 1e9) {
    alert("Done in " + (Date.now() - start) + 'ms');
  } else {
    setTimeout(count, 0); // 新しい呼び出しをスケジュール (**)
  }

}

count();

これで、ブラウザUIは “カウント” 処理中でも完全に機能します。

(*) でジョブの一部を行います:

1. 最初の実行: i=1...1000000.
2. ２回めの実行: i=1000001..2000000.
3. …が続き、while は i が 100000 で均等に分割されているかどうかをチェックします。

そして、まだ終わっていない場合には (**) で次の呼び出しがスケジュールされます。

count の実行間の休止は、JavaScriptエンジンが何か他のことをしたり、他のユーザアクションに反応するのに十分な “一息” を提供します。

注目すべき点は、両方のバリアントです: setTimeout によりジョブを分割してもしなくてもスピードは同等です。全体のカウント時間に大きな違いはありません。

それらをもっと近づけるために改善しましょう。

count() の先頭にスケジューリングを移動させます:

let i = 0;

let start = Date.now();

function count() {

  // 開始時にスケジューリングを移動する
  if (i < 1e9 - 1e6) {
    setTimeout(count, 0); // 新しい呼び出しをスケジュール
  }

  do {
    i++;
  } while (i % 1e6 != 0);

  if (i == 1e9) {
    alert("Done in " + (Date.now() - start) + 'ms');
  }

}

count();

これで、count() を開始して count() をもっと呼ぶ必要があると知ったとき – 私たちはジョブを実行する前に、すぐにそれをスケジュールします。

それを実行すると、時間が大幅に短縮されることに簡単に気づきます。

let start = Date.now();
let times = [];

setTimeout(function run() {
  times.push(Date.now() - start); // 前の呼び出しからの遅延を覚える

  if (start + 100 < Date.now()) alert(times); // 100ms 後に遅延を表示
  else setTimeout(run, 0); // もしくは再スケジュール
}, 0);

// 出力例:
// 1,1,1,1,9,15,20,24,30,35,40,45,50,55,59,64,70,75,80,85,90,95,100

ブラウザのレンダリングを許可する

ブラウザ内でのスクリプトの別の利点は、プログレスバー等をユーザに表示できることです。これは、ブラウザは通常スクリプトが完了した後に全ての “再ペイント” をするためです。

従って、私たちが1つの巨大な関数を実行し、そこで何かを変えたとしても、その変更は関数が終わるまでドキュメント上には反映されません。

これはそのデモです:

<div id="progress"></div>

<script>
  let i = 0;

  function count() {
    for (let j = 0; j < 1e6; j++) {
      i++;
      // 現在の i を <div> に表示
      // (innerHTML については別のチャプターで説明します)
      progress.innerHTML = i;
    }
  }

  count();
</script>

あなたがこれを実行した場合、 i の変更は count 全体が終わった後に行われます。

そして、setTimeout を使ってそれを小さく分割すると、変更は各実行の間で適用されます。なので、これは良く見えます:

<div id="progress"></div>

<script>
  let i = 0;

  function count() {

    // 重い処理の一部を実行 (*)
    do {
      i++;
      progress.innerHTML = i;
    } while (i % 1e3 != 0);

    if (i < 1e9) {
      setTimeout(count, 0);
    }

  }

  count();
</script>

これで、<div> は i の値の増加を表示します。

サマリ

• メソッド setInterval(func, delay, ...args) と setTimeout(func, delay, ...args) は、delay ミリ秒に func を定期的に/一度だけ実行することができます。
• 実行をキャンセルするためには、setInterval/setTimeout で返却された値と一緒に clearInterval/clearTimeout を呼ぶ必要があります。
• ネストされた setTimeout 呼び出しは、setInterval よりも柔軟です。また、それは実行 間 の最小時間を保証することができます。
• ゼロタイムアウトスケジューリング setTimeout(...,0) は “できるだけ早く、しかし現在のコードが終わった後に” 呼び出しをスケジュールするために使われます。

setTimeout(...,0) のいくつかのユースケースです:

• CPUを必要とするタスクを小さく分割するために、スクリプトが “ハングアップ” しないために。
• 処理が進行している間にブラウザに何か他のことをさせるために（プログレスバーを描画するなど）。

すべてのスケジューリングメソッドは正確な遅延を 保証しない ことに注意してください。スケジュールされたコードでは、それに頼るべきではありません。

例えば、ブラウザ内でのタイマーは、多くの理由で遅くなる可能性があります:

• CPUが過負荷になっている
• ブラウザタブがバックエンドモードになっている
• ラップトップがバッテリーモード

最小のタイマー精度(最小遅延)をブラウザや設定に応じて300msまたは1000msまで増やすことができます。