For AI agents: the complete documentation index is available at /Practical-Introduction-to-Spring-Boot/llms.txt, the full documentation bundle is available at /Practical-Introduction-to-Spring-Boot/llms-full.txt, and this page is available as Markdown at /Practical-Introduction-to-Spring-Boot/SpringBoot入門/定期実行入門.md.

Spring Boot 定期実行入門 — fixedRate と fixedDelay

講義の区切り

基本編の目安は 45 分です。終了条件は、@Scheduled を使って処理を繰り返し実行し、2 種類の設定でログの間隔がどう変わるか説明できることです。

概要

1 秒かかる模擬処理を、fixedRate と fixedDelay で順番に動かします。どちらも設定値は 3 秒です。 開始と終了のログを見て、どの時刻を基準に次の実行が決まるかを確かめます。

事前準備

Spring Initializr で Maven / Java / Jar を選び、新しいプロジェクトを作成します。 Spring Boot は 4.0 系、Java は 21 にします。Group は dev.mikoto2000.springboot、Artifact は scheduling、Package name は dev.mikoto2000.springboot.scheduling です。 依存関係は追加せず、生成した pom.xml に spring-boot-starter があることを確認してください。 この演習はアプリの起動だけで動作し、HTTP リクエストを送る手順はありません。

触って学ぶ定期実行

スケジュールを有効にする

以下の Java ファイルは src/main/java/dev/mikoto2000/springboot/scheduling の下に配置します。 生成された SchedulingApplication.java に @EnableScheduling を追加し、Spring が管理する Bean の @Scheduled を有効にします。

SchedulingApplication.java
package dev.mikoto2000.springboot.scheduling;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.scheduling.annotation.EnableScheduling;

@SpringBootApplication
@EnableScheduling
public class SchedulingApplication {

  public static void main(String[] args) {
    SpringApplication.run(SchedulingApplication.class, args);
  }
}

fixedRate で実行する

次の PeriodicTask.java を作成します。@Component を付けて Spring の Bean にし、引数のない run メソッドを定期実行します。 Thread.sleep(1000) は 1 秒かかる処理の代わりです。処理の前後に START と END を記録します。 @Scheduled の数値の単位は、既定ではミリ秒です。

PeriodicTask.java
package dev.mikoto2000.springboot.scheduling;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;

@Component
public class PeriodicTask {

  private static final Logger log = LoggerFactory.getLogger(PeriodicTask.class);

  @Scheduled(fixedRate = 3000)
  public void run() {
    log.info("START");
    try {
      Thread.sleep(1000);
    } catch (InterruptedException exception) {
      Thread.currentThread().interrupt();
      log.info("INTERRUPTED");
      return;
    }
    log.info("END");
  }
}

プロジェクトのルート(pom.xml と同じ場所)でアプリを起動します。PowerShell では .\mvnw.cmd spring-boot:run を使います。

./mvnw spring-boot:run

ログが 3 回分ほど出るまで待ちます。次の例では、Spring Boot のログから時刻とメッセージだけを抜き出しています。

12:00:00.000 START
12:00:01.000 END
12:00:03.000 START
12:00:04.000 END
12:00:06.000 START
12:00:07.000 END

隣り合う START は約 3 秒間隔です。END から次の START までは約 2 秒です。 このケースでは、処理にかかった約 1 秒も 3 秒の間隔に含まれています。

fixedDelay に変えて実行する

アプリを Ctrl+C で停止します。PeriodicTask.java のアノテーションを次の 1 行に置き換え、同じコマンドで起動します。

@Scheduled(fixedDelay = 3000)

処理時間は約 1 秒のままです。今度は END から次の START までの間隔に注目します。

12:01:00.000 START
12:01:01.000 END
12:01:04.000 START
12:01:05.000 END
12:01:08.000 START
12:01:09.000 END

END から次の START までは約 3 秒です。隣り合う START の間隔は、処理の約 1 秒を足して約 4 秒になります。 ログの時刻は例です。実測値は実行環境の負荷などで多少前後します。

設定開始 → 次の開始終了 → 次の開始
fixedRate = 3000約 3 秒約 2 秒
fixedDelay = 3000約 4 秒約 3 秒

後片付け

アプリを起動したターミナルで Ctrl+C を押して停止します。処理の途中で停止した場合は、最後の実行のログを時間の比較から外します。

座学で学ぶ実行間隔

どの時刻から間隔を測るか

fixedRate は予定された開始時刻を一定間隔で並べます。今回のように処理がその間隔より短い場合は、実際の開始時刻もほぼ一定の間隔になります。 fixedDelay は直前の実行が終わってから次の開始まで一定時間を空けます。処理が長引くと、その分だけ次の開始も遅くなります。

たとえば、一定の周期で状態を観測したい場合は fixedRate、処理を終えてから一定時間を空けて問い合わせたい場合は fixedDelay が候補になります。

発展として処理時間が間隔を超える場合を見る

Thread.sleep(1000) を Thread.sleep(4000) に変え、fixedRate = 3000 で起動してみます。 この演習の標準設定では、同じタスクの実行は重なりません。3 秒後の予定時刻を過ぎてから前の処理が終わるため、次の START は END の直後に出ます。 fixedDelay = 3000 に切り替えると、4 秒かかる処理が終わったあとにも約 3 秒空き、開始間隔は約 7 秒になります。

理解を確かめる

  1. 1 秒かかる処理で fixedRate = 3000 を指定した場合、END から次の START まではおおむね何秒か答える。
  2. 同じ処理で fixedDelay = 3000 を指定すると、開始間隔が約 4 秒になる理由を説明する。
  3. 前の問い合わせが終わったあとに必ず 3 秒空けたい場合、どちらを選ぶか説明する。

参考資料