spring_boot_starter_scheduling
spring_boot_starter_scheduling は、誰も呼ばない処理を実行します。Bean のメソッドに @Scheduled を付けると、アプリケーションが自分でそれを実行します。数分ごと、各実行の後に間隔を置いて、あるいは「平日の 9:00」のような cron の時刻にです。TaskScheduler の Bean は、実行時に決まる処理をスケジュールします。Spring の @Scheduled と TaskScheduler に当たる Dart のもので、サーバーでも Flutter アプリでも使えます。
使う理由
キャッシュの更新、サーバーとの同期、日次のダイジェストの送信、古いファイルの削除。このスターターがなければ、Timer を自分で開始し、保持し、そのエラーを処理し、シャットダウン時にキャンセルすることになります。スターターがあれば、メソッドにアノテーションを付けるだけです。タスクはアプリケーションの準備ができたら始まり、閉じるときに止まります。
セットアップ
# pubspec.yaml
dependencies:
spring_boot_starter_scheduling: ^0.9.0
dev_dependencies:
build_runner: ^2.17.0
spring_core_dart_generator: ^0.9.0 # 必須: @Scheduled メソッドを呼べるようにする
@EnableScheduling はありません。スターターは自動的に見つかります。Dart にはリフレクションがないため、ジェネレーターが必要です。ジェネレーターが @Scheduled メソッドを見つけて呼ぶコードを書きます。インポートは一つです: package:spring_boot_starter_scheduling/spring_boot_starter_scheduling.dart。これは spring_boot_dart と spring_boot_starter_logging を再エクスポートします。
例
import 'package:spring_boot_starter_scheduling/spring_boot_starter_scheduling.dart';
import 'spring_gen/main.spring.dart';
@Component()
class Reports {
Reports(this.repository);
final ReportRepository repository;
// レポートのキャッシュを新しく保つ: 5 分ごとに実行が始まる。
@Scheduled(fixedRate: Duration(minutes: 5))
void refreshCache() => repository.refresh();
// 遅いサーバーと通信する: 30 秒の間隔は同期が終わってから始まる。
@Scheduled(fixedDelay: Duration(seconds: 30))
Future<void> syncWithServer() => repository.sync();
@Scheduled(cron: '0 0 9 * * MON-FRI') // 平日の 9:00
void morningDigest() => repository.sendDigest();
// reports.rate が別の値を指定しない限り、10 分ごと。
@Scheduled(fixedRateString: r'${reports.rate:10m}')
void recompute() => repository.recompute();
}
@SpringBootApplication()
void main(List<String> args) => runApplication(args);
起動するもの
taskSchedulerの Bean。TaskSchedulerを宣言しない限り、Dart のイベントループ上のTimerTaskSchedulerです。- シングルトンの Bean のすべての
@Scheduledメソッドは、コンテキストの準備ができるとスケジュールされ、閉じるときにキャンセルされます。誤った属性はClass.methodを示して起動を止めます。 applicationTaskExecutorの Bean (別名taskExecutor)。@EventListenerメソッドの@Asyncを有効にします。spring.task.scheduling.enabled=falseはスケジューリングを無効にします。TaskSchedulerの Bean もタスクもありません。
内容
- @Scheduled: 固定レート、固定遅延、初期遅延、cron、プレースホルダー、長い実行。
- cron 式: 6 つのフィールド、特殊文字、マクロ、タイムゾーン、
CronExpression。 - TaskScheduler: コードでのスケジューリング、トリガー、
ScheduledTask。 - @Async とエラー:
TaskExecutor、@Asyncのリスナー、ErrorHandler。 - テストと時間: スケジューリングの無効化、偽の時間、実時間の時計、ホットリロード。
- すべてのプロパティ: スターターのすべてのキー。
- Spring との違い: Spring と動作が異なる点。
Spring (Java) との対応
@EnableScheduling
@SpringBootApplication
class ReportsApplication {}
@Component
class Reports {
@Scheduled(fixedRate = 5, timeUnit = TimeUnit.MINUTES)
void refreshCache() { repository.refresh(); }
@Scheduled(cron = "0 0 9 * * MON-FRI")
void morningDigest() { repository.sendDigest(); }
}
重要な違い:
@EnableSchedulingはありません。- 期間は、数値と
timeUnitではなくDurationです。 - タイムゾーン: ローカル時刻か UTC だけです。
Futureを返すメソッドは、その実行が終わったとみなされる前に待たれます。- すべての違いは Spring との違い にあります。