ホットリロード
ホットリロード (flutter run での r、IDE での保存) は、アプリを再び起動せずに、実行中のアプリに新しいコードを入れます。main は実行されず、メモリ上のオブジェクトはそのまま残ります。Bean にとってはこれが問題です。アプリケーションコンテキストは古い生成コードから組み立てられているため、新しい @Component は存在せず、変更されたものは古い依存関係を保ったままになります。
SpringApplicationWidget は、Spring Boot DevTools の restart と同じように、これに対処します。デフォルトで有効で、設定は不要です。
使う理由
これがなければ、Bean や設定ファイルを変更するたびにホットリスタート (R) が必要になり、ナビゲーション、スクロール位置、アプリのプロセスが失われます。これがあれば、メソッドの本体の変更はすべてを保ち、Bean やファイルの変更はコンテキストだけを再起動します。
判断の仕組み
Flutter は、ホットリロードのたびにルートのウィジェットの reassemble() を呼びます。そこでウィジェットは、生成コード (lib/spring_gen/main.spring.debug.dart。デバッグとプロファイルのビルドだけがコンパイルします) のフィンガープリントを、実行中のコンテキストの組み立てに使われたものと比較します。
メソッドの本体だけが変わった場合: コンテキストはそのまま残ります。 フィンガープリントが同じなので、何も再起動しません。Dart はすでに新しいメソッドの本体を実行し、Bean はその状態を保ちます。
@ChangeNotifierComponent()
class Counter {
int value = 0;
void increment() => value += 2; // 以前は `value++`: `r` の後、次のタップで
// 2 が加わり、それまでのカウントは保たれる
}
Bean、アノテーション、lib/resources/ が変わった場合: コンテキストは再起動します。 dart run build_runner watch を動かしていれば、保存の少し後にジェネレーターが main.spring.dart を書き直します。次のホットリロードは新しいフィンガープリントを見て、ウィジェットは:
- 実行中のコンテキストを閉じます (
@PreDestroyメソッドが実行され、ライフサイクルの Bean が止まり、ContextClosedEvent)。 - 新しい Bean と設定ファイルでアプリケーションを再び起動します。
ApplicationRunnerは、rerunRunnersOnReload: trueでない限り再び実行されません。アプリが本当に再起動したわけではないためです。 - その下のウィジェットを、その
Stateも含めて新たに組み立てます。そのため、閉じたコンテキストの Bean を保持し続けるウィジェットはありません。ナビゲーションとスクロール位置はホットリスタートの後と同じく最初からになりますが、アプリのプロセス (とコンテキストの外のもの) は残ります。
// アプリの実行中に追加。`build_runner watch` が再生成し、その後 `r`:
@Component()
class Clock {
DateTime now() => DateTime.now();
}
// そしてウィジェットの中で:
Text('${context.bean<Clock>().now()}'); // 見つかる: コンテキストが再起動した
# application.yml: コードは変わっていないが、新しい値で再起動する
shop:
page-size: 40
ホットリロードにできないこと
build_runner watchがなければ、生成コードは古いままです。ジェネレーターを実行して再びリロードするまで、新しい Bean は見つかりません。- Flutter 自体がホットリロードできない変更 (変更された
main、クラスに変えた enum など) には、mainからすべてを始めるホットリスタート (R) が必要です。 - コンテキストの再起動が失敗すると (例外を投げる Bean、不正なプロパティ)、失敗画面がエラーを表示します。コードを修正して再びリロードすれば、ウィジェットはアプリケーションを新たに起動します。
無効にする
コンテキストの再起動は、すべての Bean の状態を失わせます。ホットリロードのたびにコンテキストをそのまま保つには (そして Bean が変わったら R で手で再起動するには)、Spring Boot DevTools のスイッチを設定します。
spring:
devtools:
restart:
enabled: false
| キー | 型 | デフォルト | 意味 |
|---|---|---|---|
spring.devtools.restart.enabled |
bool | true |
生成コード (Bean、アノテーション、lib/resources/) が変わったとき、ホットリロードがコンテキストを再起動する。false はホットリスタートまでコンテキストと Bean の状態を保つ |
SpringApplicationWidget のパラメーター |
デフォルト | 意味 |
|---|---|---|
rerunRunnersOnReload |
false |
ホットリロードがコンテキストを再起動した後に、ApplicationRunner と CommandLineRunner の Bean を再び実行するかどうか |
リリースビルドとプロファイルビルドにはホットリロードがないため、そこではこのどれも起きません。
Spring (Java) との対応
Spring Boot DevTools は、クラスパスが変わると、二つのクラスローダーでアプリケーションを再起動します。ここでは生成コードのフィンガープリントがその役割を果たし、アプリではなくコンテキストだけが再起動します。