
# spring_boot_starter_scheduling

`spring_boot_starter_scheduling` は、誰も呼ばない処理を実行します。Bean のメソッドに `@Scheduled` を付けると、アプリケーションが自分でそれを実行します。数分ごと、各実行の後に間隔を置いて、あるいは「平日の 9:00」のような cron の時刻にです。`TaskScheduler` の Bean は、実行時に決まる処理をスケジュールします。Spring の `@Scheduled` と `TaskScheduler` に当たる Dart のもので、サーバーでも Flutter アプリでも使えます。

## 使う理由

キャッシュの更新、サーバーとの同期、日次のダイジェストの送信、古いファイルの削除。このスターターがなければ、`Timer` を自分で開始し、保持し、そのエラーを処理し、シャットダウン時にキャンセルすることになります。スターターがあれば、メソッドにアノテーションを付けるだけです。タスクはアプリケーションの準備ができたら始まり、閉じるときに止まります。

## セットアップ

```yaml
# 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` を再エクスポートします。

## 例

```dart
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](scheduled.md): 固定レート、固定遅延、初期遅延、cron、プレースホルダー、長い実行。
- [cron 式](cron.md): 6 つのフィールド、特殊文字、マクロ、タイムゾーン、`CronExpression`。
- [TaskScheduler](task-scheduler.md): コードでのスケジューリング、トリガー、`ScheduledTask`。
- [@Async とエラー](async-and-errors.md): `TaskExecutor`、`@Async` のリスナー、`ErrorHandler`。
- [テストと時間](testing.md): スケジューリングの無効化、偽の時間、実時間の時計、ホットリロード。
- [すべてのプロパティ](properties.md): スターターのすべてのキー。
- [Spring との違い](differences.md): Spring と動作が異なる点。

## Spring (Java) との対応

```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 との違い](differences.md) にあります。

## 関連項目

- [イベント](../spring-core-dart/events/index.md)
- [@Async](../spring-core-dart/events/async.md)
- [spring_boot_starter_cache](../spring-boot-starter-cache/index.md)
- [ビルドに含まれるもの](optimizations.md)
