ホットリロード
ホットリロードはメソッド本体をその場で差し替えますが、main を再実行しないため、動作中のコンテキストは生成時の Bean を持ち続けます。spring_boot_dart は生成されたコードのフィンガープリントを比較して判断します (フィンガープリントと reloadApplication は main.spring.debug.dart にあり、リリースビルドはこれをコンパイルしません)。メソッド本体だけが変わった場合はコンテキストを保持し、Bean、アノテーション、lib/resources/ が変わった場合は再起動します。Spring Boot DevTools の再起動に当たります。
使う理由
開発中はコードを絶えず変更します。変更したメソッド本体は、Bean の状態を保ったまますぐに反映されるべきです。新しい Bean、新しい @GetMapping、別の server.port には新しいコンテキストが必要ですが、そのためにプログラム全体を再起動するのは遅すぎます。フィンガープリントがこの 2 つの場合を区別します。
例
Flutter では、生成された reloadApplication を、ルートウィジェットの State の reassemble() から呼びます。Flutter はホットリロードのたびにこれを呼びます。
late ConfigurableApplicationContext context;
@SpringBootApplication()
Future<void> main() async {
context = await runApplicationAsync(const []);
runApp(const App());
}
class _AppState extends State<App> {
@override
void reassemble() {
super.reassemble();
context = reloadApplication(context, runners: false);
}
@override
Widget build(BuildContext context) => ...; // Bean は initState ではなくここで取得する
}
spring_boot_starter_flutter の SpringApplicationWidget は、これを代わりに行います。
リロードで起こること
| 変わったもの | 結果 |
|---|---|
| メソッド本体だけ (同じフィンガープリント) | コンテキストは保持される。Bean は状態を保ち、すでに新しいコードを実行する |
Bean、アノテーション、lib/resources/ (build_runner watch の実行中) |
コンテキストを閉じ、同じ引数とプロファイルで再び起動する |
フィールドに保持したオブジェクト (initState で一度だけ取得した Bean) は、再起動後も古いコンテキストを指したままです。Bean は build の中、または reassemble の後に取得してください。ホットリスタートは常に最初からやり直します。
再起動後のランナー
リロードがコンテキストを再起動すると、新規の起動と同じように始まるため、DevTools の再起動後と同じく、デフォルトではランナーが再び実行されます。起動時の処理を繰り返さずに Bean を再起動するには、runners: false を渡します。
runners: true (デフォルト) |
runners: false |
|
|---|---|---|
| 再起動後の Bean | 新しい | 新しい |
CommandLineRunner、ApplicationRunner |
再び実行される | スキップされる |
| 向いているもの | メモリ上の状態を準備するだけのランナー | マイグレーション、アナリティクスのイベント、通知、ネットワーク呼び出し |
メソッド本体だけが変わった場合は、フラグにかかわらずランナーは決して実行されません。runApplication と runApplicationAsync (本当の起動) は常にランナーを実行します。reloadApplicationAsync は設定ファイルを非同期に読みます。
サーバーとコマンドラインツール
Dart VM 上のプログラムもホットリロードできます。生成された runApplication はそのコンテキストを登録します。VM がコードをリロードした (ツールが reloadSources を呼んだ) 後、ツールは VM サービス拡張 ext.spring_boot.reload (SpringHotReload.extensionName) を呼びます。
- メソッド本体だけが変わった場合: コンテキストは新しいコードで動き続けます。
- 生成されたコードが変わった場合 (新しい
@GetMapping、別のserver.port): コンテキストを閉じて再び起動するため、Web サーバーは停止して再び待ち受けます。その起動が失敗すると、拡張はエラーを返し、次のリロードでアプリケーションが再び起動されます。
# ツールが行うことを手で:
dart run --enable-vm-service bin/main.dart
# 保存時: build_runner build を実行し、VM サービス経由で reloadSources と ext.spring_boot.reload を呼ぶ
Zed 拡張機能 Flutter tools の dart run タスクは、保存時にこれを行います。
| キー | 型 | デフォルト | 意味 |
|---|---|---|---|
spring.devtools.restart.enabled |
bool | true |
false は、何が変わってもコンテキスト (サーバー、その接続、Bean の状態) を動かし続ける。新しい Bean と設定はプログラムの再起動時に反映される |
ホットリロードはデバッグ実行でだけ動きます。AOT ビルドや product ビルド、Web では動きません。
リロードが isolate のプール を持つサーバーのコンテキストを再起動するとき、プールはコンテキストとともに停止し、新しいコンテキストが isolate を再び起動します。アプリケーションがどのように起動されたか (ApplicationLaunch) は、リロードをまたいで保持されます。
Spring (Java) との対応
Spring Boot DevTools は、クラスファイルが変わるとアプリケーションを再起動し、ランナーを再実行します。ここでは生成されたコードのフィンガープリントが判断するため、メソッド本体の変更では状態が保たれます。runners: false に対応するものは DevTools にはありません。