すべてのプロパティ

spring_boot_starter_scheduling は 3 つのプロパティを読みます。一つのスイッチと、シャットダウン時の待機のための 2 つです。スケジュール自体は @Scheduled に書き、そのテキストの属性は ${...} のプレースホルダーを通して自分の任意のプロパティを読めます。スターターのメタデータ (lib/spring_gen/spring_metadata.json) にも同じ 3 個のキーが列挙されています。

使う理由

ほとんどのテストではスケジューリングを無効にすべきですし、サーバーは停止する前に夜間のジョブを終わらせる必要があるかもしれません。これらは環境ごとの選択なので、プロパティです。

例

# lib/resources/application.yml
spring:
  task:
    scheduling:
      enabled: true
      shutdown:
        await-termination: true
        await-termination-period: 30s

# 独自のスケジュール。@Scheduled(fixedRateString: r'${reports.rate:5m}') が読む。
reports:
  rate: 10m
  cleanup-cron: 0 0 3 * * *

同じ内容を .properties で:

# lib/resources/application.properties
spring.task.scheduling.enabled=true
spring.task.scheduling.shutdown.await-termination=true
spring.task.scheduling.shutdown.await-termination-period=30s
reports.rate=10m
reports.cleanup-cron=0 0 3 * * *

プロパティ

キー 型 デフォルト 意味
spring.task.scheduling.enabled bool true false はスケジューリングを無効にする: TaskScheduler の Bean はなく、どの @Scheduled メソッドも実行されない (TaskExecutor は残る)。テストを予測可能に保つ。
spring.task.scheduling.isolates primary / all primary Web サーバーが isolate のプールを持つとき (server.isolates.count)、どの isolate が @Scheduled メソッドを実行するか: アプリケーションの最初の isolate だけ (ジョブは一度だけ実行される)、またはすべての isolate。→ @Scheduled
spring.task.scheduling.shutdown.await-termination bool false true: closeAsync() でコンテキストを閉じると、実行中のものを待つ。実行やその Future が中断されることは決してない。
spring.task.scheduling.shutdown.await-termination-period Duration なし: 上限なし そうした待機の最長時間 (30s)。その後、実行中のタスクを示す警告がログに出され、シャットダウンは続く。

読まれないもの

Spring Boot のキー 理由
spring.task.scheduling.pool.size すべてはスレッドプールなしで Dart のイベントループで実行される。
spring.task.scheduling.thread-name-prefix スレッドがない。
spring.task.execution.* TaskExecutor には設定するプールがない。spring.task.execution.isolates.* は、IsolateTaskExecutor のために spring_boot_dart が読む。

他のパッケージから読まれるもの

キー パッケージ 意味
spring.flutter.lifecycle.pause-in-background spring_boot_starter_flutter デフォルトは true: @Scheduled タスクはアプリがバックグラウンドにある間止まり、戻ったときに新たに始まる。
server.isolates.count spring_boot_starter_web 1 より大きいと、サーバーは isolate のプールを動かし、そのうちのどれがスケジュールするかを spring.task.scheduling.isolates が決める。
spring.task.execution.isolates.* spring_boot_dart 他の isolate で処理を実行する IsolateTaskExecutor のプール。タスクエグゼキューター を参照。

Spring (Java) との対応

spring.task.scheduling.shutdown.await-termination と await-termination-period は Spring Boot のものです。ここでは closeAsync() でだけ動きます。spring.task.scheduling.enabled は追加されたものです (Spring は @EnableScheduling でスケジューリングを切り替えます)。spring.task.scheduling.isolates に対応するものはありません。JVM のスレッドは一つのスケジューラーを共有するからです。

関連項目